服务协议

获取单个设备状态

名称	版本号	创建日期	最后更新	状态
获取单个设备状态	1 .0	2021/12/30	2021/12/30	定 义
描述
获取单个设备状态，此状态为服务器的缓存数据； 若需获取最新状态，需调用 1.4.3 的请求更新命令。 验证是否为最新状态，可通过时间戳来判断。
请求说明
请求地址	https://{host}/api/v1/equip-read/equip-state?unid={unid}
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
响应报文参数描述
名称	类型	长度	约束	描述
id	string		M	设备分配的唯一 ID
name	string		M	设备名称。
unid	string		M	设备的硬件唯一 ID
userid	string		M	设备的归属账号 ID
ai	Json		M	设备的传感器信息
ao	Json		M	设备的保持寄存器信息
do	Json		M	设备的继电器状态
di	Json		M	设备的开关量输入状态信息
响应 JSON 数据格式
AI 描述
模拟量参数描述
名称	类型	长度	约束	描述
io	int		M	io 从 0 开始 为第一个通道
name	string		M	通道名称
unit	string		M	物理量单位,比如℃
value	double		M	传感器数值
alarm	bool		M	是否发生报警 true:已发生报警
fAlarmH	double		M	报警上限设定值
fAlarmL	double		M	报警下限设定值
fX1	double		O	线性关系式,{x1,y1}{x2,y2}
fY1	double		O
fX2	double		O
fY2	double		O
t	long		M	更新时间戳,单位为毫秒
AO 描述
保持寄存器参数描述
名称	类型	长度	约束	描述
io	int		M	io 从 0 开始 为第一个通道
name	string		M	通道名称
unit	string		M	物理量单位,比如频率 hz
value	double		M	输出的传感器数值
min	double		M	输出数值的最小值
max	double		M	输出数值的最大值
t	long		M	更新时间戳,单位为毫秒
DO 描述
保持寄存器参数描述
名称	类型	长度	约束	描述
io	int		M	io 从 0 开始 为第一个通道
name	string		M	通道名称
value	bool		M	继电器状态：false:释放状态,true:吸合状态
t	long		M	更新时间戳,单位为毫秒
DI 描述
保持寄存器参数描述
名称	类型	长度	约束	描述
io	int		M	io 从 0 开始 为第一个通道
name	string		M	通道名称
value	bool		M	False:断开 true:导通
alarm	bool		M	true:已经报警
t	long		M	更新时间戳,单位为毫秒

获取账号下所有设备状态

名称	版本号	创建日期	最后更新	状态
获取单个设备状态	1 .0	2021/12/30	2021/12/30	定 义
描述
获取用户的所有设备状态
请求说明
请求地址	https://{host}/api/v1/equip-read/all-equip-state
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
响应报文参数描述
名称	类型	长度	约束	描述
data	Json		M	多个传感器信息列表 信息状态参考 1.4.1
响应 JSON 数据格式

读取状态

名称	版本号	创建日期	最后更新	状态
读取状态	1 .0	2021/12/30	2021/12/30	定 义
描述
触发服务器读取设备的实时状态， 如需获取最新状态，需要在调用此命令后，间隔 1 秒，在通过 1.4.1 命令进行获取设备状态。
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-read
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
body 部分
名称	类型	长度	约束	描述
unid	string		M	设备的唯一 ID
io	bool		M	关闭设备的端口 1 为第一路继电器
dly	int		M	关闭的延迟时间 单位为 0.1 秒，最大为 65535，有绝对精度误差
响应报文参数描述
读取 AI 状态：Body 部分
读取 AI 状态：响应 JSON 数据格式
读取 AO 状态：举例 Body 部分
读取 AO 状态：响应 JSON 数据格式
读取 DO 状态：举例 Body 部分
读取 DO 状态：响应 JSON 数据格式
读取 DI 状态：举例 Body 部分
读取 DI 状态：响应 JSON 数据格式

[Post][继电器操作]关闭所有通道

名称	版本号	创建日期	最后更新	状态
关闭所有通道	1 .0	2021/12/30	2021/12/30	定 义
描述
[继电器操作]关闭所有通道
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-close-all
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
body 部分
名称	类型	长度	约束	描述
unid	string		M	unid
响应报文参数描述
ACLOSE	操作描述
举例 Body 部分
响应JSON数据格式

[Post][继电器操作]关闭某一通道

名称	版本号	创建日期	最后更新	状态
关闭某一通道继电器	1 .0	2021/12/30	2021/12/30	定 义
描述
关闭某一通道继电器
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-close
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
body 部分
名称	类型	长度	约束	描述
unid	string		M	设备的唯一 ID
io	bool		M	关闭设备的端口 1 为第一路继电器
响应报文参数描述
CLOSE	操作描述
举例 Body 部分
响应JSON数据格式

[Post][继电器操作]关闭一段时间后打开

