1、范围
本文为脉恩空调系统协议规范
2、心跳路由客户端和心跳服务器
2.1、简要
心跳路由客户端与心跳服务器之间新增两条指令，分别为report与issue。report为设备上报数据到心跳服务器，issue为心跳服务器下发数据到心跳路由客户端。
2.2、报文概述
REPORT指令（设备侧上报数据）
1.请求指令
vendor 4字节
options TLV格式
data 不固定
2.响应指令
SN 2字节，请求指令序列号
ISSUE 指令 （业务服务器请求设备侧）
1.请求指令
vendor 4字节
options TLV格式
data 不固定
2.响应指令 与通知消息格式一致、消息类型不一致
SN 2字节，请求指令序列号
reponseCode 2字节
2.3、report与issue报文格式
+-----+----------+-----------+---------+-----+-----+--------+---------+----------+
| flag | pktlen | version | pktTye | sn | Ext | vendor | option | data |
+-----+----------+-----------+---------+-----+-----+--------+---------+----------+
| <--------------- 包头消息 ------------------------>|<-- 消息字段 -->|
pktTye：消息字段类型，新增两条消息在此基础上扩展，分别为report与issue.
pktlen : 消息长度，从vendor头开始到data尾部整个长度。
option : 建议保留，上报和下发将来一定是经常用到消息，可用作为消息字段的扩展。
2.4、report回应报文格式
+------+--------+---------+--------+----+-----+---------------+
| flag | pktlen | version | pktTye | sn | Ext | sn |
+------+--------+---------+--------+----+-----+---------------+
| <--------------- 包头消息 --------------->|<-- 消息字段 -->|
2.5、issue回应报文格式
+------+--------+---------+--------+----+-----+-------------------+
| flag | pktlen | version | pktTye | sn | Ext | sn | reponseCode |
+------+--------+---------+--------+----+-----+-------------------+
| <--------------- 包头消息 --------------->|<---- 消息字段 ---->|
2.6、实现建议：
- report（issue）、datalen、vendor、option属于心跳协议的一部分，由心跳服务器与客户端来负责解析。
- data段由厂商定义格式，可选择是否加密，心跳服务器与客户端对此段进行透明传输。
- CPE侧，通过分析vendor字段，可将data数据会分发到MYE程序，由MYE程序进行解析。
- 后台，心跳服务器将data数据放入消息队列后，由专门程序取出，分析出vendor字段并投递到相应程序中进行处理。
3、MYE、TR069客户端、心跳路由客户端之间IPC通信
3.1、简要
这三者之间的ipc通信，通过使用UDP协议，json数据格式，restful风格，方便测试、阅读、开发与维护。
3.2、心跳路由客户端与MYE
MYE上传业务数据
- MYE将传感器采集的数据封装成med格式，通过心跳路由客户端透传到后台算法服务器。value表示一个数组，可上传多条med指令。
- 上传数据无需返回值
{
"cmd_url":"/heartbeatclient/business",
"cmd_name":"report",
"value": [{
"med" : "xxxx"
}]
}
发送指令到MYE
- 后台算法服务器将med控制指令，通过心跳客户客户端透传到MYE。value表示一个数组，可上传多条med指令。
- 下发指令无需返回值
{
"cmd_url":"/heartbeatclient/business",
"cmd_name":"issue",
"value": [{
"med" : "xxxx"
}]
}
3.3、TR069客户端与MYE
获取zigbee模块信息
- 查询zigbee模块信息，上报ACS。
- 外部程序向MYE发出请求
{"cmd_url":"/zigbeeservice/module", "cmd_name":"query"}
- MYE返回模块信息表，result返回结果，0表示成功，失败为其他值。若成功，value为模块信息表内容。
{
"cmd_url": "/zigbeeservice/module",
"cmd_name": "query",
"result": 0,
"value": {
"MACAddress": “xxxx”,
"NetworkPANID": “xxx”,
"Channels": x,
"numberofchildlimit": xx,
}
}
获取zigbee设备信息
- 查询zigbee设备信息，上报ACS。
- 外部程序向MYE发出请求
{"cmd_url":"/zigbeeservice/device", "cmd_name":"query", "node_mac":"xxx"}
- MYE返回zigbee设备信息，result返回结果，0表示成功，失败为其他值。若成功，value为设备信息表内容。
{
"cmd_url": "/zigbeeservice/device",
"cmd_name": "query",
"result": 0,
"value": {
"xxxx" : “xxxx”,
"xxxx": “xxx”,
"xxxx": x,
"xxxx": xx,
}
}
获取zigbee配置表
- 获取zigbee设备配置，上传ACS。
- 外部程序向MYE发出请求
{"cmd_url":"/zigbeeservice/device", "cmd_name":"getconf", "node_mac":"xxx"}
- MYE返回zigbee设备配置信息，result返回结果，0表示成功，失败为其他值。若成功，value为设备配置表内容。
{
"cmd_url": "/zigbeeservice/device",
"cmd_name": "getconf",
"result": 0,
"value": {
"xxxx" : “xxxx”,
"xxxx": “xxx”,
"xxxx": x,
"xxxx": xx,
}
}
下发zigbee配置表
- 设置zigbee设备配置。
- 外部程序向MYE发出请求，配置zigbee设备。
{
"cmd_url":"/zigbeeservice/device",
"cmd_name":"setconf",
"node_mac":"xxx",
"value": {
"xxxx" : “xxxx”,
"xxxx": “xxx”,
"xxxx": x,
"xxxx": xx,
}
}
- MYE返回zigbee设备配置信息，result返回结果，0表示成功，失败为其他值。
{
"cmd_url": "/zigbeeservice/device",
"cmd_name": "setconf",
"result": 0,
}
配置上报（当前需求待定）
- zigbee设备配置发生变化，主动上报。
- MYE发出请求，上报改变配置
{
"cmd_url":"/tr069client/device",
"cmd_name":"updateconf",
"value": {
"xxxx" : “xxxx”,
"xxxx": “xxx”,
"xxxx": x,
"xxxx": xx,
}
}
- MYE返回zigbee设备配置信息，result返回结果，0表示成功，失败为其他值。
{
"cmd_url": "/tr069client/device",
"cmd_name": "updateconf",
"result": 0,
}
获取当前完整拓扑信息表
- 获取当前zigbee网络完整topo信息，上传ACS。
- 外部程序向MYE发出请求
{"cmd_url":"/zigbeeservice/topo", "cmd_name":"enum"}
- MYE返回zigbee设备配置信息，result返回结果，0表示成功，失败为其他值。若成功，value表示数组，为当前所有zigbee设备拓扑信息表集合。
{
"cmd_url": "/zigbeeservice/topo",
"cmd_name": "enum",
"result": 0,
"value": [{
"xxxx" : "xxxx",
"xxxx": "xxx",
"xxxx": "xxx",
"xxxx": "xxx",
}]
}
更新节点
- 当zigbee网络中，某设备发生拓扑改变，主动上报tr069客户端。
- MYE发出请求，value表示数组，为所有改变拓扑信息集合。
{
"cmd_url": "/tr069client/topo",
"cmd_name": "update",
"value": [{
"xxxx" : "xxxx",
"xxxx": "xxx",
"xxxx": "xxx",
"xxxx": "xxx",
}]
}
- tr069客户端返回结果，result返回0表示成功，失败为其他值。
{
"cmd_url": "/tr069client/topo",
"cmd_name": "update",
"result": 0,
}
添加节点
- 当zigbee网络中，添加了设备，发生拓扑改变，主动上报tr069客户端。
- MYE发出请求，value表示数组，为所有改变拓扑信息集合。
{
"cmd_url": "/tr069client/topo",
"cmd_name": "add",
"value": [{
"xxxx" : "xxxx",
"xxxx": "xxx",
"xxxx": "xxx",
"xxxx": "xxx",
}]
}
- tr069客户端返回结果，result返回0表示成功，失败为其他值。
{
"cmd_url": "/tr069client/topo",
"cmd_name": "add",
"result": 0,
}
删除节点
- 当zigbee网络中，移除了设备，发生拓扑改变，主动上报tr069客户端。
- MYE发出请求，value表示数组，为所有改变拓扑信息集合。
{
"cmd_url": "/tr069client/topo",
"cmd_name": "delete",
"value": [{
"xxxx" : "xxxx",
"xxxx": "xxx",
"xxxx": "xxx",
"xxxx": "xxx",
}]
}
- tr069客户端返回结果，result返回0表示成功，失败为其他值。
{
"cmd_url": "/tr069client/topo",
"cmd_name": "delete",
"result": 0,
}
升级zigbee模块
- 升级zigbee模块。
- 外部程序向MYE发出请求。
{
"cmd_url":"/zigbeeservice/module",
"cmd_name":"upgrade",
"url":"xxx"，
"md5":"xxx"，
}
升级zigbee设备
- 升级zigbee设备。
- 外部程序向MYE发出请求。
{
"cmd_url":"/zigbeeservice/device",
"cmd_name":"upgrade",
"node_mac":"xxx",
"url":"xxx"，
"md5":"xxx"，
}
- MYE返回结果，result返回0表示成功，失败为其他值。
{
"cmd_url":"/zigbeeservice/device",
"cmd_name":"upgrade",
"node_mac":"xxx",
"result":0,
}
