跳至主要內容

设备mqtt上送协议

大约 8 分钟

设备mqtt上送协议

mqtt服务器信息

地址mqtt.xjpmf.cloud:1883
账号******
密码******

mqtt格式协议

Topic权限说明
/sys/${yourSn}/iot/post发布上行通信：设备通过该Topic向物联网平台上报属性数据。
/sys/${yourSn}/iot/post_reply订阅下行通信：设备通过订阅该Topic，获取物联平台响应设备属性上报的消息
/sys/${yourSn}/iot/event/post发布上行通信：设备通过该Topic向物联网平台上报事件数据。
/sys/${yourSn}/iot/event/post_reply订阅下行通信：设备通过订阅该Topic，获取物联平台响应设备事件上报的消息
/sys/${yourSn}/iot/service/property/set订阅下行通信：设备通过该订阅Topic，获取物联网平台下发的消息
/sys/${yourSn}/iot/service/property/set_reply发布上行通信:设备通过该Topic向物联网平台响应物联网平台下发的消息
/ota/device/upgrade/$订阅下行通讯:设备通过该订阅Topic，获取物联平台下发的消息

设备上报数据

请求

Topic

/sys/${yourSn}/iot/post

数据格式

{
  "id": "123",
  "version": "1.0",
  "sn": "24343",
  "sys": {
    "ack": 0
  },
  "time": 3333,
  "params": {
    "pfn": 333
  }
}

请求参数说明

参数类型说明
idstring消息ID号。String类型的数字，取值范围0~4294967295，且每个消息ID在当前设备中具有唯一性。
versionstring协议版本号，目前协议版本号唯一取值为1.0。
sysObject扩展功能的参数，其下包含各功能字段
ackIntegersys下的扩展功能字段，表示是否返回响应数据。1：云端返回响应数据。0：云端不返回响应数据。
paramsObject请求参数。如以上示例中，设备上报了的一个属性 pfn（电度值）的信息。具体属性信息params示例如下 "params": { "pfn": 33.2, "power": 23.6 }

响应

Topic

/sys/${yourSn}/iot/post_reply

数据格式

{
    "code": 200, 
     "data": {

     },
    "id": "123",
    "message": "success",
    "version": "1.0"
}

响应参数说明

参数类型说明
idstring返回的时候 将请求的id值原样返回
codeInteger结果状态码.详情请查看设备端通用code
dataObject请求成功时，返回的数据固定为空。
messageString返回结果信息。请求成功时，返回success。
versionstring协议版本号，目前协议版本号唯一取值为1.0。

设备上报事件

请求

Topic

/sys/${yourSn}/iot/event/post

数据格式

{
  "id": "123",
  "version": "1.0",
  "sn":"24343",
  "sys":{
    "ack":1
  },
  "time":1211233333,
  "params": {
    "Ia": "1",
  }
}

请求参数说明

参数类型说明
idstring消息ID号。String类型的数字，取值范围0~4294967295，且每个消息ID在当前设备中具有唯一性。
versionstring协议版本号，目前协议版本号唯一取值为1.0。
sysObject扩展功能的参数，其下包含各功能字段
ackIntegersys下的扩展功能字段，表示是否返回响应数据。1：云端返回响应数据。0：云端不返回响应数据。
paramsObject事件参数。
Iastring事件code。可自定义code，可在平台配置code的映射表
timeLong设备上报数据的时间戳，单位为毫秒。

响应

Topic

/sys/${yourSn}/iot/event/post_reply

数据格式

{
  "code": 200,
  "data": {},
  "id": "123",
  "message": "success",
  "version": "1.0"
}

设备上传日志

设备接收订阅云端推送日志配置

请求 Topic

/sys/${yourSn}/config/log/push

数据格式

{
    "id":"123",
    "sn":"1323",
    "version":"1.0",
    "params" :{ 
        "getType":"content",
        "content":{
            "mode":0
        }
    }
}

请求参数说明

参数类型说明
idstring消息ID号。String类型的数字，取值范围0~4294967295，且每个消息ID在当前设备中具有唯一性。
versionstring协议版本号，目前协议版本号唯一取值为1.0。
snstring设备sn
getTypestring获取内容类型，默认为content。因日志配置内容较少，默认直接返回内容。
contentstring配置文本内容
modeinteger设备日志上报模式，0表示设备SDK不上报日志，1表示设备SDK上报日志。

响应Topic

/sys/${yourSn}/config/log/push_reply

数据格式

{
    "id":"123",
   "code": 200,
   "data": {}
}

响应参数说明

参数类型说明
idstring消息ID号。String类型的数字，取值范围0~4294967295，且每个消息ID在当前设备中具有唯一性。
codeInteger结果状态码.详情请查看设备端通用code
dataObject请求成功时，返回的数据固定为空。

设备上传日志内容

请求

Topic

/sys/${yourSn}/log/post

数据格式

{
  "id": "123",
  "version": "1.0",
  "sys": {
    "ack": 0
  },
  "sn": "2323",
  "params": {
    "time": 1234561111,
    "logLevel": "ERROR",
    "code": "4103",
    "logContent": "some log content"
  }
}

请求参数说明