名称	版本号	创建日期	最后更新	状态
关闭一段时间后打开	1 .0	2021/12/30	2021/12/30	定 义
描述
操作继电器，关闭一段时间后打开
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-close-one
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
body 部分
名称	类型	长度	约束	描述
unid	string		M	设备的唯一 ID
io	bool		M	关闭设备的端口 1 为第一路继电器
dly	int		M	关闭的延迟时间 单位为 0.1 秒，最大为 65535，有绝对精度误差
响应报文参数描述
举例 Body 部分
响应JSON数据格式

[Post][继电器操作]打开所有通道

名称	版本号	创建日期	最后更新	状态
打开所有通道	1 .0	2021/12/30	2021/12/30	定 义
描述
操作继电器，打开所有通道
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-open-all
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
body 部分
名称	类型	长度	约束	描述
unid	string		M	设备的唯一 ID
响应报文参数描述
举例 Body 部分
响应JSON数据格式

[Post][继电器操作]打开某一通道

名称	版本号	创建日期	最后更新	状态
打开某一通道	1 .0	2021/12/30	2021/12/30	定 义
描述
操作继电器，打开某一通道
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-open
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
body 部分
名称	类型	长度	约束	描述
unid	string		M	设备的唯一 ID
io	int		M	关闭设备的端口 1 为第一路继电器
响应报文参数描述
举例 Body 部分
响应JSON数据格式

[Post][继电器操作]打开一段时间后关闭

名称	版本号	创建日期	最后更新	状态
打开一段时间后关闭	1 .0	2021/12/30	2021/12/30	定 义
描述
操作继电器，打开一段时间后关闭
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-open-one
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
body 部分
名称	类型	长度	约束	描述
unid	string		M	设备的唯一 ID
io	bool		M	关闭设备的端口 1 代表第一路继电器
dly	Int		M	打开的延迟时间 单位为 0.1 秒，最大为 65535，有绝对精度误差。
响应报文参数描述
举例 Body 部分
响应JSON数据格式

[Post][继电器操作]多通道操作

名称	版本号	创建日期	最后更新	状态
多通道操作	1 .0	2021/12/30	2021/12/30	定 义
描述
操作继电器，多通道操作
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-write-do
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
body 部分
名称	类型	长度	约束	描述
unid	string		M	设备的唯一 ID
regstart	bool		M	寄存器的起始地址 0 无效 1 代表第一路继电器
doinfo	Int		M	继电器的控制状态组，支持多个数值含义：0 代表关闭 1 代表打开 2 代表忽略操作
响应报文参数描述
举例 Body 部分
响应JSON数据格式

[Post][保持寄存器操作]写操作

名称	版本号	创建日期	最后更新	状态
写保持寄存器	1 .0	2021/12/30	2021/12/30	定 义
描述
写保持寄存器
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-write-ao
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
body 部分
名称	类型	长度	约束	描述
unid	string		M	设备的唯一 ID
regstart	Int		M	寄存器的起始地址 0 无效 1 代表 modbus 寄存器的 0
aoinfos	Int Array		M	寄存器的内容 16 位无符号类型
响应报文参数描述
举例 Body 部分
响应JSON数据格式

[Post][保持寄存器操作]写操作 Hex

名称	版本号	创建日期	最后更新	状态
写保持寄存器	1 .0	2021/12/30	2021/12/30	定 义
描述
以 HEX 格式写保持寄存器
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-write-ao-hex
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
body 部分
名称	类型	长度	约束	描述
unid	string		M	设备的唯一 ID
regstart	Int32		M	寄存器的起始地址 0 无效 1 代表 modbus 寄存器的 0
aoinfos	string		M	寄存器的内容 16 进制格式的字符串 比如1234ABCD
响应报文参数描述
举例 Body 部分
响应JSON数据格式

[Post][Lora 操作]读取通讯参数

名称	版本号	创建日期	最后更新	状态
关闭一段时间后打开	1 .0	2021/12/30	2021/12/30	定 义
描述
操作继电器，关闭一段时间后打开
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-read-lora-param
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
举例 Body 部分
响应JSON数据格式

[Post][Lora 操作]读取工作参数

名称	版本号	创建日期	最后更新	状态
关闭一段时间后打开	1 .0	2021/12/30	2021/12/30	定 义
描述
操作继电器，关闭一段时间后打开
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-read-lora-config
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
举例 Body 部分
响应JSON数据格式

[Post][Lora 操作]写入通讯参数

名称	版本号	创建日期	最后更新	状态
关闭一段时间后打开	1 .0	2021/12/30	2021/12/30	定 义
描述
操作继电器，关闭一段时间后打开
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-write-lora-param
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
举例 Body 部分
响应JSON数据格式

[Post][Lora 操作]写入工作参数

名称	版本号	创建日期	最后更新	状态
关闭一段时间后打开	1 .0	2021/12/30	2021/12/30	定 义
描述
操作继电器，关闭一段时间后打开
请求说明
请求地址	https://{host}/api/v1/equip-opr/equip-write-lora-config
Head 部分
名称	类型	长度	约束	描述
Authorization	string		M	参考 1.2 身份认证
举例 Body 部分
响应JSON数据格式