Appearance
字段参考
概述
本词汇表列出了 API v2 中重复出现的标识符和字段。在阅读端点规范时使用它,以保持集成中的命名一致。
组织
| 字段 | 描述 | 示例 |
|---|---|---|
slug | 用于 URL 和访问令牌的组织标识符。小写,每个租户唯一。 | yengear |
项目
| 字段 | 描述 | 示例 |
|---|---|---|
project_id | 项目的公共标识符。出现在 URL 中:/projects/{project_id}/...。 | proj_xxxx |
设备
| 字段 | 描述 | 示例 |
|---|---|---|
id | 设备的内部整数主键。在嵌套路由中用作 {device_pk}。 | 128 |
serial_number | 硬件标识符(IMEI、SN)。通过安全码绑定设备时使用。 | 868686000123456 |
agri_id (设备) | 设备创建时分配的平台生成的字符串 ID。数据点 ID 的前缀。 | d-1000-abcd |
数据点
| 字段 | 描述 | 示例 |
|---|---|---|
id | 数据点的内部整数主键。在嵌套路由中用作 {id}。 | 1 |
unit | Modbus 从站 ID(整数)。 | 1 |
address | 寄存器地址(整数)。 | 0 |
data_index | 读取多个寄存器时使用的偏移量。 | 0 |
modbus_type | 寄存器类型(holding、input、coil、discrete)。 | holding |
data_type | 寄存器值的编码(int16、uint32、float 等)。 | int16 |
data_endian | 字节顺序(ABCD、DCBA、BADC、CDAB)。 | ABCD |
data_scale | 缩放系数,最终值 = 原始值 × data_scale + data_delta。 | 0.1 |
data_delta | 缩放后应用的加法偏移。 | -10 |
the_type | 数据点类型 ID,通过 /points/options/ 端点解析。 | 1 |
the_type_detail | the_type 的扩展元数据(名称、单位、图标)。 | { "name": "Temperature", "unit": "℃" } |
agri_id (数据点) | 完整的数据点标识符 | d-1000-abcd-1-000 |
数据负载
| 字段 | 描述 | 示例 |
|---|---|---|
t | UTC 时间戳(秒)。 | 1708070400 |
value / v | 数据点的数值读数。某些端点使用 value,其他使用 v。 | 25.6 |
project_id | 注入到 POST /devices/{device_pk}/data/ 响应中以显示源项目。 | proj_xxxx |
org_slug | 注入到 POST /devices/{device_pk}/data/ 响应中以显示所属组织。 | yengear |
