注意事项

警告

文档示例所有的JSON内容都是进了格式化的，为了美观，方便阅读。
JSON内容都是纯文本字符串，并且不能有转义字符，如：\t\r\n等等。

比如【注册】的payload，应该是这样子：

{"name":"Namron-Gateway","ty":2,"categ": "GateWay","prot":"3","mod_ver":"1.2.34","mcu_ver":"1.0.0","sn":"xxxx-xxxx-xxxx","mfr":"HZC","model":"Gateway","attrs":[{"id":"Onoff","acc":2,"dty":7,"val":0},{"id":"Level","acc":2,"dty":7,"val":50,"min":0,"max":100}]}

而不是：

{
  "name": "Namron-Gateway",
  "ty": 2,
  "prot": "3",
  "categ": "GateWay",
  "mod_ver": "1.2.34",
  "mcu_ver": "1.0.0",
  "sn": "xxxx-xxxx-xxxx",
  "mfr": "HZC",
  "model": "Gateway",
  "attrs": [
    {
      "id": "Onoff",
      "acc": 2,
      "dty": 7,
      "val": 0
    },
    {
      "id": "Level",
      "acc": 2,
      "dty": 7,
      "val": 50,
      "min": 0,
      "max": 100
    }
  ]
}

名词解释

信息

Y：指的是Yes，必填项。
O：指的是Option，可选项。
{device_id}：指的是设备ID，即设备证书的CN值，32位的UUID字符串。
{mid}：指的是主设备ID，即网关ID{mac}：指的是网关设备下的子设备MAC地址。
{sid}：指的是网关设备下的子设备ID，通常是MAC地址+端点。比如：14B457FFFECFFCEA_01

上行主题（设备➡️平台）

同步

时间同步

Topic：{device_id}/time/sync
发送空字符payload给平台即可

数据同步

子设备数据同步

Topic：{device_id}/data_sync/sub_device

{
  "flag": 1,
  "completed": false,
  "data": [
    {
      "name": "abcdefg",
      "categ": "0101",
      "sid": "203e_00",
      "mac": "1a6b8f8f3938",
      "mod_ver": "0005",
      "prot": "1,5",
      "mfr": "HZC",
      "model": "00809-B",
      "attrs": "[{\"id\":\"Onoff\",\"acc\":2,\"dty\":7,\"val\":0},{\"id\":\"Level\",\"acc\":2,\"dty\":7,\"val\":50,\"min\":0,\"max\":100}]"
    }
  ]
}

参数名称	参数类型	是否必填	参数说明
`flag`	`uint`	`Y`	标志位；
`completed`	`bool`	`Y`	所有数据是否已发送完毕；

data

参数名称	参数类型	是否必传	参数说明
`name`	`string`	`Y`	设备名称；
`categ`	`string`	`O`	品类；
`sid`	`string`	`Y`	子设备 ID
`mac`	`string`	`Y`	MAC 地址
`mod_ver`	`string`	`Y`	模块固件版本号;
`mcu_ver`	`string`	`O`	MCU 固件版本号;
`prot`	`string(4bytes)`	`Y`	通讯协议；多协议设备使用","分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`sn`	`string(4bytes)`	`O`	序列号；
`mfr`	`string(8bytes)`	`Y`	制造商；
`model`	`string(8bytes)`	`Y`	型号；
`attrs`	`string`	`Y`	属性 JSON 字符串数据；

自动化数据同步

Topic：{device_id}/data_sync/automation

{
  "flag": 1,
  "completed": false,
  "data": [
    {
      "automation_id": "123456",
      "name": "自动化",
      "conditions": "{\"if_conditions\":[{\"time_condition\":{\"time\":\"1514\",\"date\":\"20240205\",\"repeat\":{\"ty\":\"Min\",\"val\":1}}},{\"astro_condition\":{\"at_sunrise\":true,\"sunrise_in_minutes\":{\"ty\":\"GT\",\"val\":5},\"at_sunset\":true,\"sunset_in_minutes\":{\"ty\":\"LT\",\"val\":5}}},{\"mode_condition\":{\"mode_id\":\"3ade50e302ad4ea6975372017194fa8c\"}},{\"device_condition\":{\"sid\":\"14B457FFFECFFCEA_01\",\"id\":\"Onoff\",\"val\":0,\"ty\":\"EQ\"}}],\"and_conditions\":[{\"time_condition\":{\"time\":\"1514\",\"date\":\"20240205\",\"repeat\":{\"ty\":\"Min\",\"val\":1}}},{\"astro_condition\":{\"at_sunrise\":true,\"sunrise_in_minutes\":{\"ty\":\"GT\",\"val\":5},\"at_sunset\":true,\"sunset_in_minutes\":{\"ty\":\"LT\",\"val\":5}}},{\"mode_condition\":{\"mode_id\":\"3ade50e302ad4ea6975372017194fa8c\"}},{\"device_condition\":{\"sid\":\"14B457FFFECFFCEA_01\",\"id\":\"Onoff\",\"val\":0,\"ty\":\"EQ\"}}]}",
      "actions": "{\"actions_true\":[{\"sid\":\"14B457FFFECFFCEA_01\",\"id\":\"Onoff\",\"val\":1,\"prot\":\"1,4\",\"categ\":\"0002\"},{\"groups_id\":\"3ade50e302ad4ea6975372017194fa8c\",\"id\":\"Onoff\",\"val\":0}],\"actions_false\":[{\"sid\":\"14B457FFFECFFCEA_02\",\"id\":\"Level\",\"val\":10,\"prot\":\"1,4\",\"categ\":\"0002\"},{\"groups_id\":\"3ade50e302ad4ea6975372017194fa8c\",\"id\":\"Level\",\"val\":10}]}"
    }
  ]
}

参数名称	参数类型	是否必填	参数说明
`flag`	`uint`	`Y`	标志位；
`completed`	`bool`	`Y`	所有数据是否已发送完毕；

data

参数名称	参数类型	是否必传	参数说明
`automation_id`	`string(4bytes)`	`Y`	自动化 ID；
`name`	`string`	`Y`	自动化名称；
`conditions`	`string`	`Y`	条件 JSON 字符串数据
`actions`	`string`	`Y`	动作 JSON 字符串数据

群组数据同步

Topic：{device_id}/data_sync/groups

{
  "flag": 1,
  "completed": false,
  "data": [
    {
      "groups_id": "123456",
      "name": "群组",
      "prot": "1,2,3",
      "categ": "aaabbbccc",
      "sids": "[\"aaa_111\",\"bbb_222\",\"ccc_333\"]",
      "attrs": "[{\"id\":\"1000_0000\",\"val\":\"0\",\"acc\":2,\"dty\":5}]",
      "model": "4512792"
    }
  ]
}

参数名称	参数类型	是否必填	参数说明
`flag`	`uint`	`Y`	标志位；
`completed`	`bool`	`Y`	所有数据是否已发送完毕；

data

参数名称	参数类型	是否必传	参数说明
`groups_id`	`string(4bytes)`	`Y`	群组 ID；
`name`	`string`	`Y`	群组名称；
`prot`	`string(4bytes)`	`Y`	通讯协议；多协议设备使用","分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`categ`	`string(8bytes)`	`Y`	品类
`sids`	`string`	`Y`	子设备 ID；JSON字符串数据
`attrs`	`string`	`Y`	属性；JSON字符串数据
`model`	`string`	`Y`	型号

OTA回复

Topic：{device_id}/ota/reply

{
  "prog": 1,
  "exec_id": "b6d008dff2bf4247ad8b1e3a31ffacf0",
  "ota_id": "93da3f974a3044f5877343b12aa1829e"
}
或者
 {
   "mac": "14B457FFFECFFCEA",
   "prog": 1,
   "exec_id": "b6d008dff2bf4247ad8b1e3a31ffacf0"
   "ota_id": "93da3f974a3044f5877343b12aa1829e"
 }

参数名称	参数类型	是否必填	参数说明
`prog`	`uint`	`Y`	0~100：下载文件进度； 101：升级中； 102：OTA成功； 103：OTA失败；
`exec_id`	`string(4bytes)`	`Y`	执行ID；
`ota_id`	`string(4bytes)`	`Y`	OTA ID；
`reason`	`string(32bytes)`	`O`	失败原因；
`mac`	`string(4bytes)`	`O`	子设备 MAC 地址；当mac不为空时，则回复的是子设备的 OTA 消息

