encode接口说明

更新时间：2022-02-21 GMT+08:00

查看PDF

encode接口的入参json格式数据，是平台下发的命令或应答。

平台的下行报文可以分为两种情况：平台命令下发、平台对设备上报数据的应答（对应下图中的消息②和③）。两种情况下编码输出的字段不同。

图1 下行报文

表1 平台下发命令encode接口的入参结构定义
字段名	类型	参数描述	是否必填
identifier	String	设备在应用协议里的标识，IoT平台通过decode接口解析码流时获取该参数，通过encode接口编码时将该参数放入码流。	否
msgType	String	固定值"cloudReq"，表示平台下发的请求。	是
serviceId	String	服务的id。	是
cmd	String	服务的命令名，参见profile的服务命令定义。	是
paras	ObjectNode	命令的参数，具体字段由profile定义。	是
hasMore	Int	表示平台是否还有后续命令下发，0表示没有，1表示有。后续命令是指，平台还有待下发的消息，以hasMore字段告知设备不要休眠。hasMore字段仅在PSM模式下生效，且需要“下行消息指示”开启。	是
mid	Int	2字节无符号的命令id，由IoT平台内部分配（范围1-65535）。 IoT平台在通过encode接口下发命令时，把IoT平台分配的mid放入码流，和命令一起下发给设备；设备在上报命令执行结果（deviceRsp）时，再将此mid返回IoT平台。否则IoT平台无法将下发命令和命令执行结果（deviceRsp）进行关联，也就无法根据命令执行结果（deviceRsp）更新命令下发的状态（成功或失败）。	是

示例：

{
    "identifier": "123",
    "msgType": "cloudReq",
    "serviceId": "NBWaterMeterCommon",
    "mid": 2016,
    "cmd": "SET_TEMPERATURE_READ_PERIOD",
    "paras": {
        "value": 4
    },
    "hasMore": 0}
}

表2 平台收到设备的上报数据后对设备的应答encode接口的入参结构定义
字段名	类型	参数描述	是否必填
identifier	String	设备在应用协议里的标识，IoT平台通过decode接口解析码流时获取该参数，通过encode接口编码时将该参数放入码流。	否
msgType	String	固定值"cloudRsp"，表示平台收到设备的数据后对设备的应答。	是
request	byte[]	设备上报的数据。	是
errcode	int	请求处理的结果码，IoT平台根据该参数判断命令下发的状态。 0表示成功，1表示失败。	是
hasMore	int	表示平台是否还有后续消息下发，0表示没有，1表示有。后续消息是指，平台还有待下发的消息，以hasMore字段告知设备不要休眠。hasMore字段仅在PSM模式下生效，且需要“下行消息指示”开启。	是

说明：

在cloudRsp场景下编解码插件检测工具显示返回null时，表示插件未定义上报数据的应答，设备侧不需要IoT平台给予响应。

示例：

{
    "identifier": "123",
    "msgType": "cloudRsp",
    "request": [
        1,
        2
    ],
    "errcode": 0,
    "hasMore": 0
}

父主题： 参考信息

上一篇：decode接口说明

下一篇：getManufacturerId接口说明

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

encode接口说明

意见反馈

文档内容是否对您有帮助？

文档反馈