服务协议
与 Websocket 协议区别
Mqtt 协议与 Websocket 协议区别，主要是请求格式中缺少 token 字段信息。
获取单个设备状态
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 获取单个设备状态 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 获取单个设备状态，此状态为服务器的缓存数据； 若需获取最新状态，需调用 1.4.4 的请求更新命令。 验证是否为最新状态，可通过时间戳来判断。 | ||||
| 请求说明 | ||||
| infotype | 固定为 damread | |||
| info | 固定字段 | |||
| unid | 为请求的设备的唯一 ID | |||
| 举例 Body 部分 | ||||
| { "infotype": "damread", "info": { "unid": "JY9220351854ALLR" } } | ||||
| 响应 JSON 数据格式 | ||||
| { "infotype": "damread", "info": { "name": "农业大棚(32A)1", "unid": "JY9220351854ALLR", "AI":Array[16], "AO": [], "DI": [ { "t": 1641279994271, "io": 0, "name": "DI1", "value": false, "alarm": false }, { "t": 1641279994271, "io": 1, "name": "DI2", "value": false, "alarm": false }, { "t": 1641279994271, "io": 15, "name": "DI16", "value": true, "alarm": false } ], "DO": [ { "t": 1641279994271, "io": 0, "name": "风机 1#", "value": true }, { "t": 1641279994271, "io": 1, "name": "风机 2#", "value": true }, { "t": 1641279994271, "io": 31, "name": "下卷膜 2#关", "value": false } ] } } | ||||
获取账号下所有设备状态
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 获取单个设备状态 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 获取所有设备状态 | ||||
| 请求说明 | ||||
| infotype | 固定为 damreadall | |||
| 举例 Body 部分 | ||||
| { "infotype": "damreadall", "info": "" } | ||||
| 响应 JSON 数据格式 | ||||
| { "infotype": "damreadall", "info": [ { "name": "农业大棚(32A)1", "unid": "JY9220351854ALLR", "AI": [ { "t": 1641280155749, "io": 0, "name": "空气温度", "unit": "℃", "value": 0, "alarm": false }, { "t": 1641280155749, "io": 1, "name": "空气湿度", "unit": "%", "value": 0, "alarm": false }, { "t": 1641280155749, "io": 2, "name": "土壤湿度", "unit": "%", "value": 0, "alarm": false }, { "t": 1641280155749, "io": 3, "name": "土壤温度", "unit": "℃", "value": 0, "alarm": false } ], "AO": [], "DI": [ { "t": 1641280174443, "io": 0, "name": "DI1", "value": false, "alarm": false }, { "t": 1641280174443, "io": 1, "name": "DI2", "value": false, "alarm": false }, { "t": 1641280174443, "io": 2, "name": "DI3", "value": false, "alarm": false } ], "DO": [ { "t": 1641280174443, "io": 0, "name": "风机 1#", "value": true }, { "t": 1641280174443, "io": 1, "name": "风机 2#", "value": true }, { "t": 1641280174443, "io": 2, "name": "卷被开", "value": true } ] } ] } | ||||
读取状态
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 读取状态 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 读取状态 支持 DO DI AI AO 的寄存器读取。 | ||||
| 请求说明 | ||||
| infotype | 固定为 damopr | |||
| info | 固定字段 | |||
| opr | 支持 rdo,rdi,rai,rao 操作 | |||
| unid | 为请求的设备的唯一 ID | |||
| regstart | 访问的寄存器起始地址，默认从 1 开始。 | |||
| regnum | 访问的寄存器数量，根据设备型号有关。 | |||
| rdo | 读取 DO 的状态 | |||
| rdi | 读取 DI 的状态 | |||
| rai | 读取 AI 的状态 | |||
| rao | 读取 AO 的状态 | |||
| 读取 DO 状态：举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "rdo", "unid": "JY9220351854ALLR", "regstart": 1, "regnum": 10 } } | ||||
| 读取 DO 状态：响应 JSON 数据格式 | ||||
| { "infotype": "damopr", "info": "手动操作:RDO [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 1, "regstart": -1, "regnum": 2, "vbyte": "AAA=", "strinfo": "0101020000B9FC", "RqDly": 0 } } | ||||
| 读取 DI 状态：举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "rdi", "unid": "JY9220351854ALLR", "regstart": 1, "regnum": 10 } } | ||||
| 读取 DI 状态：响应 JSON 数据格式 | ||||
| { "info": "手动操作:RDI [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 2, "regstart": -1, "regnum": 2, "vbyte": "AAA=", "strinfo": "0102020000B9B8", "RqDly": 0 } } | ||||
| 读取 AI 状态：举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "rai", "unid": "JY9220351854ALLR", "regstart": 1, "regnum": 10 } } | ||||
| 读取 AI 状态：响应 JSON 数据格式 | ||||
| { "infotype": "damopr", "info": "手动操作:RAI [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 4, "regstart": 0, "regnum": 10, "vbyte": "AAAAAAAAAAAAAAAAAAAAAAAAAAA=", "strinfo": "01041400000000000000000000000000000000000000009581", "RqDly": 0 } } | ||||
| 读取 AO 状态：举例 Body 部分 | ||||
| { "token": "API_001", "infotype": "damopr", "info": { "opr": "rao", "unid": "JY9220351854ALLR", "regstart": 1, "regnum": 10 } } | ||||
| 读取 AO 状态：响应 JSON 数据格式 | ||||
| { "infotype": "damopr", "info": "手动操作:RAO [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 3, "regstart": 0, "regnum": 10, "vbyte": "AAAAAAAAAAAACgAAAAAAAAAAAAA=", "strinfo": "0103140000000000000000000A0000000000000000000082BF", "RqDly": 0 } } | ||||
[继电器操作]关闭所有通道
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 关闭所有通道 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| [继电器操作]关闭所有通道。 控制继电器后，会主动推送设备的实时数据。 | ||||
| 请求说明 | ||||
| infotype | 固定为 damopr | |||
| info | 固定字段 | |||
| opr | 固定为 aclose | |||
| unid | 为请求的设备的唯一 ID | |||
| 举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "aclose", "unid": "JY9220351854ALLR" } } | ||||
| 响应 JSON 数据格式 | ||||
| { "infotype": "damopr", "info": "手动操作:ACLOSE [JY9220351854ALLR] 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 15, "regstart": 0, "regnum": 32, "vbyte": null, "strinfo": "010F000000205413", "RqDly": 0 } } | ||||
关闭某一通道
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 关闭某一通道继电器 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 关闭某一通道继电器。 控制继电器后，会主动推送设备的实时数据。 | ||||
| 请求说明 | ||||
| infotype | 固定为 damopr | |||
| info | 固定字段 | |||
| opr | 固定为 close | |||
| unid | 为请求的设备的唯一 ID | |||
| io | 控制的通道。 1 为第一个继电器通道 2 为第二个继电器通道 | |||
| 举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "close", "unid": "JY9220351854ALLR", "io": 1 } } | ||||
| 响应 JSON 数据格式 | ||||
| { "infotype": "damopr", "info": "手动操作:CLOSE [JY9220351854ALLR] 1 30000", "token": "" } | ||||
关闭一段时间后打开
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 关闭一段时间后打开 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 操作继电器，关闭一段时间后打开。 控制继电器后，会主动推送设备的实时数据。（需启用变化回传功能） | ||||
| 请求说明 | ||||
| infotype | 固定为 damopr | |||
| info | 固定字段 | |||
| opr | 固定为 closeone | |||
| unid | 为请求的设备的唯一 ID | |||
| io | 控制的通道。 1 为第一个继电器通道 2 为第二个继电器通道 | |||
| diy | 控制的延迟时间，单位为 0.1 秒； 数值范围：1-65000 | |||
| 举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "closeone", "unid": "JY9220351854ALLR", "io": 1, "dly": 10 } } | ||||
| 响应 JSON 数据格式 | ||||
| { "infotype": "damopr", "info": "手动操作:CLOSEONE [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 16, "regstart": 3, "regnum": 2, "vbyte": null, "strinfo": "011000030002B1C8", "RqDly": 0 } } | ||||
[继电器操作]打开所有通道
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 打开所有通道 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 操作继电器，打开所有通道。 控制继电器后，会主动推送设备的实时数据。 | ||||
| 请求说明 | ||||
| infotype | 固定为 damopr | |||
| info | 固定字段 | |||
| opr | 固定为 aopen | |||
| unid | 为请求的设备的唯一 ID | |||
| 举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "aopen", "unid": "JY9220351854ALLR", } } | ||||
| 响应 JSON 数据格式 | ||||
| { "info": "手动操作:AOPEN [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 15, "regstart": 0, "regnum": 32, "vbyte": null, "strinfo": "010F000000205413", "RqDly": 0 } } | ||||
[继电器操作]打开某一通道
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 打开某一通道 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 操作继电器，打开某一通道。 | ||||
| 请求说明 | ||||
| infotype | 固定为 damopr | |||
| info | 固定字段 | |||
| 举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "open", "unid": "JY9220351854ALLR", "io": 1, } } | ||||
| 响应 JSON 数据格式 | ||||
| { "infotype": "damopr", "info": "手动操作:OPENONE [JY9220351854ALLR] 1_10 30000", "token": "" } | ||||
[继电器操作]打开一段时间后关闭
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 打开一段时间后 关闭 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 操作继电器，打开一段时间后关闭。 控制继电器后，会主动推送设备的实时数据。（需启用变化回传功能） | ||||
| 请求说明 | ||||
| infotype | 固定为 damopr | |||
| info | 固定字段 | |||
| opr | 固定为 openone | |||
| unid | 为请求的设备的唯一 ID | |||
| io | 控制的通道。 1 为第一个继电器通道 2 为第二个继电器通道 | |||
| dly | 控制的延迟时间，单位为 0.1 秒； 数值范围：1-65000 | |||
| 举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "openone", "unid": "JY9220351854ALLR", "io": 1, "dly": 10 } } | ||||
| 响应 JSON 数据格式 | ||||
| { "infotype": "damopr", "info": "手动操作:OPENONE [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 16, "regstart": 3, "regnum": 2, "vbyte": null, "strinfo": "011000030002B1C8", "RqDly": 0 } } | ||||
[继电器操作]多通道操作
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 多通道操作 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 操作继电器，多通道操作。操作完毕之后，会主动推送数据。 | ||||
| 请求说明 | ||||
| infotype | 固定为 damopr | |||
| info | 固定字段 | |||
| opr | 固定为 wdo | |||
| unid | 为请求的设备的唯一 ID | |||
| regstart | 控制的起始通道。1 为从第一个继电器通道开始2 为从第二个继电器通道开始 | |||
| doinfo | 继电器的控制状态组，支持多个 数值含义： 0 代表关闭 1 代表打开 2 代表忽略操作 0211 代表第 1 路关闭 第 2 路忽略 第 3 路打开 第 4 路打开。 | |||
| 举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "wdo", "unid": "JY9220351854ALLR", "regstart": 1, "doinfo": [ 0, 2, 1, 1 ] } } | ||||
| 响应 JSON 数据格式 | ||||
| { "infotype": "damopr", "info": "手动操作:WDO [JY9220351854ALLR] 1_0211 30000", "token": "" } | ||||
[保持寄存器操作]写操作
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 写保持寄存器 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 写保持寄存器 | ||||
| 请求说明 | ||||
| infotype | 固定为 damopr | |||
| info | 固定字段 | |||
| opr | 固定为 wao | |||
| unid | 为请求的设备的唯一 ID | |||
| regstart | 控制的起始寄存器。 操作此类寄存器，需查看说明书的相关寄存器说明。 | |||
| aoinfos | 16 位的整形数组，代表写入的数据内容。 | |||
| 举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "wao", "unid": "JY9220351854ALLR", "regstart": 1, "aoinfo": [ 10, 1000 ] } } | ||||
| 响应 JSON 数据格式 | ||||
| { "infotype": "damopr", "info": "手动操作:WAO [JY9220351854ALLR] 1__10_1000 30000" } | ||||
[保持寄存器操作]写操作 Hex
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 写保持寄存器 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 以 HEX 格式写保持寄存器（暂保留） | ||||
| 请求说明 | ||||
| infotype | 固定为 damopr | |||
| info | 固定字段 | |||
| opr | 固定为 waohex | |||
| unid | 为请求的设备的唯一 ID | |||
| regstart | 控制的起始寄存器。 操作此类寄存器，需查看说明书的相关寄存器说明。 | |||
| aoinfos | 16 进制数据的字符串。 | |||
| 举例 Body 部分 | ||||
| { "infotype": "damopr", "info": { "opr": "waohex", "unid": "JY9220351854ALLR", "regstart": 1, "aoinfos": "000A03E8" } } | ||||
| 响应 JSON 数据格式 | ||||
| { "infotype": "damopr", "info": "手动操作:WAOHEX [JY9220351854ALLR] 1_000A03E8 30000" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 16, "regstart": 0, "regnum": 2, "vbyte": null, "strinfo": "01100000000241C8", "RqDly": 0 } } | ||||
[Lora 操作]读取通讯参数
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 关闭一段时间后打开 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 操作继电器，关闭一段时间后打开 | ||||
| 请求说明 | ||||
| 举例 Body 部分 | ||||
| 响应 JSON 数据格式 | ||||
[Lora 操作]读取工作参数
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 关闭一段时间后打开 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 操作继电器，关闭一段时间后打开 | ||||
| 请求说明 | ||||
| 举例 Body 部分 | ||||
| 响应 JSON 数据格式 | ||||
[Lora 操作]写入通讯参数
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 关闭一段时间后打开 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 操作继电器，关闭一段时间后打开 | ||||
| 请求说明 | ||||
| 举例 Body 部分 | ||||
| 响应 JSON 数据格式 | ||||
[Lora 操作]写入工作参数
| 名称 | 版本号 | 创建日期 | 最后更新 | 状态 |
|---|---|---|---|---|
| 关闭一段时间后打开 | 1.0 | 2021/12/30 | 2021/12/30 | 定义 |
| 描述 | ||||
| 操作继电器，关闭一段时间后打开 | ||||
| 请求说明 | ||||
| 举例 Body 部分 | ||||
| 响应 JSON 数据格式 | ||||
安卓版APP
IOS版APP