控制回复

V1

Topic：{device_id}/settings/reply

{
  "set_id": 1732588374776,
  "rs": 1
}

参数名称	参数类型	是否必填	参数说明
`set_id`	`uint`	`Y`	设置ID；
`rs`	`uint`	`Y`	设置结果； 0：失败； 1：成功；

V2

Topic：{device_id}/ctrl/reply

{
  "set_id": 1732588374776,
  "rs": 1
}

参数名称	参数类型	是否必填	参数说明
`set_id`	`uint`	`Y`	设置ID；
`rs`	`uint`	`Y`	设置结果； 0：失败； 1：成功；

数据迁移回复

Topic：{device_id}/gateway_transfer/reply

{
  "transfer_id": "b17b0f06070e496a860cb78fe57b43e6",
  "ty": Groups,
  "flag": 1,
  "completed": true
}
或者
{
  "transfer_id": "b17b0f06070e496a860cb78fe57b43e6",  
  "ty": Automation,
  "flag": 1,
  "completed": true
}

参数名称	参数类型	是否必填	参数说明
`transfer_id`	`string`	`Y`	转移ID；
`ty`	`string`	`Y`	类型； Groups Automation
`flag`	`uint`	`Y`	标志位；
`completed`	`bool`	`Y`	平台侧的数据，是否已经全部发送完毕

注册

Topic：{device_id}/register

{
  "name": "Namron-Gateway",
  "ty": 2,
  "categ": "GateWay",
  "prot": "3",
  "mod_ver": "1.2.34",
  "mcu_ver": "1.0.0",
  "sn": "xxxx-xxxx-xxxx",
  "mac": "14B457FFFECFFCEA",
  "mfr": "HZC",
  "model": "Gateway",
  "reseted": false,
  "attrs": [
    {
      "id": "Onoff",
      "acc": 2,
      "dty": 7,
      "val": 0
    },
    {
      "id": "Level",
      "acc": 2,
      "dty": 7,
      "val": 50,
      "min": 0,
      "max": 100
    }
  ]
}

参数名称	参数类型	是否必填	参数说明
`name`	`string(64bytes)`	`Y`	设备名称
`ty`	`uint`	`Y`	设备类型； 1：直连设备 2：网关设备
`categ`	`string(64bytes)`	`O`	品类；
`prot`	`string(32bytes)`	`Y`	通讯协议；多协议设备使用","分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`mod_ver`	`string(16bytes)`	`O`	模块固件版本号；
`mcu_ver`	`string(16bytes)`	`O`	MCU固件版本号；
`sn`	`string(32bytes)`	`O`	序列号；
`mac`	`string(32bytes)`	`O`	MAC地址；
`mfr`	`string(32bytes)`	`Y`	制造商；
`model`	`string(64bytes)`	`Y`	型号；
`reseted`	`bool`	`O`	设备是否已重置；当此字段为true时，平台会删除掉所有与设备、家庭相关的数据
`attrs`	`array`	`Y`	属性；

attrs

参数名称	参数类型	是否必填	参数说明
`id`	`string(64bytes)`	`Y`	标识符；
`acc`	`uint`	`Y`	访问模式； 1：ReadOnly 2：ReadWrite
`dty`	`uint`	`Y`	数据类型；详见附录data_type
`val`	`any`	`Y`	当前值；与dty对应
`max`	`int`	`O`	最大值；
`min`	`int`	`O`	最小值；
`def`	`any`	`O`	默认值；与dty对应
`mul`	`int`	`O`	乘数；
`div`	`int`	`O`	除数；

上报

Topic：{device_id}/report

{
  "attrs": [
    {
      "id": "onoff",
      "val": 1
    },
    {
      "id": "level",
      "val": 2
    }
  ]
}
或者
{
  "attrs": [
    {
      "id": "onoff",
      "val": 1
    },
    {
      "id": "level",
      "val": 2
    }
  ],
  "sid": "14B457FFFECFFCEA_01"
}

参数名称	参数类型	是否必填	参数说明
`attrs`	`array`	`Y`	属性；
`sid`	`string(32bytes)`	`O`	子设备ID；当sid不为空时，则上报的是子设备的属性

attrs

参数名称	参数类型	是否必填	参数说明
`id`	`string(64bytes)`	`Y`	标识符；
`val`	`any`	`Y`	当前值；与data_type对应

重置

Topic：{device_id}/reset
非子设备重置，发送空字符payload给平台即可

 {
   "mac": "14B457FFFECFFCEA",
 }

参数名称	参数类型	是否必填	参数说明
`mac`	`string(32bytes)`	`O`	子设备MAC地址；当mac不为空时，则重置的是子设备

异常

Topic：{device_id}/exception
任意字符串内容均可，不可超过2MB

子设备注册

Topic：{device_id}/sub/reg

{
  "name": "调光灯",
  "mac": "14B457FFFECFFCEA",
  "sid": "14B457FFFECFFCEA_01",
  "categ": "Dimmer",
  "prot": "3",
  "mod_ver": "1.2.34",
  "mcu_ver": "1.0.0",
  "sn": "xxxx-xxxx-xxxx",
  "mfr": "HZC",
  "model": "Dimmer-D581-ZB",
  "attrs": [
    {
      "id": "Onoff",
      "acc": 2,
      "dty": 7,
      "val": 0
    },
    {
      "id": "Level",
      "acc": 2,
      "dty": 7,
      "val": 50,
      "min": 0,
      "max": 100
    }
  ]
}

参数名称	参数类型	是否必填	参数说明
`name`	`string(64bytes)`	`Y`	子设备名称；
`mac`	`string(32bytes)`	`Y`	子设备MAC地址；
`sid`	`string(32bytes)`	`Y`	子设备ID；需确保唯一性，建议使用MAC地址编号；比如：14B457FFFECFFCEA_01
`categ`	`string(64bytes)`	`O`	品类；
`prot`	`string(32bytes)`	`Y`	通讯协议；多协议设备使用","分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`mod_ver`	`string(16bytes)`	`O`	模块固件版本号；
`mcu_ver`	`string(16bytes)`	`O`	MCU固件版本号；
`sn`	`string(32bytes)`	`O`	序列号；
`mfr`	`string(32bytes)`	`Y`	制造商；
`model`	`string(64bytes)`	`Y`	型号；
`attrs`	`array`	`Y`	属性；

attrs

参数名称	参数类型	是否必填	参数说明
`id`	`string(64bytes)`	`Y`	标识符；
`acc`	`uint`	`Y`	访问模式； 1：ReadOnly 2：ReadWrite
`dty`	`uint`	`Y`	数据类型；详见附录data_type
`val`	`any`	`Y`	当前值；与dty对应
`max`	`int`	`O`	最大值；
`min`	`int`	`O`	最小值；
`def`	`any`	`O`	默认值；与dty对应
`mul`	`int`	`O`	乘数；
`div`	`int`	`O`	除数；

子设备上线

Topic：{device_id}/sub/online

{
  "macs": [
    "14B457FFFECFFCEA",
    "155632FFFECFFCEB",
    "16Q25VFLFECFFCEC"
  ]
}

参数名称	参数类型	是否必填	参数说明
`macs`	`array`	`Y`	N个子设备的MAC地址；

子设备下线

Topic：{device_id}/sub/offline

{
  "macs": [
    "14B457FFFECFFCEA",
    "155632FFFECFFCEB",
    "16Q25VFLFECFFCEC"
  ]
}

参数名称	参数类型	是否必填	参数说明
`macs`	`array`	`Y`	N个子设备的MAC地址；

子设备入网

Topic：{device_id}/sub/join

 {
   "rs": 1,
 }

参数名称	参数类型	是否必填	参数说明
`rs`	`uint`	`Y`	0：入网失败； 1：入网成功；

模式、自动化执行日志

Topic：{device_id}/exec/log

 {
   "id": "3ade50e302ad4ea6975372017194fa8c",
   "ty": 1,
   "rs": 1
   "ts": "1736927423665",
 }

