数据格式定义
本文针对概述中定义的消息类型,详细描述每种消息类型的数据格式。
当前版本 v1.0.0。
上下线事件
包含设备上线、下线、重新连接等设备状态信息。
字段 | 类型 | 备注 | 是否必选 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
ProductKey | String | PK | 是 | |||||||||
DeviceKey | String | DK | 是 | |||||||||
type | Enum | ONLINE | 是 | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | |||||||||
ticket | String | 消息识别码 | 是 | |||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||
| ||||||||||||
data | JSON Object | 是 | ||||||||||
|
样例:
{
"productKey": "p12345",
"deviceKey": "1234567890",
"type": "ONLINE",
"createdAt": 1609316592000,
"ticket": "5f9924d171977c33bc5ad1b1",
"gateway": {
"productKey": "p12344",
"deviceKey": "1234567891"
},
"data": {
"value": 1
}
}
设备和模组状态
包含设备状态和模组状态信息,如电量、电压、信号强度、版本、ICCID等。
字段 | 类型 | 备注 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | |||||||||
deviceKey | String | DK | |||||||||
type | Enum | STATUS | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | |||||||||
ticket | String | 消息识别码 | |||||||||
gateway | JSON Object | 网关信息 | |||||||||
| |||||||||||
data | JSON Object | ||||||||||
|
样例:
{
"productKey": "p12345",
"deviceKey": "1234567890",
"type": "STATUS",
"createdAt": 1609316592000,
"ticket": "5f9924d171977c33bc5ad1b1",
"data": {
"packetId": 3,
"kv": { "battery": "20", "voltage": "4" }
}
}
状态字段列表
类别 | 名称 | 键值 |
---|---|---|
设备状态 | 电量 | battery |
电压 | voltage | |
信号强度 | signal_strength | |
剩余空间 | memory_free | |
参考信号接收功率 | rsrp | |
LTE参考信号接收质量 | rsrq | |
信号与干扰加噪声比 | snr | |
模组状态 | 模组型号 | type |
模组版本 | version | |
MCU版本 | mcu_version | |
基站id | cell_id | |
ICCID号 | icc_id | |
移动国家代码 | mcc | |
移动网络代码 | mnc | |
位置区代码 | lac | |
phone号 | phone_num | |
SIM号 | sim_num | |
SDK版本 | sdk_ver | |
定位支持功能 | locator |
设备命令响应数据
指下发到设备的指令状态信息,包括发送成功、失败等。
字段 | 类型 | 备注 | 是否必选 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | |||||||||
deviceKey | String | DK | 是 | |||||||||
type | Enum | REQACK | 是 | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | |||||||||
ticket | String | 消息识别码(雪花算法生成) | 是 | |||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||
| ||||||||||||
data | JSON Object | 是 | ||||||||||
|
样例:
{
"productKey": "p12345",
"deviceKey": "1234567890",
"type": "REQACK",
"createdAt": 1609316592000,
"ticket": "23924d171977c121325ad1bf",
"gateway": {
"productKey": "p12344",
"deviceKey": "1234567891"
},
"data": {
"sentAt": 1609316592000,
"status": "succ"
}
}
设备信息变更
包括设备的增加、修改、删除、重置、认证、激活、注销等信息。
字段 | 名称 | 字段类型 | 是否必填 | 备注 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | 事件类型 | String | 是 | 固定为: META_EVENT | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
ticket | 消息识别码 | String | 否 | 当操作类型是激活、认证、注销时,必填,否则,不必填 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
subtype | 操作对象类型 | String | 是 | 固定为DEVICE,表示对设备的操作 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
operation | 操作 | String | 是 | ADD: 添加 UPDATE: 修改 DELETE: 删除 RESET: 重置 AUTH: 认证 ACTIVE: 激活 LOGOFF: 注销 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
productKey | 产品PK | String | 是 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceKey | 设备唯一码 | String | 是 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | 操作时间戳 | Long | 是 | 消息生成的时间戳,整型,单位毫秒 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
gateway | 网关信息 | JSON Object | 否 | 网关子设备重置/认证/注销等操作时会存在网关信息 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | JSON Object | 否 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
设备 添加/删除/激活/认证/注销
|
添加/删除 设备消息格式样例:
{
"productKey": "p11376",
"deviceKey": "132456",
"type": "META_EVENT",
"subtype": "DEVICE",
"operation": "ADD/DELETE",
"createdAt": 1616375484482,
"ticket": "1032330579905388544",
"data": {
"deviceName": "123789",
"sn": null
}
}
激活/认证/注销 设备消息格式样例:
{
"productKey": "p11376",
"deviceKey": "132456",
"type": "META_EVENT",
"subtype": "DEVICE",
"ticket": "1032330579905388544",
"operation": "AUTH/ACTIVEL/LOGOFF",
"createdAt": 1616375484482,
"gateway": {
"productKey": "p11371",
"deviceKey": "112456"
},
"data": null
}
修改设备消息格式样例:
{
"productKey": "p11376",
"deviceKey": "132456",
"type": "META_EVENT",
"subtype": "DEVICE",
"operation": "UPDATE",
"createdAt": 1616375484482,
"ticket": "1032330579905388544",
"data": {
"deviceName": {
"old": "修改前设备名称",
"new": "修改后设备名称"
},
"sn": {
"new": "修改后的SN"
},
"timeOffset": {
"old": "+06:00",
"new": "+08:00"
}
}
}
设备重置消息格式样例:
{
"productKey": "p11376",
"deviceKey": "132456",
"type": "META_EVENT",
"subtype": "DEVICE",
"operation": "RESET",
"createdAt": 1616375484482,
"data": null,
"ticket": "1032330579905388544",
"gateway": {
"productKey": "p11371",
"deviceKey": "112456"
}
}
设备绑定信息变更
终端用户针对设备的绑定信息发送变动触发的数据。
字段 | 名称 | 字段类型 | 是否必填 | 备注 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | 产品PK | String | 是 | |||||||||||||||||||||||||
deviceKey | 设备DK | String | 是 | |||||||||||||||||||||||||
deviceName | 设备名称 | String | 否 | |||||||||||||||||||||||||
type | 类型 | String | 是 | 固定为ENDUSER | ||||||||||||||||||||||||
subtype | 子类型 | String | 是 | 固定为USER-BIND | ||||||||||||||||||||||||
ticket | 消息识别码 | String | 是 | |||||||||||||||||||||||||
createdAt | 创建时间 | Long | 是 | 操作时间戳,单位毫秒 | ||||||||||||||||||||||||
data | JSON Object | 是 | ||||||||||||||||||||||||||
|
样例:
{
"type": "ENDUSER",
"subtype": "USER-BIND",
"deviceKey": "132456",
"productKey": "p11376",
"createdAt": 1616375484482,
"deviceName": "某设备",
"ticket": "23924d171977c121325ad1bf",
"data": {
"endUserId": "11376",
"endUserDomain": "C.DM.5715.1",
"value": 1
}
}
透传-设备上行数据
选择物模型或透传数据格式的产品,通过透传通道上报的设备数据。
字段 | 类型 | 备注 | 是否必选 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | |||||||||
deviceKey | String | DK | 是 | |||||||||
type | Enum | RAW | 是 | |||||||||
subtype | Enum | UPLINK | 是 | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | |||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||
| ||||||||||||
ticket | String | 消息识别码 | 是 | |||||||||
data | JSON Object | 是 | ||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "RAW",
"subtype": "UPLINK",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": "2345678901234"
},
"data": {
"packetId": 3,
"raw": "YSBtZXNzYWdl"
}
}
透传-设备下行数据
选择物模型或透传数据格式的产品,通过透传通道发送的下行控制指令数据。
字段 | 类型 | 备注 | 是否必选 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | |||||||||
deviceKey | String | DK | 是 | |||||||||
type | Enum | RAW | 是 | |||||||||
subtype | Enum | DOWNLINK | 是 | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | |||||||||
ticket | String | 消息识别码 | 是 | |||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||
| ||||||||||||
data | JSON Object | 是 | ||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "RAW",
"subtype": "DOWNLINK",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": "2345678901234"
},
"data": {
"raw": "YSBtZXNzYWdl"
}
}
物模型-物模型属性信息
选择物模型数据格式的产品下设备上下行数据。
MATTR - READ:物模型-读下发
字段 | 类型 | 备注 | 是否必选 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | |||||||||
deviceKey | String | DK | 是 | |||||||||
type | Enum | MATTR | 是 | |||||||||
subtype | Enum | READ | 是 | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | |||||||||
ticket | String | 消息识别码 | 是 | |||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||
| ||||||||||||
data | JSON Object | 是 | ||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "MATTR",
"subtype": "READ",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": "2345678901234"
},
"data": {
"keys": ["code1", "code2"]
}
}
MATTR – READRESP:物模型-读响应
字段 | 类型 | 备注 | 是否必选 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | |||||||||
deviceKey | String | DK | 是 | |||||||||
type | Enum | MATTR | 是 | |||||||||
subtype | Enum | READRESP | 是 | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | |||||||||
ticket | String | 消息识别码 | 是 | |||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||
| ||||||||||||
data | JSON Object | 是 | ||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "MATTR",
"subtype": "READRESP",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": "2345678901234"
},
"data": {
"packetId": 3,
"kv": {
"numberKey": "10.2",
"boolKey": true,
"enumKey": "1"
}
}
}
备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。
MATTR - WRITE:物模型-写下发
字段 | 类型 | 备注 | 是否必选 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | |||||||||
deviceKey | String | DK | 是 | |||||||||
type | Enum | MATTR | 是 | |||||||||
subtype | Enum | WRITE | 是 | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | |||||||||
ticket | String | 消息识别码 | 是 | |||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||
| ||||||||||||
data | JSON Object | 是 | ||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "MATTR",
"subtype": "WRITE",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": "2345678901234"
},
"data": {
"kv": {
"code1": "1",
"code2": "3"
}
}
}
MATTR – REPORT:物模型-上报
字段 | 类型 | 备注 | 是否必选 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | |||||||||
deviceKey | String | DK | 是 | |||||||||
type | Enum | MATTR | 是 | |||||||||
subtype | Enum | REPORT | 是 | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | |||||||||
ticket | String | 消息识别码 | 是 | |||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||
| ||||||||||||
extData | JSON Object | 预留功能信息,键值对格式 | 否 | |||||||||
| ||||||||||||
data | JSON Object | 是 | ||||||||||
|
{
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "MATTR",
"subtype": "REPORT",
"createdAt": 1609316592000,
"ticket": "5f9924d171977c33bc5ad1b1",
"gateway": {
"productKey": "p111KY",
"deviceKey": "2345678901234"
},
"extData": {
"occurredAt": "1652433712899"
},
"data": {
"packetId": 5,
"kv": {
"numberKey": "10.2",
"boolKey": true,
"enumKey": "1"
}
}
}
备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。
物模型-设备上行透传数据
字段 | 类型 | 备注 | 是否必选 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | |||||||||
deviceKey | String | DK | 是 | |||||||||
type | Enum | RAW | 是 | |||||||||
subtype | Enum | UPLINK | 是 | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | |||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||
| ||||||||||||
ticket | String | 消息识别码 | 是 | |||||||||
data | JSON Object | 是 | ||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "RAW",
"subtype": "UPLINK",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": "2345678901234"
},
"data": {
"packetId": 3,
"raw": "YSBtZXNzYWdl"
}
}
备注:透传数据值为 Base64 编码。
物模型-设备下行透传数据
字段 | 类型 | 备注 | 是否必选 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | |||||||||
deviceKey | String | DK | 是 | |||||||||
type | Enum | RAW | 是 | |||||||||
subtype | Enum | DOWNLINK | 是 | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | |||||||||
ticket | String | 消息识别码 | 是 | |||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||
| ||||||||||||
data | JSON Object | 是 | ||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "RAW",
"subtype": "DOWNLINK",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": "2345678901234"
},
"data": {
"raw": "YSBtZXNzYWdl"
}
}
备注:透传数据值为 Base64 编码。
物模型-物模型事件上报-信息
选择物模型数据格式的产品下设备上报的事件信息,且定义级别为INFO。
字段 | 类型 | 备注 | 是否必选 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | ||||||||||||
deviceKey | String | DK | 是 | ||||||||||||
type | Enum | MEVENT | 是 | ||||||||||||
subtype | Enum | INFO | 是 | ||||||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | ||||||||||||
ticket | String | 消息识别码 | 是 | ||||||||||||
gateway | JSON Object | 网关信息 | 否 | ||||||||||||
| |||||||||||||||
extData | JSON Object | 预留功能信息,键值对格式 | 否 | ||||||||||||
| |||||||||||||||
data | JSON Object | 是 | |||||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "MEVENT",
"subtype": "INFO",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": "2345678901234"
},
"extData": {
"occurredAt": 1652433712899
},
"data": {
"packetId": 3,
"code": "event_code3",
"kv": {
"numberKey": "1",
"boolKey": true,
"enumKey": "1"
}
}
}
备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。
物模型-物模型事件上报-告警
选择物模型数据格式的产品下设备上报的事件信息,且定义级别为WARN。
字段 | 类型 | 备注 | 是否必选 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | ||||||||||||
deviceKey | String | DK | 是 | ||||||||||||
type | Enum | MEVENT | 是 | ||||||||||||
subtype | Enum | WARN | 是 | ||||||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | ||||||||||||
ticket | String | 消息识别码 | 是 | ||||||||||||
gateway | JSON Object | 网关信息 | 否 | ||||||||||||
| |||||||||||||||
extData | JSON Object | 预留功能信息,键值对格式 | 否 | ||||||||||||
| |||||||||||||||
data | JSON Object | 是 | |||||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "MEVENT",
"subtype": "WARN",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": "2345678901234"
},
"extData": {
"occurredAt": 1652433712899
},
"data": {
"packetId": 3,
"code": "event_code3",
"kv": {
"numberKey": "10.36",
"boolKey": true,
"enumKey": "1"
}
}
}
备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。
物模型-物模型事件上报-故障
选择物模型数据格式的产品下设备上报的事件信息,且定义级别为ERROR。
字段 | 类型 | 备注 | 是否必选 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | ||||||||||||
deviceKey | String | DK | 是 | ||||||||||||
type | Enum | MEVENT | 是 | ||||||||||||
subtype | Enum | ERROR | 是 | ||||||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | ||||||||||||
ticket | String | 消息识别码 | 是 | ||||||||||||
gateway | JSON Object | 网关信息 | 否 | ||||||||||||
| |||||||||||||||
extData | JSON Object | 预留功能信息,键值对格式 | 否 | ||||||||||||
| |||||||||||||||
data | JSON Object | 是 | |||||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "MEVENT",
"subtype": "ERROR",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": " 2345678901234"
},
"extData": {
"occurredAt": 1652433712899
},
"data": {
"packetId": 3,
"code": "event_code3",
"kv": {
"numberKey": "10.3",
"boolKey": true,
"enumKey": "1"
}
}
}
备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。
物模型-物模型服务调用日志
选择物模型数据格式的产品下设备发送的服务类型数据。
字段 | 类型 | 备注 | 是否必选 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | 是 | ||||||||||||
deviceKey | String | DK | 是 | ||||||||||||
type | Enum | MSERV | 是 | ||||||||||||
subtype | Enum | INPUT/OUTPUT | 是 | ||||||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | 是 | ||||||||||||
ticket | String | 消息识别码 | 是 | ||||||||||||
gateway | JSON Object | 网关信息 | 否 | ||||||||||||
| |||||||||||||||
extData | JSON Object | 预留功能信息,键值对格式 | 否 | ||||||||||||
| |||||||||||||||
data | JSON Object | 是 | |||||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "MSERV",
"subtype": "INPUT",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": "2345678901234"
},
"extData": {
"occurredAt": 1652433712899
},
"data": {
"packetId": 3,
"code": "serv_code",
"kv": {
"numberKey": "12",
"boolKey": false
}
}
}
备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。
设备定位-查询定位信息
发送的设备定位下行数据。
字段 | 类型 | 备注 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | |||||||||
deviceKey | String | DK | |||||||||
type | Enum | LOCATION | |||||||||
subtype | Enum | QUERY | |||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | |||||||||
ticket | String | 消息识别码 | |||||||||
data | JSON Object | ||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "LOCATION",
"subtype": "QUERY",
"createdAt": 1609316592000,
"data": {
"packetId": 1,
"keys": []
}
}
设备定位-原始数据
设备上报的基于NMEA协议的定位数据。
字段 | 类型 | 备注 | 是否必选 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | ||||||||||
deviceKey | String | DK | ||||||||||
type | Enum | LOCATION | ||||||||||
subtype | Enum | INFO-RAW | ||||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | ||||||||||
ticket | String | 消息识别码 | ||||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||
| ||||||||||||
data | JSON Object | |||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "LOCATION",
"subtype": "INFO-RAW",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p12344",
"deviceKey": "1234567891"
},
"data": {
"packetId": 5,
"raw": [
"$GNGGA,095528.000,2318.1133,N,11319.7210,E,1,06,3.7,55.1,M,-5.4,M,,0000*69",
"$BDGGA,062938.00,3110.4700719,N,12123.2657056,E,1,25,0.6,58.9666,M,0.000,M,99,AAAA*4"
]
}
}
设备定位信息
设备上报的NMEA协议经过平台解析后的定位数据。
设备定位数据支持GPS与LBS两种方式,默认仅支持GPS定位数据推送,若希望推送LBS定位数据,请联系商务。
如果返回为数组,则以多条 INFO-KV 发送。
字段 | 类型 | 备注 | 是否必选 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
productKey | String | PK | ||||||||||||||||
deviceKey | String | DK | ||||||||||||||||
type | Enum | LOCATION | ||||||||||||||||
subtype | Enum | INFO-KV 上报原始/非原始 | ||||||||||||||||
createdAt | Long | 消息生成的时间戳,整型,单位毫秒 | ||||||||||||||||
ticket | String | 消息识别码 | ||||||||||||||||
gateway | JSON Object | 网关信息 | 否 | |||||||||||||||
| ||||||||||||||||||
data | JSON Object | |||||||||||||||||
|
样例:
{
"ticket": "5f9924d171977c33bc5ad1b1",
"productKey": "p111KY",
"deviceKey": "1234567890123",
"type": "LOCATION",
"subtype": "INFO-KV",
"createdAt": 1609316592000,
"gateway": {
"productKey": "p111KY",
"deviceKey": "1234567891"
},
"data": {
"packetId": 5,
"type": "GP/LBS",
"subType": "BD(GGA)/LBS",
"kv": {
"satellites": "40", //当前卫星数
"ggaStatus": "4",//定位质量指标 gga数据独有
"lat": "3959.6107085", //纬度(度分格式ddmm.mmmmmmm)
"lng": "11619.6423341", //经度(度分格式ddmm.mmmmmmm)
"wgs_84": {
"lat": 39.99351180833333, //纬度(度为单位)
"lng": 116.32737223500001 //经度(度为单位)
},
"gcj_02": {
"lat": 39.994825423430167, //纬度(度为单位)
"lng": 116.33351545721269 //经度(度为单位)
},
"bd_09": {
"lat": 40.00050264255087, //纬度(度为单位)
"lng": 116.340146904483 //经度(度为单位)
},
"latType": "N/S", //N-北纬;S-南纬;
"lngType": "W/E", //W-西经;E-东经;
"hdop": "0.4", //水平精度因子
"accuracy": "550", //精度,lbs数据独有
"locateTime": 1609316592000, //定位时间(UTC时间)
"height": "66.7717" //海拔高度(米为单位)
}
}
}
产品信息变更
产品的信息变更消息,包括产品的创建、修改、删除信息。
字段 | 名称 | 字段类型 | 是否必填 | 备注 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | 事件类型 | String | 是 | 固定为: META_EVENT | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subtype | 操作对象类型 | String | 是 | 固定为: PRODUCT,表示对产品的操作 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
operation | 操作 | String | 是 | ADD: 添加 UPDATE: 修改 DELETE: 删除 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
productKey | 产品PK | String | 是 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | 操作时间戳 | Long | 是 | 操作时间戳(单位: 毫秒) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | JSON Object | 是 | 产品详细信息 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
产品 添加/删除
|
新增产品 样例:
{
"type": "META_EVENT",
"subtype": "PRODUCT",
"operation": "ADD",
"createdAt": 1616375484482,
"operator": 1,
"operatorType": 1,
"productKey": "p00001",
"data": {
"productName": "产品样例",
"productType": 0,
"accessType": 1,
"netWay": "1",
"dataFmt": 1,
"protocol": 1,
"logoPath": "https://xxxx.com/abcdfg.jpeg",
"moduleType": null,
"moduleName": null,
"moduleId": null,
"allowedLimit": 3,
"productStatus": 0,
"projectId": 1,
"createTime": 1615787274000,
"updateTime": 1615789235000,
"itemCode": "anfang"
}
}
修改产品 样例:
{
"type": "META_EVENT",
"subtype": "PRODUCT",
"operation": "UPDATE",
"createdAt": 1616375484482,
"operator": 1,
"operatorType": 1,
"productKey": "p00001",
"data": {
"productName": {
"old": "修改前产品名称",
"new": "修改后产品名称"
}
}
}
产品授权信息
产品的授权信息变更,包括产品的授权和取消授权。
字段 | 名称 | 字段类型 | 是否必填 | 备注 | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | 事件类型 | String | 是 | 固定为: META_EVENT | |||||||||||||||||||||||||||||||||||||||||||||||||||
subtype | 操作对象类型 | String | 是 | 固定为: GRANT_AUTHORIZED,表示对产品授权相关的操作 | |||||||||||||||||||||||||||||||||||||||||||||||||||
operation | 操作 | String | 是 | AUTH: 授权 CANCEL_AUTH: 取消授权 | |||||||||||||||||||||||||||||||||||||||||||||||||||
productKey | 产品PK | String | 是 | ||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | 操作时间戳 | Long | 是 | 操作时间戳(单位: 毫秒) | |||||||||||||||||||||||||||||||||||||||||||||||||||
data | JSON Object | 是 | 产品授权信息 | ||||||||||||||||||||||||||||||||||||||||||||||||||||
产品 授权/取消授权
|
产品授权样例:
{
"createdAt": 1665280943221,
"data": {
"moduleType": null,
"dataFmt": 3,
"itemCode": "socket",
"logoPath": null,
"moduleName": null,
"netWay": "2",
"productStatus": 0,
"allowedLimit": 100,
"updateTime": 1665286595000,
"productName": "插座",
"accessType": 0,
"protocol": null,
"createTime": 1665285584000,
"moduleId": null,
"projectId": 11338,
"productType": 0
},
"operation": "AUTH",
"productKey": "p119Cx",
"subtype": "GRANT_AUTHORIZED",
"type": "META_EVENT"
}
用户域(App)授权信息
用户域(App)的授权信息变更,包括用户域(App)的授权和取消授权。
字段 | 名称 | 字段类型 | 是否必填 | 备注 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
type | 事件类型 | String | 是 | 固定为:META_EVENT | ||||||
subtype | 操作对象类型 | String | 是 | 固定为:GRANT_USER_DOMAIN | ||||||
operation | 操作 | String | 是 | AUTH: 授权 CANCEL_AUTH: 取消授权 | ||||||
userDomain | 用户域 | String | 是 | |||||||
userDomainId | 用户域Id | Long | 是 | |||||||
createdAt | 操作时间戳 | Long | 是 | 操作时间戳(单位: 毫秒) | ||||||
data | JSON Object | 是 | App相关信息 | |||||||
|
{
"type": "META_EVENT",
"subtype": "GRANT_USER_DOMAIN",
"operation": "AUTH",
"userDomain": "C.DM.5503.34",
"userDomainId": 12345645656456,
"createdAt": 1665280943221,
"data": {
"appName": "test"
}
}
物模型发布信息变更
新发布的物模型信息。
字段 | 名称 | 字段类型 | 是否必填 | 备注 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
subtype | 操作对象类型 | String | 是 | 固定为THING_MODEL,表示对物模型相关的操作 | ||||||
operation | 操作类型 | String | 是 | RELEASE:发布 | ||||||
productKey | 产品PK | String | 是 | |||||||
createdAt | 操作时间戳 | Long | 是 | 操作时间戳,单位毫秒 | ||||||
type | 事件类型 | String | 是 | 固定为: META_EVENT | ||||||
data | JSON Object | 是 | ||||||||
|
样例:
{
"type": "META_EVENT",
"subtype": "THING_MODEL",
"operation": "RELEASE",
"productKey": "p11374",
"operator": 26984,
"operatorType": 1,
"createdAt": 1616375484482,
"data": {
"tslJson": {
"profile": {
"version": "20210406093313373",
"productKey": "p1137H"
},
"properties": [
{
"code": "202104011545",
"dataType": "BOOL",
"desc": "",
"id": 1,
"name": "202104011545",
"specs": [
{
"dataType": "BOOL",
"name": "TRUE",
"value": "true"
},
{
"dataType": "BOOL",
"name": "FALSE",
"value": "false"
}
],
"subType": "RW",
"type": "PROPERTY"
},
{
"code": "202104011700",
"dataType": "DOUBLE",
"desc": "",
"id": 2,
"name": "202104011700",
"specs": {
"max": "2",
"min": "1",
"step": "1",
"unit": "°"
},
"subType": "RW",
"type": "PROPERTY"
},
{
"code": "202104011501",
"dataType": "TEXT",
"desc": "",
"id": 3,
"name": "202104011501",
"specs": {
"length": 123
},
"subType": "RW",
"type": "PROPERTY"
}
]
}
}
}
终端用户信息变更
终端用户变更信息,包括终端用户的创建、修改和删除信息。
终端用户信息变更需要通过OpenAPI创建终端用户订阅。
字段 | 名称 | 字段类型 | 是否必填 | 备注 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | 类型 | String | 是 | 固定为ENDUSER | ||||||||||||||||||||||||
subtype | 子类型 | String | 是 | USER-ADD: 添加 USER-UPDATE: 修改 USER-DELETE: 删除 | ||||||||||||||||||||||||
ticket | 消息识别码 | String | 是 | 消息唯一识别码 | ||||||||||||||||||||||||
createdAt | 创建时间 | Long | 是 | 操作时间戳,单位毫秒 | ||||||||||||||||||||||||
data | JSON Object | 是 | ||||||||||||||||||||||||||
|
样例:
{
"ticket": "b18be821-5045-4467-801d-ca68c302dc3d",
"type": "ENDUSER",
"subtype": "USER-DELETE",
"createdAt": 1642471712433,
"data": {
"endUserId": "C1",
"endUserDomain": "C.DM.1.15"
}
}
规则引擎事件
规则引擎推送信息。
字段 | 名称 | 字段类型 | 是否必填 | 备注 | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | 类型 | String | 是 | 固定为CEP_RULE | ||||||||||||||||||||||||||||||||||||||
subtype | 子类型 | String | 是 | 固定为NOTICE | ||||||||||||||||||||||||||||||||||||||
traceId | 执行动作轨迹ID | String | 是 | 执行动作轨迹ID | ||||||||||||||||||||||||||||||||||||||
createdAt | 创建时间 | Long | 是 | 操作时间戳,单位毫秒 | ||||||||||||||||||||||||||||||||||||||
data | JSON Object | 是 | ||||||||||||||||||||||||||||||||||||||||
|
样例:
{
"traceId": "1228299096116822016",
"type": "CEP_RULE",
"subtype": "NOTICE",
"createdAt": 1713249972992,
"data": {
"extra": "{\"key\",\"value\"}",
"raw": {
"ticket": "1228217775206039552",
"productKey": "p113C1",
"deviceKey": "8686202300000001",
"type": "MATTR",
"createdAt": 1713249972997,
"attrs": {
"kv": {
"Temperature": 50,
"struct": {
"date": 1690449531456
},
"array_int": [1],
"array_struct": [
{
"date": "1690449531456"
}
]
}
},
"events": [
{
"code": "BatteryWarning",
"kv": {
"Temperature": 50,
"struct": {
"date": 1690449531456
},
"array_int": [1],
"array_struct": [
{
"date": "1690449531456"
}
]
}
}
]
}
}
}