中台协议

Topic

Topic基本格式为： {业务场景}/{数据流向}/{productKey}/{sn}

功能	topic	method	说明
设备投影	上行： `data/up/{productKey}/{sn}` 下行： `data/down/{productKey}/{sn}`	report	实时状态上报-新版
		update	实时状态上报-旧版
		delete	删除设备投影（或其中某个属性）
		control	下发投影（或其中某个属性）到设备
		get	设备主动请求投影（或其中某个属性）
通用功能	上行： `sys/dev/{productKey}/{sn}` 下行： `sys/server/{productKey}/{sn}`	login	设备登录
		time	对时，时间戳精确到秒
		time.ms	对时，时间戳精确到毫秒
		ota	推送OTA升级指令到设备
		ota_apply	设备主动请求OTA升级
		ota_info	查询设备的OTA信息
		restart	重启设备
		topology	设备上报拓扑结构
操作指令	上行： `indicate/dev/{productKey}/{sn}` 下行： `indicate/server/{productKey}/{sn}`	operate	下发指令操作
事件报警	上行： `notify/dev/{productKey}/{sn}` 下行： `notify/server/{productKey}/{sn}`	event	设备上传事件到中台-新版
		notice	设备上传事件到中台-旧版
		alert	网关上传报警信息-新版
		alarm	网关上传子设备报警，或设备的业务子模块报警-旧版
		gwalarm	网关自身报警，或设备的网关层报警-旧版
		alarm_reset	重置子设备报警状态
		gwalarm_reset	重置网关报警状态
离线消息	上行： `will/{productKey}/{sn}`	will	设备离线时发送消息到中台
秒级监控	上行： `monitor/dev/{productKey}/{sn}`	无	秒级设备状态
M2M通讯	上行： `raw/dev/{productKey}/{sn}` 下行： `raw/server/{productKey}/{sn}`	raw	M2M通讯

消息格式

所有消息均遵循以下格式：

{
    "msgid": 628131887239491584,
    "method": "report",
    "sn": "1234567890123",
    "timestamp": 1638869890
}

属性说明

参数	说明
msgid	必填，消息id。中台为了避免id的重复，生成18位的long型雪花id。设备端生成的id可以是数值型或字符串，只要保证设备内部的id不重复即可。
method	必填，标准协议中定义的method，表示具体的业务场景。
sn	必填，设备SN编号。
timestamp	必填，消息生成时间戳，精确到秒。

响应消息遵循如下格式：

{
    "msgid": 628131887239491584,
    "method": "update",
    "sn": "1234567890123",
    "res": 1,
    "errcode": "400",
    "timestamp": 1638869890
}

属性说明

参数	说明
msgid	必填，必须与发起该流程的消息msgid保持一致
method	必填，必须与发起该流程的消息method保持一致
res	必填，响应类消息的状态，1表示成功，0表示失败
errcode	错误编码，成功和失败时都可能有errcode，具体参见错误码

命名与结构规范

主要指的是，当需要基于中台标准协议设计一个新设备的协议时，应当尽可能遵循标准化的电参量、报警编码命名规范，并且使传输业务信息的报文结构保持统一风格。

Last modified: 18 四月 2025