参数名称	参数类型	是否必填	参数说明
`id`	`string`	`Y`	ID；模式或自动化的 ID
`ty`	`uint`	`Y`	类型； 1：模式 2：自动化
`rs`	`uint`	`Y`	执行结果； 0：失败 1：成功
`ts`	`uint`	`Y`	执行时间；UTC毫秒时间戳

网关连接遥控器

Topic：{device_id}/connected/rc
发送空字符payload给平台即可

网关通知

Topic：{device_id}/gateway/notify

 {
   "rs": 1,
   "ops": "Join"
 }
 或
 {
   "rs": 1,
   "ops": "Join",
   "reason": "failed reason content"
 }
 或
  {
   "rs": 1,
   "ops": "Join",
   "reason": "failed reason content",
   "mac": "14B457FFFECFFCEA",
 }
  或
  {
   "rs": 1,
   "ops": "Join",
   "reason": "failed reason content",
   "mac": "14B457FFFECFFCEA",
   "ext_params": {
       "groups_id": "abcd123456"
   }
 }

参数名称	参数类型	是否必填	参数说明
`rs`	`uint`	`Y`	结果； 0：失败 1：成功
`ops`	`string`	`Y`	操作类型； Join：入网 Bind：绑定 Status：获取状态 Cfg：配网 FastPollTimeout：网关收到唤醒时间 CfgBut：遥控器绑定 GroupAdd：添加群组（遥控器） GroupCreate：群组创建 GroupRemove：移除群组 MeshCfgGet：网关收到mesh 网络配置 MeshCfgSet：网关配置完成 WiFiConnect：WiFi是否连接成功
`reason`	`string`	`Y`	失败原因；当rs为0时，才有此字段
`mac`	`string`	`O`	子设备 MAC 地址
`ext_params`	`object`	`O`	扩展参数；

固件版本号

Topic：{device_id}/fw_ver

 {
   "ty": 1,
   "ver": "1.0.0"
 }
 或者
 {
   "ty": 1,
   "ver": "1.0.0",
   "mac": "14B457FFFECFFCEA"
 }

参数名称	参数类型	是否必填	参数说明
`ty`	`uint`	`Y`	固件类型； 1：模块 2：MCU
`ver`	`string`	`Y`	固件版本号；
`mac`	`string`	`O`	子设备 MAC 地址；此字段不为空时，则是子设备的固件版本号

绑定Ble Mesh网络

Topic：{device_id}/bind_ble_mesh

{
  "device_ids": [
    "D8A90EEF3A7249239B29446D2526B4C5",
    "126A000000030329000CC26A8F8F3938",
    "126A000000030329000E096A8F8F3938",
    "126A00000002005B0004D560C05FAE0C",
    "126A00000002005B0004DB61C05FAE0C"
  ]
}

参数名称	参数类型	是否必填	参数说明
`device_ids`	`array`	`Y`	设备ID；即：Mesh 网络配置主题，mesh_cfg字段内容里的nodes节点下面所有的UUID

Ble Mesh网络序列号

Topic：{device_id}/mesh_seq_no

{
  "val": 10
}

参数名称	参数类型	是否必填	参数说明
`val`	`uint`	`Y`	当前值

自定义消息

Topic：{device_id}/custom_msg

{
  "title": "title_111",
  "content": "content_111",
  "home_id": "home_id_111",
  "user_ids": [
    "user_id_111",
    "user_id_222",
    "user_id_333"
  ],
  "type": 1
}
或者
{
  "title": "title_111",
  "content": "content_111",
  "home_id": "home_id_111",
  "user_ids": [
    "user_id_111",
    "user_id_222",
    "user_id_333"
  ],
  "type": 1,
  "delay_time": 3600
}

参数名称	参数类型	是否必填	参数说明
`title`	`string`	`Y`	标题
`content`	`string`	`Y`	内容
`home_id`	`string`	`Y`	家庭 ID
`user_ids`	`array(string)`	`Y`	用户 ID
`type`	`uint`	`Y`	消息类型； 1：push_notify 2：msg_center
`delay_time`	`uint`	`O`	延迟时间；单位：秒

系统动作

Topic：{device_id}/system_action

 {
   "type": "DisableHomeMember",
   "home_id": "home_id_111",
   "values": [
       "1234567890",
       "9876543210"
   ],
   "delay_time": 120
 }

参数名称	参数类型	是否必填	参数说明
`type`	`string`	`Y`	类型；禁用家庭成员：HomeMemberDisable 启用家庭成员：HomeMemberEnable 禁用自动化：AutomationDisable 启用自动化：AutomationEnable
`home_id`	`string`	`Y`	家庭 ID；
`values`	`array(string)`	`O`	类型；ID 列表；
`delay_time`	`uint`	`O`	延迟时间；单位：秒

下行主题（平台➡️设备）

注册回复

Topic：{device_id}/register/reply