参数类型说明
idstring消息ID号。String类型的数字，取值范围0~4294967295，且每个消息ID在当前设备中具有唯一性。
versionstring协议版本号，目前协议版本号唯一取值为1.0。
sysObject扩展功能的参数，其下包含各功能字段
ackIntegersys下的扩展功能字段，表示是否返回响应数据。1：云端返回响应数据。0：云端不返回响应数据。
paramsObject设备上报的属性参数。
timeLong设备上报数据的时间戳，单位为毫秒。
logLevelLong日志级别。可以使用默认日志级别，也可以自定义日志级别。默认日志级别从高到低为： FATAL， ERROR，WARN，INFO，DEBUG
codestring日志级别。 用户自定义的状态码。
logContentstring日志级别。 用户自定义的状态码。

响应

Topic

/sys/${yourSn}/iot/log/post_reply

数据格式

{
  "id" : "123",
  "code":200,
  "data" : {}
}

响应参数说明

参数类型说明
idstring消息ID号。String类型的数字，取值范围0~4294967295，且每个消息ID在当前设备中具有唯一性。
codeInteger结果状态码.详情请查看设备端通用code
dataObject请求成功时，返回的数据固定为空。

云平台下发数据

请求

Topic

/sys/${yourSn}/iot/service/property/set

数据格式

{
  "id": "123",
  "version": "1.0",
  "sn":"24343",
  "sys":{
    "ack":0
  },
  "time":1211233333,
  "params": {
    "switch_status": 1
  }
}

请求参数说明

参数类型说明
idstring消息ID号。String类型的数字，取值范围0~4294967295，且每个消息ID在当前设备中具有唯一性。
versionstring协议版本号，目前协议版本号唯一取值为1.0。
sysObject扩展功能的参数，其下包含各功能字段
ackIntegersys下的扩展功能字段，表示是否返回响应数据。1：云端返回响应数据。0：云端不返回响应数据。
paramsObject属性设置参数。如以上示例中，设置属性：{ "switch_status": 1 }。如果是自定义模块属性，属性标识符格式为${模块标识符}:${属性标识符}（中间为英文冒号），例如{ "switch_status": 1 }。
timeLong设备上报数据的时间戳，单位为毫秒。

响应

Topic

/sys/${yourSn}/iot/service/property/set_reply

数据格式

{
  "code": 200,
  "data": {},
  "id": "123",
  "message": "success",
  "version": "1.0"
}

响应参数说明

参数类型说明
idstring返回的时候 将请求的id值原样返回
codeInteger结果状态码.详情请查看设备端通用code
dataObject请求成功时，返回的数据固定为空。
messageString返回结果信息。请求成功时，返回success。
versionstring协议版本号，与请求参数中version相同。

远程OTA升级

升级步骤

步骤说明topic
1(可选）上报设备OTA模块当前版本/ota/device/inform/$
2通过平台添加升级包，对设备发送OTA升级请求/ota/device/upgrade/$
3(可选)设备端上报升级进度信息/ota/device/progress/$
4设备端完成OTA升级后，上报最新版本/ota/device/inform/$

上报设备OTA模块当前版本

Topic

/ota/device/inform/${yourSn}

数据格式

{
  "id":"123",
  "sn":"1213",
  "params":{
    "version":"1.0.1"
  }
}

请求参数说明

参数类型说明
idstring消息ID号。String类型的数字，取值范围0~4294967295，且每个消息ID在当前设备中具有唯一性。
snstring设备唯一标识。
paramsObject扩展功能的参数，其下包含各功能字段。。
versionstringota模块版本

平台下发升级包给设备端

Topic

/ota/device/upgrade/${yourSn}

数据格式

{

  "id": "123",

  "code": 200,

  "data": {

    "size": 93796291,

    "sign": "f8d85b250d4d787a9f483d89a974***",

    "version": "10.0.1.9.20171112.1432",

    "isDiff": 1,

    "url": "https://xjpmf",

    "signMethod": "MD5",

    "md5": "f8d85b250d4d787a9f48***",

    "extData":{

      "key1":"value1",

      "key2":"value2",
    }
  }
}

请求参数说明

参数类型说明
idstring消息ID号。String类型的数字，取值范围0~4294967295，且每个消息ID在当前设备中具有唯一性。
codeint状态码。
dataObject扩展功能的参数，其下包含各功能字段。。
sizeint文件大小
versionstring"1.0.2" 设备版本号
isDiffInt是否差分升级 1 为差分
urlstring程序下载地址
signMethodstring加密方法
md5stringmd5值
Signstring加密结果
extDataObject扩展字段 保留

设备上传进度(可选)

Topic

/ota/device/progress/${yourSn}

数据格式

{

  "id": "123",

  "params": {

    "step": "-1",

    "desc": "OTA升级失败，请求不到升级包信息。",

  }
}

请求参数说明

参数类型说明
idstring消息ID号 原样返回平台下发消息Id
paramsobject参数
stepstringOTA升级进度。 取值范围： 1~100的整数：升级进度百分比。 -1：升级失败。 -2：下载失败。 -3：校验失败。 -4：烧写失败。
descstring当前步骤的描述信息，长度不超过128个字符。如果发生异常，此字段可承载错误信息。

设备端通用code

错误码消息描述
200success成功
400request error请求参数错误
460request parameter error请求参数错误，设备入参效验失败
429too many requests请求过于频繁，设备端处理不过来的时候可以使用
100000-110000自定义消息错误
许昌智能