{
  "tz": "America/New_York",  
  "ts": 1735609714,
  "is_dst": true,
  "jet_lag": -3600,
  "offset": -4
  "account_deleted": false,
  "home_deleted": false,
  "lon": "114.228463",
  "lat": "22.695586",
  "mesh_cfg": {\"aaa\":\"123\",\"bbb\":456}
}

参数名称	参数类型	是否必填	参数说明
`tz`	`string`	`Y`	设备时区；
`lon`	`string`	`Y`	经度；
`lat`	`string`	`Y`	纬度；
`ts`	`uint`	`Y`	UTC秒级时间戳；
`is_dst`	`bool`	`Y`	是否为夏令时；
`jet_lag`	`int`	`Y`	时差；单位：秒如果为【负数】，则说明比正常时间慢了，通常只有夏令时才会这样
`offset`	`int`	`Y`	时间偏移量；
`account_deleted`	`bool`	`O`	绑定设备的【账号】是否已删除；为 true 时，网关需要恢复出厂设置，删除掉所有数据
`home_deleted`	`bool`	`O`	绑定设备的【家庭】是否已删除；为 true 时，网关需要恢复出厂设置，删除掉所有数据
`mesh_cfg`	`string`	`O`	家庭的 Mesh 网络配置内容； JSON字符串；需转义

时间同步回复

Topic：{device_id}/time/sync/reply

{
  "tz": "America/New_York",  
  "ts": 1735609714,
  "is_dst": true,
  "jet_lag": -18000,
  "offset": -5,
  "new_offset": -5.00
}

参数名称	参数类型	是否必填	参数说明
`tz`	`string(64bytes)`	`Y`	设备时区；
`ts`	`uint`	`Y`	UTC秒级时间戳；
`is_dst`	`bool`	`Y`	是否为夏令时；
`jet_lag`	`int`	`Y`	时差；单位：秒如果为【负数】，则说明比正常时间慢了，通常只有夏令时才会这样
`offset`	`int`	`Y`	时间偏移量；单位：小时因缺少精度，该参数已弃用；改用`new_offset`
`new_offset`	`double`	`Y`	时间偏移量；单位：小时

数据同步回复

Topic：{device_id}/data_sync/reply

{
  "ty": "Device",
  "flag": 10,
  "completed": true
}

参数名称	参数类型	是否必填	参数说明
`ty`	`string`	`Y`	类型； Device Groups Automation
`flag`	`uint`	`Y`	标志位；
`completed`	`bool`	`Y`	是否处理完成；

数据迁移

自动化数据迁移

Topic：{device_id}/transfer/automation

{
  "transfer_id": "b17b0f06070e496a860cb78fe57b43e6",
  "flag": 1,
  "completed": false,
  "data": []
}

参数名称	参数类型	是否必填	参数说明
`transfer_id`	`string`	`Y`	转移ID；回复时需带上此字段值一起返回给平台
`flag`	`uint`	`Y`	标志位；
`completed`	`bool`	`Y`	平台侧的数据，是否已经全部发送完毕；
`data`	`array`	`Y`	参见创建自动化，有可能会是空列表`data:[]`；

群组数据迁移

Topic：{device_id}/transfer/groups

{
  "transfer_id": "b17b0f06070e496a860cb78fe57b43e6",
  "flag": 1,
  "completed": false,
  "data": [
    {
      "groups_id": "123456",
      "prot": "1,4",
      "categ": "0002",
      "sids": [
        "14B457FFFECFFCEA_01",
        "14B457FFFECFFCEA_02"
      ],
      "attrs": [
        {
          "id": "StUpOnOff",
          "val": "0"
        },
        {
          "id": "Onoff",
          "val": "1"
        }
      ],
      "mesh_addr": 123456
    }
  ]
}

参数名称	参数类型	是否必填	参数说明
`transfer_id`	`string`	`Y`	转移ID；回复时需带上此字段值一起返回给平台
`flag`	`uint`	`Y`	标志位；
`completed`	`bool`	`Y`	所有数据是否已发送完毕；
`data`	`array`	`Y`	参见Mesh网络，有可能会是空列表`data:[]`；

Mesh 网络配置

Topic：{device_id}/mesh_cfg

{
  "mesh_cfg": {\"aaa\":\"123\",\"bbb\":456}
}
或者
{
  "mesh_seq_no": 100,
  "mesh_cfg": {\"aaa\":\"123\",\"bbb\":456}
}

参数名称	参数类型	是否必填	参数说明
`mesh_seq_no`	`uint`	`O`	家庭的 Mesh 网络序列号
`mesh_cfg`	`string`	`Y`	家庭的 Mesh 网络配置内容； JSON字符串；需转义

踢出

Topic：{device_id}/kick_out
发送空字符payload给设备；当设备收到此消息时，需要删掉本地的Ble Mesh网络配置、自动化、群组等等相关数据，并断开与平台的连接，下线

控制

V1

Topic：{device_id}/settings

{
  "id": "Onoff",
  "val": 0,
  "prot": "4", 
  "set_id": 1732529590807,
  "categ": "Gateway",
  "model": "model"
 }
 或者
 {
  "id": "Onoff",
  "val": 0,
  "prot": "4",
  "sid": "14B457FFFECFFCEA_01",
  "set_id": 1732529590807,
  "categ": "Gateway",
  "model": "model"
 }
 或者
  {
  "set_id": 1732529590807,
  "groups_id": "365f5549cd0a4c01a4b0ed496871d730",
  "id": "Onoff",
  "val": 0，
  "is_mesh": false,
  "model": "model"
 }
 或者
  {
  "set_id": 1732529590807,
  "groups_id": 123456,
  "id": "Onoff",
  "val": 0，
  "is_mesh": true,
  "mesh_addr": 123456,
  "model": "model"
 }

参数名称	参数类型	是否必填	参数说明
`set_id`	`uint`	`Y`	设置消息ID；回复时需带上此字段值一起返回给平台
`groups_id`	`string(32bytes)`	`O`	群组 ID 此字段不为空时，控制的则是【群组】
`is_mesh`	`bool`	`O`	是否为 Mesh 网络；
`mesh_addr`	`uint`	`O`	Mesh 网络地址；
`id`	`string(64bytes)`	`Y`	属性ID；
`val`	`any`	`Y`	属性值；
`prot`	`string(32bytes)`	`O`	通讯协议；多协议设备使用,分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`sid`	`string(32bytes)`	`O`	子设备 ID；
`categ`	`string(64bytes)`	`O`	品类；
`model`	`string(64bytes)`	`Y`	型号；

V2

Topic：{device_id}/ctrl

{
  "id": "Onoff",
  "val": 0,
  "prot": "4", 
  "set_id": 1732529590807,
  "categ": "Gateway",
  "model": "model"
 }
 或者
 {
  "id": "Onoff",
  "val": 0,
  "prot": "4",
  "sid": "14B457FFFECFFCEA_01",
  "set_id": 1732529590807,
  "categ": "Gateway",
  "model": "model"
 }
 或者
  {
  "set_id": 1732529590807,
  "groups_id": "365f5549cd0a4c01a4b0ed496871d730",
  "id": "Onoff",
  "val": 0，
  "is_mesh": false,
  "model": "model"
 }
 或者
  {
  "set_id": 1732529590807,
  "groups_id": 123456,
  "id": "Onoff",
  "val": 0，
  "is_mesh": true,
  "mesh_addr": 123456,
  "model": "model"
 }

参数名称	参数类型	是否必填	参数说明
`set_id`	`uint`	`Y`	设置消息ID；回复时需带上此字段值一起返回给平台
`groups_id`	`string(32bytes)`	`O`	群组 ID 此字段不为空时，控制的则是【群组】
`is_mesh`	`bool`	`O`	是否为 Mesh 网络；
`mesh_addr`	`uint`	`O`	Mesh 网络地址；
`id`	`string(64bytes)`	`Y`	属性ID；
`val`	`any`	`Y`	属性值；
`prot`	`string(32bytes)`	`O`	通讯协议；多协议设备使用,分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`sid`	`string(32bytes)`	`O`	子设备 ID；
`categ`	`string(64bytes)`	`O`	品类；
`model`	`string(64bytes)`	`Y`	型号；

批量控制

Topic：{device_id}/batch_ctrl

{
  "set_id": 1732529590807,
  "cmds": [
    {
      "sid": "14B457FFFECFFCEA_01",
      "id": "Onoff",
      "val": 1,
      "prot": "4",
      "categ": "0003",
      "model": "model"
    }
    },
    {
      "sid": "14B457FFFECFFCEA_02",
      "id": "Onoff",
      "val": 1,
      "prot": "4",
      "categ": "0003",
      "model": "model"
    }
    },
    {
      "sid": "2032_00",
      "id": "Onoff",
      "val": 1,
      "prot": "4",
      "categ": "0003",
      "model": "model"
    }
  ]
}

参数名称	参数类型	是否必填	参数说明
`set_id`	`uint`	`Y`	设置消息ID；回复时需带上此字段值一起返回给平台

cmds

参数名称	参数类型	是否必填	参数说明
`sid`	`string(32bytes)`	`O`	子设备 ID；
`id`	`string(64bytes)`	`Y`	属性ID；
`val`	`any`	`Y`	属性值；
`prot`	`string(32bytes)`	`O`	通讯协议；多协议设备使用,分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`categ`	`string(64bytes)`	`O`	品类；
`model`	`string(64bytes)`	`O`	型号；

OTA

Topic：{device_id}/ota

 {
   "ty": 1,
   "size": 100000,
   "url": "https://xxxxxxxxxxxxxxxxx.com",
   "ver": "1.03",
   "checksum": 65535,
   "exec_id": "b6d008dff2bf4247ad8b1e3a31ffacf0",
   "ota_id": "93da3f974a3044f5877343b12aa1829e"
 }
或者
{
  "ty": 1,
  "size": 100000,
  "url": "https://xxxxxxxxxxxxxxxxx.com",
  "ver": "1.03",
  "checksum": 65535,
  "ota_id": "0125872915094ad38b95290347c5f61b",
  "sub_devices": [
    {
      "exec_id": "f293bb24ceef4cc0b265b471d07e380e",
      "mac": "0CAE5FFFFEBF7808",
      "prot": "1,6",
    },
    {
      "exec_id": "41ce9ccfde5341318e0cb96024c98369",
      "mac": "38398FFFFE8F717F",
      "prot": "1,6",
    },
    {
      "exec_id": "e7747c697884469da77a320a4ae76e15",
      "mac": "F4B3B1FFFE63BB03",
      "prot": "1,6",
    },
    {
      "exec_id": "601acc354bdd43d5af6342d4053af840",
      "mac": "A4C1383C358488C3",
      "prot": "1,6",
    }
  ]
}

参数名称	参数类型	是否必填	参数说明
`ty`	`uint`	`Y`	OTA类型； 1：模块； 2：MCU；
`size`	`uint`	`Y`	固件文件大小；单位：字节
`url`	`string(255bytes)`	`Y`	固件下载地址；
`ver`	`string(16bytes)`	`Y`	固件版本；
`checksum`	`uint`	`Y`	CRC16校验和；多项式：0x1021
`exec_id`	`string(32bytes)`	`O`	执行ID；给子设备OTA时，此字段缺失回复时，需带上此字段值一起返回给平台
`ota_id`	`string(32bytes)`	`Y`	任务ID；回复时，需带上此字段值一起返回给平台
`sub_devices`	`array`	`O`	子设备； sub_devices不为空时，则是给子设备OTA

sub_devices

参数名称	参数类型	是否必填	参数说明
`exec_id`	`string(32bytes)`	`Y`	执行ID；回复时，需带上此字段值一起返回给平台
`mac`	`string(32bytes)`	`Y`	子设备MAC地址
`prot`	`string(32bytes)`	`Y`	通讯协议；多协议设备使用,分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT

删除设备

Topic：{device_id}/delete

{
 "prot": "1,2,3,4",
}
或者
{
  "prot": "1,2,3,4",
  "mac": "14B457FFFECFFCEA"
}

参数名称	参数类型	是否必填	参数说明
`prot`	`string(32bytes)`	`Y`	通讯协议；多协议设备使用,分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`mac`	`string(32bytes)`	`O`	子设备MAC地址；如果此字段不为空，则删除的是子设备

删除账号

Topic：{device_id}/delete_account

{
 "user_account": "123@qq.com",
 "delete_time": 1738996533257
}

参数名称	参数类型	是否必填	参数说明
`user_account`	`string(255bytes)`	`Y`	用户账号
`delete_time`	`uint`	`Y`	删除时间；UTC时间戳

删除家庭

Topic：{device_id}/delete_home

{
 "home_id": "1234567890",
 "home_name": "test123",
 "delete_time": 1738996533257
}

参数名称	参数类型	是否必填	参数说明
`home_id`	`string(32bytes)`	`Y`	家庭 ID
`home_name`	`string(64bytes)`	`Y`	家庭名称
`delete_time`	`uint`	`Y`	删除时间；UTC时间戳

修改设备名称

Topic：{device_id}/update/device_name

{
 "name": "abc123",
 "prot": "1,6"
}
或者
{
 "name": "abc123",
 "prot": "1,6",
 "sid": "14B457FFFECFFCEA_01",
}

参数名称	参数类型	是否必填	参数说明
`name`	`string(64bytes)`	`Y`	设备名称；
`prot`	`string(32bytes)`	`Y`	通讯协议；多协议设备使用","分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`sid`	`string(32bytes)`	`O`	子设备；此字段不为空时，修改的则是子设备的名称

群组

Mesh网络

创建群组

Topic：{device_id}/mesh/groups/create

{
   "groups_id": "123456",
   "prot": "1,4",
   "categ": "0002",
   "sids": [
       "14B457FFFECFFCEA_01",
       "14B457FFFECFFCEA_02"
   ],
   "attrs": [{"id":"StUpOnOff","val":"0"},{"id":"Onoff","val":"1"}],
   "mesh_addr": 123456
 }

参数名称	参数类型	是否必填	参数说明
`groups_id`	`string(32bytes)`	`Y`	群组 ID
`prot`	`string(32bytes)`	`Y`	通讯协议；多协议设备使用","分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`categ`	`string(64bytes)`	`Y`	品类
`sids`	`array`	`Y`	子设备 ID
`attrs`	`array`	`Y`	属性
`mesh_addr`	`uint`	`Y`	Mesh 网络地址

更新群组

Topic：{device_id}/mesh/groups/update

{
   "groups_id": "123456",
   "prot": "1,4",
   "categ": "0002",
   "sids_to_add": [
       "14B457FFFECFFCEA_01",
       "14B457FFFECFFCEA_02"
   ],
   "sids_to_remove": [
       "14B457FFFECFFCEA_03"
   ],
   "attrs_to_add": [{"id":"StUpOnOff","val":"0"},{"id":"Onoff","val":"1"}],
   "attrs_to_remove": [{"id":"Level","val":"0"}],
   "attrs": [{"id":"StUpOnOff","val":"0"},{"id":"Onoff","val":"1"}],
   "mesh_addr": 123456
 }

参数名称	参数类型	是否必填	参数说明
`groups_id`	`string(32bytes)`	`Y`	群组 ID
`prot`	`string(32bytes)`	`Y`	通讯协议；多协议设备使用","分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`categ`	`string(64bytes)`	`Y`	品类
`sids_to_add`	`array`	`Y`	新增的子设备 ID
`sids_to_remove`	`array`	`Y`	删除的子设备 ID
`attrs_to_add`	`array`	`Y`	新增的属性
`attrs_to_remove`	`array`	`Y`	删除的属性
`attrs`	`array`	`Y`	属性
`mesh_addr`	`uint`	`Y`	Mesh 网络地址

删除群组

Topic：{device_id}/mesh/groups/delete

{
  "groups_id": "123456",
  "prot": "1,4",
  "categ": "0002",
  "sids": [
       "14B457FFFECFFCEA_01",
       "14B457FFFECFFCEA_02"
   ],
   "attrs": [{"id":"StUpOnOff","val":"0"},{"id":"Onoff","val":"1"}],
   "mesh_addr": 123456
}

参数名称	参数类型	是否必填	参数说明
`groups_id`	`string(32bytes)`	`Y`	群组 ID
`prot`	`string(32bytes)`	`Y`	通讯协议；多协议设备使用","分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`categ`	`string(64bytes)`	`Y`	品类
`sids`	`array`	`Y`	子设备 ID
`attrs`	`array`	`Y`	属性
`mesh_addr`	`array`	`Y`	Mesh 网络地址

非Mesh网络

创建群组

Topic：{device_id}/groups/create

 {
  "groups_id": "3ade50e302ad4ea6975372017194fa8c",
  "name": "群组",
  "prot": "1,2,3",
  "categ": "aaabbbccc",
  "sids": [
    "14B457FFFECFFCEA_01",
    "14B457FFFECFFCEA_02"
  ],
  "attrs": [
    {
      "id": "1000_0000",
      "val": "0",
      "acc": 2,
      "dty": 5
    }
  ],
  "model": "4512792"
}

参数名称	参数类型	是否必填	参数说明
`groups_id`	`string(32bytes)`	`Y`	群组 ID
`name`	`string(64bytes)`	`Y`	群组名称
`prot`	`string(32bytes)`	`Y`	通讯协议；多协议设备使用","分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`categ`	`string(64bytes)`	`Y`	品类
`sids`	`array`	`Y`	子设备 ID
`attrs`	`array`	`Y`	属性
`model`	`string`	`Y`	型号

更新群组

Topic：{device_id}/groups/update

提示

与【创建群组】相同。

删除群组

Topic：{device_id}/groups/delete

{
  "groups_id": "3ade50e302ad4ea6975372017194fa8c"
}

参数名称	参数类型	是否必填	参数说明
`groups_id`	`string(32bytes)`	`Y`	群组 ID

模式

执行模式

Topic：{device_id}/mode/exec

{
  "mode_id": "3ade50e302ad4ea6975372017194fa8c"
}

参数名称	参数类型	是否必填	参数说明
`mode_id`	`string(32bytes)`	`Y`	模式 ID

自动化

创建自动化

Topic：{device_id}/automation/create

{
  "automation_id": "a9a9b77aa12e4d98b0cc477a861f1f7e",
  "name": "test123",
  "conditions": {
    "if_conditions": [
      {
        "time_condition": {
          "time": "1514",
          "date": "20240205",
          "repeat": {
            "ty": "Min",
            "val": 1
          }
        }
      },
      {
        "astro_condition": {
          "at_sunrise": true,
          "sunrise_in_minutes": {
            "ty": "GT",
            "val": 5
          },
          "at_sunset": true,
          "sunset_in_minutes": {
            "ty": "LT",
            "val": 5
          }
        }
      },
      {
        "mode_condition": {
          "mode_id": "3ade50e302ad4ea6975372017194fa8c"
        }
      },
      {
        "device_condition": {
          "sid": "14B457FFFECFFCEA_01",
          "id": "Onoff",
          "val": 0,
          "ty": "EQ"
        },
        "weather_condition": {
          "weather_type": "Sunny",
          "temperature": {
            "ty": "GT",
            "val": 30
          },
          "humidity": "Comfortable",
          "wind_speed": {
            "ty": "LT",
            "val": 22
          }
        }
      },
      {
        "device_condition": {
          "groups_id": "3ade50e302ad4ea6975372017194fa8c"
        }
      }
    ],
    "and_conditions": [
      {
        "time_condition": {
          "time": "1514",
          "date": "20240205",
          "repeat": {
            "ty": "Min",
            "val": 1
          }
        }
      },
      {
        "astro_condition": {
          "at_sunrise": true,
          "sunrise_in_minutes": {
            "ty": "GT",
            "val": 5
          },
          "at_sunset": true,
          "sunset_in_minutes": {
            "ty": "LT",
            "val": 5
          }
        }
      },
      {
        "mode_condition": {
          "mode_id": "3ade50e302ad4ea6975372017194fa8c"
        }
      },
      {
        "automation_condition": {
          "enable": "3ade50e302ad4ea6975372017194fa8c"
        }
      },
      {
        "device_condition": {
          "sid": "14B457FFFECFFCEA_01",
          "id": "Onoff",
          "val": 0,
          "ty": "EQ"
        },
        "weather_condition": {
          "weather_type": "Sunny",
          "temperature": {
            "ty": "GT",
            "val": 30
          },
          "humidity": "Comfortable",
          "wind_speed": {
            "ty": "LT",
            "val": 22
          }
        }
      },
      {
        "device_condition": {
          "groups_id": "3ade50e302ad4ea6975372017194fa8c",
          "id": "Onoff",
          "val": 0,
          "ty": "EQ"
        }
      }
    ]
  },
  "actions": {
    "actions_true": [
      {
        "sid": "14B457FFFECFFCEA_01",
        "id": "Onoff",
        "val": 1,
        "prot": "1,4",
        "categ": "0002"
      },
      {
        "groups_id": "3ade50e302ad4ea6975372017194fa8c",
        "id": "Onoff",
        "val": 0
      }
    ],
    "actions_false": [
      {
        "sid": "14B457FFFECFFCEA_02",
        "id": "Level",
        "val": 10,
        "prot": "1,4",
        "categ": "0002"
      },
      {
        "groups_id": "3ade50e302ad4ea6975372017194fa8c",
        "id": "Level",
        "val": 10
      }
    ]
  },
  "version": 1
}

参数名称	参数类型	是否必填	参数说明
`automation_id`	`string(32bytes)`	`Y`	自动化 ID
`name`	`string(64bytes)`	`Y`	自动化名称
`conditions`	`object`	`Y`	条件
`actions`	`object`	`Y`	动作
`version`	`uint`	`Y`	版本

conditions

参数名称	参数类型	是否必填	参数说明
`if_conditions`	`array`	`Y`	IF 条件
`and_conditions`	`array`	`O`	AND 条件

actions

参数名称	参数类型	是否必填	参数说明
`actions_true`	`array`	`Y`	满足 IF 条件时，执行的动作
`actions_false`	`array`	`O`	不满足 AND 条件时，执行的动作

conditions（条件）

time_condition（时间条件）

参数名称	参数类型	是否必填	参数说明
`time`	`string`	`O`	时间；格式：时分
`date`	`string`	`O`	日期；格式：年月日
`year`	`uint`	`O`	年；格式：2026
`time_between`	`object`	`O`	时间段；格式：H:m 参见下面的Between内容
`date_between`	`object`	`O`	日期段；格式：MD 参见下面的Between内容
`day_between`	`object`	`O`	日段；格式：1~31号参见下面的Between内容
`month_between`	`object`	`O`	月段；格式：1~12月参见下面的Between内容
`week_of_year`	`uint`	`O`	一年的第几周；
`week_between_of_year`	`object`	`O`	一年的第几周段；参见下面的Between内容
`week_odd_of_year`	`bool`	`O`	一年的第几周；奇数；
`week_even_of_year`	`bool`	`O`	一年的第几周；偶数；
`month`	`uint`	`O`	月份；1 ~ 12；比特位
`day_of_week`	`uint`	`O`	星期几；0 ~ 6；比特位 0：星期天，以此类推
`day_of_month`	`uint`	`O`	每月的几号；1 ~ 31；比特位
`repeat`	`object`	`O`	重复；参见下面的Repeat内容
`invert`	`bool`	`O`	是否取反

Repeat

参数名称	参数类型	是否必填	参数说明
`ty`	`string`	`Y`	重复类型； Sec: 秒 Min: 分钟 Hour: 小时 Day: 日 Month: 月
`val`	`uint`	`Y`	重复值；与ty对应； Min：1 ~ 59 Hour：1 ~ 24 Day：1 ~ 7 Month：1 ~ 12

Between

参数名称	参数类型	是否必填	参数说明
`begin`	`string/int`	`Y`	开始
`end`	`string/int`	`Y`	结束

astro_condition（日出日落条件）

参数名称	参数类型	是否必填	参数说明
`at_sunrise`	`bool`	`O`	日出时；
`after_sunrise`	`bool`	`O`	日出之后；
`before_sunrise`	`bool`	`O`	日出之前；
`sunrise_in_minutes`	`object`	`O`	日出时间；参见下面的SunriseSunsetInMinutes内容
`at_sunset`	`bool`	`O`	日落时；
`after_sunset`	`bool`	`O`	日落之后；
`before_sunset`	`bool`	`O`	日落之前；
`daytime`	`bool`	`O`	日出到日落这段时间；
`nighttime`	`bool`	`O`	日落后到日出这段时间；
`sunset_in_minutes`	`object`	`O`	日落时间；参见下面的SunriseSunsetInMinutes内容
`invert`	`bool`	`O`	是否取反

SunriseSunsetInMinutes

参数名称	参数类型	是否必填	参数说明
`val`	`any`	`Y`	触发值；
`ty`	`string(8bytes)`	`Y`	比较类型； EQ: 等于 GT: 大于 LT: 小于

mode_condition（模式条件）

参数名称	参数类型	是否必填	参数说明
`mode_id`	`string(4bytes)`	`O`	模式 ID；
`mode_change`	`bool`	`O`	模式是否改变；
`invert`	`bool`	`O`	是否取反

automation_condition（自动化条件）

参数名称	参数类型	是否必填	参数说明
`enable`	`string(4bytes)`	`O`	启用自动化 ID；
`disable`	`string(4bytes)`	`O`	禁用自动化 ID；
`manual_start`	`bool`	`O`	手动触发；
`invert`	`bool`	`O`	是否取反

device_condition（设备条件）

参数名称	参数类型	是否必填	参数说明
`sid`	`string(32bytes)`	`Y`	子设备 ID；
`id`	`string(64bytes)`	`Y`	属性ID；
`val`	`any`	`O`	触发值；
`min_val`	`any`	`O`	最小值；
`max_val`	`any`	`O`	最大值；
`ty`	`string(8bytes)`	`Y`	比较类型； EQ：等于 GT：大于 LT：小于 NE：不等于 LE：小于等于 GE：大于等于 IR：在范围内 NIR：不在范围内 CHANGE：任意属性改变 ALARM：告警 NALARM：非告警
`prot`	`string(32bytes)`	`Y`	通讯协议；
`invert`	`bool`	`O`	是否取反
`delay_time`	`uint`	`O`	延迟时间；单位：秒

weather_condition（天气条件）

参数名称	参数类型	是否必填	参数说明
`weather_type`	`string`	`O`	天气类型； `Sunny`晴，`Cloudy`阴，`Rain`雨，`Snow`雪，`Fog`雾，`Haze`霾，`Wind`风，`Thunderstorm`雷，`ThunderstormRain`雷雨
`humidity`	`string`	`O`	湿度； `Dry`干燥（0-40%），`Comfortable`舒适（40-70%），`Moist`潮湿（70-100%）
`temperature`	`object`	`O`	温度，单位：摄氏度`℃`；参见下面的Temperature内容
`wind_speed`	`object`	`O`	风速，单位：米每秒`m/s`；参见下面的WindSpeed内容
`relative_humidity`	`object`	`O`	相对湿度；参见下面的CompareCondition内容
`weather`	`object`	`O`	天气；参见下面的CompareCondition内容
`invert`	`bool`	`O`	是否取反

Temperature

参数名称	参数类型	是否必填	参数说明
`val`	`int8`	`Y`	触发值；范围：[-40, 40]
`ty`	`string(8bytes)`	`Y`	比较类型； EQ: 等于 GT: 大于 LT: 小于

WindSpeed

参数名称	参数类型	是否必填	参数说明
`val`	`uint8`	`Y`	触发值；范围：[0, 60]
`ty`	`string(8bytes)`	`Y`	比较类型； EQ: 等于 GT: 大于 LT: 小于

CompareCondition

参数名称	参数类型	是否必填	参数说明
`ty`	`string(8bytes)`	`Y`	比较类型； EQ: 等于 GT: 大于 LT: 小于 NE：不等于 IR：在范围内 NIR：不在范围内 CHANGE：任意属性改变 ALARM：告警 NALARM：非告警
`val`	`number`	`O`	比较值；
`min_val`	`number`	`O`	比较值-最小；比较类型为 `IR`、`NIR` 不为空
`max_val`	`number`	`O`	比较值-最大；比较类型为 `IR`、`NIR` 不为空

system_condition（系统条件）

参数名称	参数类型	是否必填	参数说明
`gateway_online`	`bool`	`O`	网关在线；
`gateway_offline`	`bool`	`O`	网关离线；
`any_device_online`	`bool`	`O`	任意设备在线；
`any_device_offline`	`bool`	`O`	任意设备离线；
`device_online`	`string`	`O`	设备在线；
`device_offline`	`string`	`O`	设备离线；
`any_home_member_disable`	`bool`	`O`	任意家庭成员被禁用；
`any_home_member_enable`	`bool`	`O`	任意家庭成员被启用；
`home_member_disable`	`string`	`O`	家庭成员被禁用；
`home_member_enable`	`string`	`O`	家庭成员被启用；

group_condition（条件组）

参数名称	参数类型	是否必填	参数说明
`time_condition`	`object`	`O`	时间条件
`astro_condition`	`object`	`O`	日出日落条件
`mode_condition`	`object`	`O`	模式条件
`automation_condition`	`object`	`O`	自动化条件
`device_condition`	`object`	`O`	设备条件
`weather_condition`	`object`	`O`	天气条件
`system_condition`	`object`	`O`	系统条件

actions

参数名称	参数类型	是否必填	参数说明
`groups_id`	`string(32bytes)`	`O`	新版弃用
`mode_id`	`string(32bytes)`	`O`	新版弃用
`automation_id`	`string(32bytes)`	`O`	新版弃用
`id`	`string(64bytes)`	`O`	新版弃用
`val`	`any`	`O`	新版弃用
`prot`	`string(32bytes)`	`O`	新版弃用
`sid`	`string(32bytes)`	`O`	新版弃用
`categ`	`string(64bytes)`	`O`	新版弃用
`model`	`string(64bytes)`	`O`	新版弃用
`device_action`	`object`	`O`	设备动作；参见下面的device_action内容
`mode_action`	`object`	`O`	模式动作；参见下面的mode_action内容
`automation_action`	`object`	`O`	自动化动作；参见下面的automation_action内容
`custom_msg_action`	`object`	`O`	推送消息动作；参见下面的custom_msg_action内容
`system_action`	`object`	`O`	系统动作；参见下面的system_action内容

device_action（设备动作）

参数名称	参数类型	是否必填	参数说明
`id`	`string(64bytes)`	`O`	属性ID；
`val`	`any`	`O`	属性值；
`prot`	`string(32bytes)`	`O`	通讯协议；多协议设备使用,分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`sid`	`string(32bytes)`	`O`	子设备 ID；
`categ`	`string(64bytes)`	`O`	品类；
`model`	`string(64bytes)`	`O`	型号；
`groups_id`	`string(32bytes)`	`O`	群组 ID 此字段不为空时，则执行动作的是【群组】
`mesh_addr`	`uint`	`O`	mesh 网络地址；
`over_time`	`uint`	`O`	维持时间；单位：秒
`delay_time`	`uint`	`O`	延迟时间；单位：秒

mode_action（模式动作）

参数名称	参数类型	是否必填	参数说明
`mode_id`	`string`	`Y`	模式 ID；
`delay_time`	`uint`	`O`	延迟时间；单位：秒

automation_action（自动化动作）

参数名称	参数类型	是否必填	参数说明
`automation_id`	`string`	`Y`	自动化 ID；
`delay_time`	`uint`	`O`	延迟时间；单位：秒

custom_msg_action（自定义消息动作）

参数名称	参数类型	是否必填	参数说明
`title`	`string`	`Y`	标题；
`content`	`string`	`Y`	内容；
`home_id`	`string`	`Y`	家庭 ID；
`user_ids`	`array`	`Y`	用户 ID；
`type`	`int`	`Y`	消息类型； 1：push_notify 2：msg_center
`delay_time`	`uint`	`O`	延迟时间；单位：秒

system_action（系统动作）

参数名称	参数类型	是否必填	参数说明
`home_id`	`string`	`Y`	家庭 ID；
`home_member_disable`	`array`	`O`	禁用家庭成员；
`home_member_enable`	`array`	`O`	启用家庭成员；
`delay_time`	`uint`	`O`	延迟时间；单位：秒

更新自动化

Topic：{device_id}/automation/update

提示

与【创建自动化】相同。
可能只更新name，不更新conditions、actions，此时conditions、actions是缺失的，需判断一下

删除自动化

Topic：{device_id}/automation/delete

{
  "automation_id": "3ade50e302ad4ea6975372017194fa8c"
}

参数名称	参数类型	是否必填	参数说明
`automation_id`	`string(32bytes)`	`Y`	自动化 ID

执行自动化

Topic：{device_id}/automation/exec

{
  "automation_id": "3ade50e302ad4ea6975372017194fa8c",
  "version": 1
}

参数名称	参数类型	是否必填	参数说明
`automation_id`	`string(32bytes)`	`Y`	自动化 ID
`version`	`uint`	`Y`	版本

自动化状态（启用禁用）

Topic：{device_id}/automation_status

提示

用于匹配自动化【条件】

{
  "enable": "3ade50e302ad4ea6975372017194fa8c",
}
或者
{
  "disable": "3ade50e302ad4ea6975372017194fa8c",
}

参数名称	参数类型	是否必填	参数说明
`enable`	`string(32bytes)`	`O`	启用的自动化 ID
`disable`	`string(32bytes)`	`O`	禁用的自动化 ID

Matter网关搜网

Topic：{device_id}/matter/search

 {
   "wifi_ssid": "abc123",
   "wifi_pwd": "12345678"
   "qr": "qrcode_content"
 }
 或者
 {
   "qr": "qrcode_content"
 }

参数名称	参数类型	是否必填	参数说明
`wifi_ssid`	`string`	`O`	WiFi SSID； Matter Over WiFi才有此字段
`wifi_pwd`	`string`	`O`	WiFi密码； Matter Over WiFi才有此字段
`qr`	`string`	`Y`	二维码内容；

生物节律

Topic：{device_id}/adaptive_light

{
  "home_id": "111111111",
  "status": 1,
  "current_mode": 0,
  "devices": [
    {
      "is_mesh": false,
      "prot": "4",
      "sid": "14B457FFFECFFCEA_01",
      "categ": "0101"
    },
    {
      "is_mesh": true,
      "mesh_addr": 123456,
      "prot": "4",
      "sid": "15B457FFFECFFCEA_01",
      "categ": "0102"
    },
    {
      "groups_id": "123456"
    }
  ],
  "def_rule": null,
  "custom_rule": null
}
或者
{
  "home_id": "111111111",
  "status": 1,
  "current_mode": 0,
  "devices": [
    {
      "is_mesh": false,
      "prot": "4",
      "sid": "14B457FFFECFFCEA_01",
      "categ": "0101"
    },
    {
      "is_mesh": true,
      "mesh_addr": 123456,
      "prot": "4",
      "sid": "15B457FFFECFFCEA_01",
      "categ": "0102"
    },
    {
      "groups_id": "123456"
    }
  ],
  "def_rule": {
    "wake_up": {
      "time": 600,
      "col_temp": 1800,
      "level": 5,
      "mesh_val": "fff6419000"
    },
    "sun_rise": {
      "time": 630,
      "col_temp": 2000,
      "level": 25,
      "mesh_val": "fff6419000"
    },
    "day_time": {
      "time": 700,
      "col_temp": 3500,
      "level": 50,
      "mesh_val": "fff6419000"
    },
    "sun_set": {
      "time": 1915,
      "col_temp": 2200,
      "level": 34,
      "mesh_val": "fff6419000"
    },
    "evening": {
      "time": 1945,
      "col_temp": 2000,
      "level": 30,
      "mesh_val": "fff6419000"
    },
    "night": {
      "time": 2205,
      "col_temp": 1800,
      "level": 5,
      "mesh_val": "fff6419000"
    }
  },
  "custom_rule": null
}
或者
 {
  "home_id": "111111111",
  "status": 1,
  "current_mode": 0,
  "devices": [
    {
      "is_mesh": false,
      "prot": "4",
      "sid": "14B457FFFECFFCEA_01",
      "categ": "0101"
    },
    {
      "is_mesh": true,
      "mesh_addr": 123456,
      "prot": "4",
      "sid": "15B457FFFECFFCEA_01",
      "categ": "0102"
    },
    {
      "groups_id": "123456"
    }
  ],
  "def_rule": {
    "wake_up": {
      "time": 600,
      "col_temp": 1800,
      "level": 5,
      "mesh_val": "fff6419000"
    },
    "sun_rise": {
      "time": 630,
      "col_temp": 2000,
      "level": 25,
      "mesh_val": "fff6419000"
    },
    "day_time": {
      "time": 700,
      "col_temp": 3500,
      "level": 50,
      "mesh_val": "fff6419000"
    },
    "sun_set": {
      "time": 1915,
      "col_temp": 2200,
      "level": 34,
      "mesh_val": "fff6419000"
    },
    "evening": {
      "time": 1945,
      "col_temp": 2000,
      "level": 30,
      "mesh_val": "fff6419000"
    },
    "night": {
      "time": 2205,
      "col_temp": 1800,
      "level": 5,
      "mesh_val": "fff6419000"
    }
  },
   "custom_rule": {
    "wake_up": {
      "time": 600,
      "col_temp": 1800,
      "level": 5,
      "mesh_val": "fff6419000"
    },
    "sun_rise": {
      "time": 630,
      "col_temp": 2000,
      "level": 25,
      "mesh_val": "fff6419000"
    },
    "day_time": {
      "time": 700,
      "col_temp": 3500,
      "level": 50,
      "mesh_val": "fff6419000"
    },
    "sun_set": {
      "time": 1915,
      "col_temp": 2200,
      "level": 34,
      "mesh_val": "fff6419000"
    },
    "evening": {
      "time": 1945,
      "col_temp": 2000,
      "level": 30,
      "mesh_val": "fff6419000"
    },
    "night": {
      "time": 2205,
      "col_temp": 1800,
      "level": 5,
      "mesh_val": "fff6419000"
    }
  } 
}

参数名称	参数类型	是否必填	参数说明
`home_id`	`string`	`Y`	家庭 ID；
`status`	`uint`	`Y`	状态； 0：关闭 1：开启
`current_mode`	`uint`	`Y`	当前模式； 0：默认 1：自定义
`devices`	`array`	`O`	设备；
`def_rule`	`object`	`O`	默认规则；
`custom_rule`	`object`	`O`	自定义规则；

devices

参数名称	参数类型	是否必填	参数说明
`is_mesh`	`bool`	`Y`	是否为 Mesh 网络；
`mesh_addr`	`uint`	`O`	Mesh 网络地址；
`prot`	`string(32bytes)`	`O`	通讯协议；多协议设备使用,分隔；比如："1,2,3,4" 1：Zigbee 2：Zwave 3：Matter 4：WiFi 5：Thread 6：Bluetooth 7：4G 8：NB-IoT
`groups_id`	`string(32bytes)`	`O`	群组 ID 此字段不为空时，则触发的是【群组】
`sid`	`string(32bytes)`	`O`	子设备 ID；此字段不为空时，则触发的是【子设备】
`categ`	`string(64bytes)`	`O`	品类；

def_rule 或者 custom_rule

参数名称	参数类型	是否必填	参数说明
`wake_up`	`object`	`Y`	起床；
`sun_rise`	`object`	`Y`	日出；
`day_time`	`object`	`Y`	白天；
`sun_set`	`object`	`Y`	日落；
`evening`	`object`	`Y`	晚上；
`night`	`object`	`Y`	深夜；
-	-	-	-
`time`	`uint`	`Y`	时间；
`col_temp`	`uint`	`Y`	色温值；
`level`	`uint`	`Y`	亮度值；
`mesh_val`	`string`	`Y`	Ble Mesh 的值；

设备被绑定

Topic：{device_id}/bound

 {
   "device_id": "3ade50e302ad4ea6975372017194fa8c",
   "user_account": "123456@qq.com",
   "home_id": "a9a9b77aa12e4d98b0cc477a861f1f7e",
   "home_name": "xxxxx"
 }

参数名称	参数类型	是否必填	参数说明
`device_id`	`string`	`Y`	设备 ID；
`user_account`	`string`	`Y`	用户账号；
`home_id`	`string`	`Y`	家庭 ID；
`home_name`	`string`	`Y`	家庭名称；

家庭成员状态（禁用启用）

Topic：{device_id}/home_member_status

提示

用于匹配自动化【条件】

 {
   "user_account": "123456@qq.com",
   "home_id": "a9a9b77aa12e4d98b0cc477a861f1f7e",
   "status": 0
 }

参数名称	参数类型	是否必填	参数说明
`user_account`	`string`	`Y`	用户账号；
`home_id`	`string`	`Y`	家庭 ID；
`status`	`int`	`Y`	状态； 0：禁用 1：启用

附录

data_type

数值	类型
`1`	`int8`
`2`	`int16`
`3`	`int32`
`4`	`int64`
`5`	`uint8`
`6`	`uint16`
`7`	`uint32`
`8`	`uint64`
`9`	`float`
`10`	`double`
`11`	`string`
`12`	`bool`
`13`	`object`
`14`	`array`

设备与平台交互协议

注意事项#

名词解释#

上行主题（设备➡️平台）#

同步#

时间同步#

数据同步#

子设备数据同步#

自动化数据同步#

群组数据同步#

回复#

OTA回复#

控制回复#

V1#

V2#

数据迁移回复#

注册#

上报#

重置#

异常#

子设备注册#

子设备上线#

子设备下线#

子设备入网#

模式、自动化执行日志#

网关连接遥控器#

网关通知#

固件版本号#

绑定Ble Mesh网络#

Ble Mesh网络序列号#

自定义消息#

系统动作#

下行主题（平台➡️设备）#

回复#

注册回复#

时间同步回复#

数据同步回复#

数据迁移#

自动化数据迁移#

群组数据迁移#

Mesh 网络配置#

踢出#

控制#

V1#

V2#

批量控制#

OTA#

删除设备#

删除账号#

删除家庭#

修改设备名称#

群组#

Mesh网络#

创建群组#

更新群组#

删除群组#

非Mesh网络#

创建群组#

更新群组#

删除群组#

模式#

执行模式#

自动化#

创建自动化#

conditions（条件）#

time_condition（时间条件）#

astro_condition（日出日落条件）#

mode_condition（模式条件）#

automation_condition（自动化条件）#

device_condition（设备条件）#

weather_condition（天气条件）#

system_condition（系统条件）#

group_condition（条件组）#

actions#

device_action（设备动作）#

mode_action（模式动作）#

automation_action（自动化动作）#

custom_msg_action（自定义消息动作）#

system_action（系统动作）#

更新自动化#

注意事项

名词解释

上行主题（设备➡️平台）

同步

时间同步

数据同步

子设备数据同步

自动化数据同步

群组数据同步

回复

OTA回复

控制回复

V1

V2

数据迁移回复

注册

上报

重置

异常

子设备注册

子设备上线

子设备下线

子设备入网

模式、自动化执行日志

网关连接遥控器

网关通知

固件版本号

绑定Ble Mesh网络

Ble Mesh网络序列号

自定义消息

系统动作

下行主题（平台➡️设备）

回复

注册回复

时间同步回复

数据同步回复

数据迁移

自动化数据迁移

群组数据迁移

Mesh 网络配置

踢出

控制

V1

V2

批量控制

OTA

删除设备

删除账号

删除家庭

修改设备名称

群组

Mesh网络

创建群组

更新群组

删除群组

非Mesh网络

创建群组

更新群组

删除群组

模式

执行模式

自动化

创建自动化

conditions（条件）

time_condition（时间条件）

astro_condition（日出日落条件）

mode_condition（模式条件）

automation_condition（自动化条件）

device_condition（设备条件）

weather_condition（天气条件）

system_condition（系统条件）

group_condition（条件组）

actions

device_action（设备动作）

mode_action（模式动作）

automation_action（自动化动作）

custom_msg_action（自定义消息动作）

system_action（系统动作）

更新自动化

删除自动化