2022华为物联网平台设备接入用户指南

物联网平台设备接入用户指南文档版本1.47发布日期2022-06-25设备接入用户指南设备接入用户指南1.47(2022-06-25)1.47(2022-06-25)PAGE\*roman 目录概述 1设备接入 3原生协议接入 3设备鉴权 3MQTT/MQTTS协议接入 6使用前必读 6设备日志收集 7平台下发日志收集通知 7设备上报日志内容 8设备信息上报 10设备信息上报 10设备时间同步 11设备时间同步请求 11设备时间同步响应 12文件上传/下载管理 13设备上报获取文件上传URL请求 13平台下发文件上传临时URL 15设备上报文件上传结果 16设备上报获取文件下载URL请求 17平台下发文件下载临时URL 19设备上报文件下载结果 20软固件升级 21平台下发获取版本信息通知 21设备上报软固件版本 22平台下发升级通知 24设备上报升级状态 26网关与子设备管理 28平台通知网关子设备新增 28平台通知网关子设备删除 30网关同步子设备列表 32网关更新子设备状态 33网关上报获取平台产品信息消息 34平台下发产品信息响应消息 35平台下发启动子设备扫描通知 37网关上报子设备列表信息 38网关新增子设备请求 40网关新增子设备请求响应 42网关删除子设备请求 44网关删除子设备请求响应 45网关更新子设备请求 47网关更新子设备请求响应 49设备属性 51设备属性上报 51网关批量设备属性上报 52平台设置设备属性 54平台查询设备属性 56设备侧获取平台的设备影子数据 57设备消息 59设备消息上报 59平台消息下发 60设备命令 61平台命令下发 61设备连接鉴权 63定义 64通信方式概述 66HTTPS协议接入 67使用https协议接入 67API概览 70设备鉴权 70设备鉴权 70设备消息上报 72设备消息上报 72设备属性上报 74设备属性上报 74网关上报子设备属性 76设备管理 80创建产品 80产品模型 81注册设备 83注册单个设备 83批量注册设备 85注册X.509证书认证的设备 87管理设备 91群组与标签 94设备影子 96固件升级 101软件升级 108升级指导 108设备侧适配开发指导 114PCP协议介绍 132文件上传 138网关与子设备 140消息通信 1444.1概述 144自定义通信 145数据上报 147编解码插件 148命令下发 150命令下发机制 151LwM2M/CoAP设备命令下发 151MQTT设备命令/属性/消息下发 157订阅推送 163订阅推送方式概述 163使用HTTP/HTTPS订阅推送 164使用AMQP订阅推送 170AMQP订阅推送 170配置AMQP服务端订阅 172AMQP客户端接入说明 174JavaSDK接入示例 176Node.jsSDK接入示例 182C#SDK接入示例 182AndroidSDK接入示例 186规则引擎 187规则引擎介绍 187数据转发 188设备联动 192SQL语句 195连通性测试 198监控运维 200设备消息跟踪 200查看报表 202告警管理 203查看审计日志 204查看运行日志 206存储管理 211资源空间 214IoTDA实例 216实例介绍 216购买实例 217实例管理 220实例规格升配 220切换实例类型 221实例续费/实例退订 222修改企业版实例信息 222设置企业版实例公网访问 223设置企业版实例专线访问 223权限管理 225创建IAM用户并授权使用IoTDA. 225创建IoTDA自定义策略 226设备发放 229从这里开始 22911.2证书 230制作CA证书 232上传CA证书 233验证CA证书 234更新CA证书 235删除CA证书 23611.3策略 236自定义策略 236创建自定义策略函数 236添加自定义策略实例 244证书策略 245静态策略 24611.4设备 24711.4.1注册设备 24711.4.2注册组 25211.5设备数据迁移 252设备接入用户指南1概述设备接入用户指南1概述1.47(2022-06-25)1.47(2022-06-25)PAGE 1概述物联网平台提供海量设备的接入和管理能力，配合华为云其他产品同时使用，帮助快速构筑物联网应用，简化海量设备管理复杂性，节省人工操作，提升管理效率。使用设备接入控制台，可以实现对产品的创建、开发、调试，设备的注册、管理、鉴权、软固件升级。在设备接入控制台，可以创建规则引擎，满足用户实现设备联动和数据转发的需求；还可以存储产品和设备数据及生成相应统计报表，方便用户监控设备的各种状态。功能简介产品某一类具有相同能力或特征的设备的集合称为一款产品。您可以基于控制台快速进行产品模型和插件的开发，同时提供在线调试、自定义Topic等多种能力，端到端指引物联网开发，帮助开发者提升集成开发效率、缩短物联网解决方案建设周期。产品模型又称Profile，用于定义一款接入设备所具备的属性（集的数据、可识别的指令或者设备上报的事件等信息）。产品模型可以在设备接入控制台进行无码化开发。设备归属于某个产品下的设备实体，每个设备具有一个唯一的标识码。设备可以是直连物联网平台的设备，也可以是代理子设备连接物联网平台的网关。设备鉴权设备接入物联网平台时，需要对接入平台的设备进行鉴权认证。目前华为物联网平台支持设备使用密钥和X.509两种方式进行鉴权认证。待平台验证通过，设备成功连接到物联网平台后，就可以进行数据通信。群组与标群组是一系列设备的集合，用户可以对资源空间下所有设备，根据区签域、类型等不同规则进行分类建立群组，以便处理对海量设备的批量管理和操作。物联网平台支持定义不同的标签，并对设备打标签。软固件升级用户可以通过的方式对LwM2M协议和MQTT件升级。设备影子设备影子是一个JSON文件，用于存储设备的在线状态、设备最近一次上报的设备属性、应用服务器期望下发的配置。每个设备有且只有一个设备影子，设备可以获取和设置设备影子以此来同步状态，这个同步可以是影子同步给设备，也可以是设备同步给影子。功能简介网关与子设备物联网平台支持设备直连，也支持设备挂载在网关上，作为网关的子设备，由网关直连，通过网关进行数据转发。规则引擎用户可以在物联网平台上对接入平台的设备设定相应的规则，在条件满足所设定的规则后，平台会触发相应的动作来满足用户需求。包含设备联动和数据转发两种类型。存储管理设备接入控制台集成了IoT数据分析的存储管理服务，用户可以免费存储设备上报到平台的历史数据。监控运维提供查看统计报表、在线调试、消息跟踪、当前告警、运行日志等监控运维功能。用户可以使用这些功能，监控设备运行状态、设备消息通讯、用户操作，快速追查定位故障，保障设备的可靠性及安全性。资源空间可以理解为在物联网平台中为您的业务划分的一个资源空间，您在平台中创建的资源（如产品、设备等）都需要归属到某个资源空间，您可以基于资源空间实现多业务应用的分域管理。IoTDA实例版（原共享实例）、标准版（标准实例）、企业版（专享实例）产品形态。您可以可以根据企业业务场景、设备规模和数据采集频率，购买最合适的实例类型和实例规格。数据上报义上的业务逻辑进行数据采集和上报，可以是基于周期或者事件触发。订阅推送订阅：是指应用服务器通过调用物联网平台的API接口，向平台获取发生变更的设备业务信息（如设备生命周期管理、设备数据上报、设备消息状态、设备状态等）和管理信息（软固件升级状态和升级结果）。推送：是指订阅成功后，物联网平台根据应用服务器订阅的数据类型，将对应的变更信息推送给指定的URL地址或AMQP消息队列。命令下发为能有效地对设备进行管理，设备的产品模型中定义了物联网平台可向设备下发的命令，应用服务器可以调用物联网平台开放的API接口向设备下发命令，以实现对设备的远程控制。使用限制

为保证良好的显示效果和易用性体验，请使用兼容性良好的浏览器，对于浏览器的要求如下：浏览器类型版本要求分辨率MicrosoftEdge支持和测试最新的3个稳定版本。推荐1366x768分辨率Firefox支持和测试最新的3个稳定版本。GoogleChrome支持和测试最新的3个稳定版本。设备接入用户指南2设备接入设备接入用户指南2设备接入1.47(2022-06-25)1.47(2022-06-25)PAGE 2设备接入原生协议接入设备鉴权概述设备鉴权是指物联网平台对接入平台的设备进行身份认证。对于不同接入方式的设备，鉴权方式不同。接入类型鉴权方式使用LwM2M/CoAP在设备接入物联网平台前，用户通过应用服务器调用创建设协议接入的设备备接口或通过控制台在物联网平台注册设备。若为非安全设备，在设备接入物联网平台时携带设备唯一标识，完成设备的接入鉴权；当采用DTLS/DTLS+传输层安全协议接入时，即设备为安全设备时，携带密钥和nodeId完成设备的接入鉴权。如图所示。使用原生MQTT/MQTTS协议接入的设备使用密钥鉴权：在设备接入物联网平台前，用户通过应用服务调用创建设备接口或通过控制台在物联网平台注册设备，获取设备ID和密钥，并把设备ID和密钥烧录到设备中。针对MQTTS协议的设备，需要在设备侧预置CA证书；MQTT不需要，然后在设备接入物联网平台时携带设备ID和密钥，完成设备的接入鉴权。如图所示。使用证书鉴权：在设备接入物联网平台前，用户通过控制台上传设备CA证书，然后应用服务调用创建设备接口或通过控制台在物联网平台注册设备，获取设备ID，并把设备ID烧录到设备中。在设备接入物联网平台时携带设备侧X.509证书，完成设备的接入鉴权。如图所示。使用LwM2M/CoAP协议接入的鉴权流程通过调用注册接口向物联网平台发送注册请求或者在控制台上注册设备。2~3.物联网平台向设备分配密钥，并返回timeout。说明密钥可以在注册设备时自定义，如果没有定义，平台将自动分配预置密钥。timeout信息。用户将密钥烧录到设备硬件或软固件中。nodeId（如IMEI）和密钥发起接入鉴权请求；非安全设备携带设备唯一标识码发起接入鉴权请求。6~7.平台验证通过后，返回成功响应，设备连接物联网平台成功。使用原生MQTT/MQTTS协议接入的鉴权流程通过调用注册接口向物联网平台发送注册请求或者在控制台上注册设备。说明注册时需要填写设备标识码，通常使用MAC地址，SerialNo或IMEI作为nodeId。物联网平台向设备分配全局唯一的设备ID（deviceId）和密钥（secret）。说明密钥可以在注册设备时自定义，如果没有定义，平台将自动分配密钥。用户将设备ID（deviceId）和密钥（secret）烧录到设备硬件或软固件中。（仅针对MQTTS协议接入的鉴权流程）设备侧需集成预置CA证书。设备上电后，携带设备ID（deviceId）和密钥（secret）发起接入鉴权请求。平台验证通过后，返回成功响应，设备连接物联网平台成功。使用X.509证书的鉴权流程X.509证书是一种用于通信实体鉴别的数字证书。当前物联网平台只支持基于MQTT协议接入的设备使用X.509证书进行设备身份认证，且每个用户最多上传100个设备CA证书。在控制台上传设备CA证书。通过调用注册接口向物联网平台发送注册请求或者在控制台上注册设备。说明注册时需要填写设备标识码，通常使用MAC地址，SerialNo或IMEI作为nodeId。ID（deviceId）。烧录到设备硬件或软固件中。设备上电后，携带设备侧X.509证书发起接入鉴权请求。平台验证通过后，返回成功响应，设备连接物联网平台成功。相关API接口创建设备重置设备密钥获取设备CA证书列表上传设备CA证书删除设备CA证书验证设备CA证书协议接入使用前必读概述MQTT消息由固定报头（Fixedheader）、可变报头（Variableheader）和有效载荷（Payload）三部分组成。其中固定报头（Fixedheader）和可变报头（Variableheader）格式的填写请参考MQTT标准规范，有效载荷（Payload）的格式由应用定义，即设备和物联网平台之间自己定义。说明MQTT的语法和接口细节，请以MQTT标准规范为准。常见MQTT消息类型主要有CONNECT、SUBSCRIBE、PUBLISH。（Payload）的主要参数，参考设备连接鉴权填写。（Payload）name”，参考定义中订阅者为设备的。PUBLISH：平台发布消息。可变报头（Variableheader）name”，指设备上报到物联网平台时发布者为设备的。详细请参考定义。有效载荷（Payload）容，目前是一个JSON对象。使用限制

上行是指设备向平台发送请求，或上报数据，或回复响应。下行是指平台向设备下发指令，或回复响应。设备与平台建立连接后，需要订阅下行复的响应。应用侧接口的调用，需要设备侧的配合，例如应用侧下发命令，设备侧需要先订阅“平台命令下发”的下行下发命令的接口也会报超时。设备日志收集平台下发日志收集通知Topic

下行:$oc/devices/{device_id}/sys/events/down接口功能

用于平台下发日志收集通知给设备。参数说明

字段名必选/可选类型参数描述services可选List<EventService>事件服务列表EventService定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$logevent_type必选String系统字段，固定为：log_configevent_time可选String事件时间paras必选Object设备服务的事件列表，具体字段在设备关联的产品模型中定义。paras参数列表字段名必选/可选类型参数描述switch可选String设备侧日志收集开关on：开启设备侧日志收集功能offend_time可选String日志收集结束时间yyyy-MM-dd'T'HH:mm:ss'Z'Topic:$oc/devices/{device_id}/sys/events/down数据格式：{Topic:$oc/devices/{device_id}/sys/events/down数据格式：{"services":[{"service_id":"$log","event_type":"log_config","event_time":"20151212T121212Z","paras":{"switch":"on","end_time":"20151212T131212Z"}}]}设备上报日志内容Topic上行:$oc/devices/{device_id}/sys/events/up接口功能

日志收集开关开启时设备使用该接口向平台上报日志内容，最大不超过1MB。参数说明示例

字段名必选/可选类型参数描述services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$logevent_type必选String系统字段，固定为：log_reportevent_time可选String事件时间paras必选Object设备服务的事件列表，具体字段在设备关联的产品模型中定义。paras参数列表字段名必选/可选类型参数描述timestamp可选String日志产生时间type必选String日志类型：DEVICE_STATUS：设备状态DEVICE_PROPERTY：设备属性DEVICE_MESSAGE：设备消息DEVICE_COMMAND：设备命令content必选String日志内容。Topic:$oc/devices/{device_id}/sys/events/upTopic:$oc/devices/{device_id}/sys/events/up数据格式：{"services":[{"service_id":"$log","event_type":"log_report","event_time":"20151212T121212Z","paras":{"timestamp":"1235668997","type":"DEVICE_MESSAGE","content":"logcontent"}}]}设备信息上报.1设备信息上报功能描述

设备向平台上报设备信息。Topic

Topic:$oc/devices/{device_id}/sys/events/up参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$device_infoevent_type必选String系统字段，固定为：device_info_reportevent_time可选String事件时间paras可选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述device_sdk_version可选String格式为：接入方式_版本号，例如C_v0.5.0,JAVA_v0.5.0，TinySDK_1.0.0等sw_version可选String软件版本fw_version可选String固件版本Topic:$oc/devices/{device_id}/sys/events/up数据格式：{Topic:$oc/devices/{device_id}/sys/events/up数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$sdk_info","event_type":"sdk_info_report","event_time":"20151212T121212Z","paras":{"device_sdk_version":"C_v0.5.0""sw_version":"v1.0","fw_version":"v1.0"}}]}设备时间同步设备时间同步请求功能描述

设备向平台发起时间同步请求。Topic

Topic:$oc/devices/{device_id}/sys/events/up参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$time_syncevent_type必选String系统字段，固定为：time_sync_requestevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述device_send_time必选long设备发送时间，设备获取自己的当前时间戳，即从格林威治时间1970年01月01日00时00分00秒起至现在的毫秒数Topic:$oc/devices/{device_id}/sys/events/up数据格式：{Topic:$oc/devices/{device_id}/sys/events/up数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$time_sync","event_type":"time_sync_request","event_time":"20151212T121212Z","paras":{"device_send_time":1582685678789}}]}设备时间同步响应功能描述

平台向设备发送时间同步响应，携带设备发送时间device_send_time。当平台收到时间server_recv_time后，向设备发送时间server_send_time。例如，设备收到的设备侧时间为device_recv_time，则设备计算自己的准确时间为：(server_recv_time+server_send_time+device_recv_time-device_send_time)/2Topic

Topic:$oc/devices/{device_id}/sys/events/down参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$time_syncevent_type必选String系统字段，固定为：time_sync_responseevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述device_send_time必选long设备发送时间，设备获取自己的当前时间戳，即从格林威治时间1970年01月01日00时00分00秒起至现在的毫秒数server_recv_time必选long平台收到时间戳server_send_time必选long平台发送时间戳Topic:$oc/devices/{device_id}/sys/events/up数据格式：{Topic:$oc/devices/{device_id}/sys/events/up数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$time_sync","event_type":"time_sync_response","event_time":"20151212T121212Z","paras":{"device_send_time":1582685678789,"server_recv_time":1582685696152,"server_send_time":1582685708109}}]}文件上传/下载管理设备上报获取文件上传URL请求功能介绍

设备上报获取文件上传URL信息请求。Topic

Topic:$oc/devices/{device_id}/sys/events/up参数说明示例

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$file_managerevent_type必选String系统字段，固定为：get_upload_urlevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述file_name必选String待上传文件名称file_attributes可选Object文件属性，JSON格式的Object对象Topic:$oc/devices/{device_id}/sys/events/upTopic:$oc/devices/{device_id}/sys/events/up数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$file_manager","event_type":"get_upload_url","event_time":"20151212T121212Z","paras":{"file_name":"a.jpg","file_attributes":{"hash_code":"58059181f378062f9b446e884362a526","size":1024}}}]}]}平台下发文件上传临时URL功能介绍

平台下发文件上传临时URL。Topic

Topic:$oc/devices/{device_id}/sys/events/down参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$file_managerevent_type必选String系统字段，固定为：get_upload_url_responseevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述url必选String文件上传URLbucket_name可选StringOBS桶的名称object_name可选StringOBS待上传对象名称，与file_name一致expire可选IntegerURL过期时间，单位：秒字段名必选/可选类型参数描述file_attributes可选Object文件属性，JSON格式的Object对象Topic:$oc/devices/{device_id}/sys/events/down数据格式：{Topic:$oc/devices/{device_id}/sys/events/down数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$file_manager","event_type":"get_upload_url_response","event_time":"20151212T121212Z","paras":{"url":"/device_file/aGEKIpp5NAGxdP2oo90000/a.jpg?Expires=1553162075&OSSAccessKeyId=LTAIYLScbHiV****&Signature=%2F88xdEFPukJ****%2F8****%2Bdv3io%3D","bucket_name":"bucket","object_name":"c6b39067b0325db34663d3ef421a42f6_12345678_a.jpg","expire":3600,"file_attributes":{"hash_code":"58059181f378062f9b446e884362a526","size":1024}}}]}设备上报文件上传结果功能介绍

设备上报文件上传结果。Topic

Topic:$oc/devices/{device_id}/sys/events/up参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$file_managerevent_type必选String系统字段，固定为：upload_result_reportevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述object_name必选StringOBS上传对象名称result_code必选Integer设备上传文件状态，结果码定义如下：status_code可选Integer文件上传到OBS返回的状态码status_description可选String文件上传到OBS时状态的描述Topic:$oc/devices/{device_id}/sys/events/up数据格式：{Topic:$oc/devices/{device_id}/sys/events/up数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$file_manager","event_type":"upload_result_report","event_time":"20151212T121212Z","paras":{"object_name":"c6b39067b0325db34663d3ef421a42f6_12345678_a.jpg","result_code":0，"status_code":200,"status_description":"uploadsuccess"}}]}设备上报获取文件下载URL请求功能介绍Topic

URL信息请求到平台。$oc/devices/{device_id}/sys/events/up参数说明示例

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$file_managerevent_type必选String系统字段，固定为：get_download_urlevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述fileName必选String待下载文件名称file_attributes可选Object文件属性，JSON格式的Object对象Topic:$oc/devices/{device_id}/sys/events/upTopic:$oc/devices/{device_id}/sys/events/up数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$file_manager","event_type":"get_download_url","event_time":"20151212T121212Z","paras":{"file_name":"a.jpg","file_attributes":{"hash_code":"58059181f378062f9b446e884362a526","size":1024}}}]}平台下发文件下载临时URL功能介绍

平台下发文件下载临时URL给设备。Topic

Topic:$oc/devices/{device_id}/sys/events/down参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$file_managerevent_type必选String系统字段，固定为：get_download_url_responseevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述url必选String文件下载URLbucket_name可选StringOBS桶的名称object_name可选StringOBS待下载对象名称，与file_name一致expire可选IntegerURL过期时间，单位：秒file_attributes可选Object文件属性，JSON格式的Object对象Topic:$oc/devices/{device_id}/sys/events/down数据格式：{Topic:$oc/devices/{device_id}/sys/events/down数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$file_manager","event_type":"get_download_url_response","event_time":"20151212T121212Z","paras":{"url":"/device_file/aGEKIpp5NAGxdP2oo90000/a.jpg?Expires=1553162075&OSSAccessKeyId=LTAIYLScbHiV****&Signature=%2F88xdEFPukJ****%2F8****%2Bdv3io%3D","bucket_name":"bucket","object_name":"c6b39067b0325db34663d3ef421a42f6_12345678_a.jpg","expire":3600,"file_attributes":{"hash_code":"58059181f378062f9b446e884362a526","size":1024}}}]}设备上报文件下载结果功能描述

设备上报文件下载结果。Topic

Topic:$oc/devices/{device_id}/sys/events/up参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$file_managerevent_type必选String系统字段，固定为：download_result_reportevent_time可选String事件时间字段名必选/可选类型参数描述paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述object_name必选StringOBS下载对象名称result_code必选Integer设备下载文件状态，结果码定义如下：status_code可选Integer文件下载到OBS返回的状态码status_description可选String文件下载到OBS时状态的描述Topic:$oc/devices/{device_id}/sys/events/up数据格式：{Topic:$oc/devices/{device_id}/sys/events/up数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$file_manager","event_type":"download_result_report","event_time":"20151212T121212Z","paras":{"object_name":"c6b39067b0325db34663d3ef421a42f6_12345678_a.jpg","result_code":0，"status_code":200,"status_description":"downloadsuccess"}}]}软固件升级平台下发获取版本信息通知功能介绍

平台下发获取版本信息通知。Topic

下行:$oc/devices/{device_id}/sys/events/down参数说明示例

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$otaevent_type必选String系统字段，固定为：version_queryevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述Topic:$oc/devices/{device_id}/sys/events/downTopic:$oc/devices/{device_id}/sys/events/down数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$ota","event_type":"version_query","event_time":"20151212T121212Z","paras":{}}]}设备上报软固件版本功能介绍

设备上报软固件版本信息。Topic

上行:$oc/devices/{device_id}/sys/events/up参数说明示例

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$otaevent_type必选String系统字段，固定为：version_reportevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述sw_version可选String软件版本fw_version可选String固件版本Topic:$oc/devices/{device_id}/sys/events/upTopic:$oc/devices/{device_id}/sys/events/up数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$ota","event_type":"version_report","event_time":"20151212T121212Z","paras":{"sw_version":"v1.0","fw_version":"v1.0"}}]}平台下发升级通知功能介绍

物联网平台向设备侧下发升级通知。Topic

下行:$oc/devices/{device_id}/sys/events/down参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$otaevent_type必选String软固件保存在IoT平台，event_type的值如下：-固件升级：firmware_upgrade-软件升级：software_upgrade软固件保存在OBS，event_type的值如下：-固件升级：firmware_upgrade_v2-软件升级：software_upgrade_v2event_time可选String事件时间paras必选Object事件参数JSON对象event_type为firmware_upgrade、software_upgrade时paras参数列表字段名必选/可选类型参数描述version必选String软固件包版本号url必选String软固件包下载地址file_size必选Integer软固件包文件大小字段名必选/可选类型参数描述access_token可选String软固件包url下载地址的临时tokenexpires可选Integeraccess_token的超期时间sign必选String软固件包SHA-256值示例一

event_type为firmware_upgrade_v2、software_upgrade_v2时paras参数列表字段名必选/可选类型参数描述version必选String软固件包版本号url必选String软固件包下载地址(OBS地址)expires可选Integerurl的超期时间软固件保存在软固件保存在IoT平台,升级时设备会收到如下信息：Topic:$oc/devices/{device_id}/sys/events/down数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$ota","event_type":"firmware_upgrade","event_time":"20151212T121212Z","paras":{"version":"v1.2","url":":8943/iodm/inner/v1.3.0/firmwarefiles/ca1d954771ae61e5098c7f83","file_size":81362928,"access_token":"595124473f866b033dfa1f","expires":86400,"sign":"595124473f866b033dfa1f7e831c8c99a12f6143f392dfa996a819010842c99d"}}]}软固件保存在OBS中,软固件保存在OBS中,升级时设备会收到如下信息：Topic:$oc/devices/{device_id}/sys/events/down数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$ota","event_type":"firmware_upgrade_v2","event_time":"20151212T121212Z","paras":{"version":"v1.2","url":"https://******.:443/test.bin?AccessKeyId=DX5G7W*********","expires":3600}}]}设备侧升级包下载指导设备收到升级通知之后，通过HTTPS协议根据升级通知里面的URL下载升级包。基础版和标准版目前建议客户不校验证书可规避不能下载固件的问题。专享版如果需要校验证书，请提工单，后端帮忙配置域名。请求方法

下载升级包的请求方法为：GET请求消息头

附加请求消息头（header）字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。参数说明Content-Type消息体的媒体类型，默认取值为“application/json”。Authorization访问物联网平台的认证信息，值为“Bearer{access_token}”，其中{access_token}为收到的升级通知中的access_token。示例GET:8943/iodm/inner/v1.3.0/firmwarefiles/ca1d954771ae61e5098c7f83GET:8943/iodm/inner/v1.3.0/firmwarefiles/ca1d954771ae61e5098c7f83Content-Type:application/jsonAuthorization:Bearer****** 注意如果event_type为firmware_upgrade_v2、software_upgrade_v2，则在请求下载软固件包时不需要携带请求头。请求示例如下：GEThttps://******.:443/test.bin?AccessKeyId=DX5G7W*********设备上报升级状态功能介绍

设备上报升级状态。Topic

上行:$oc/devices/{device_id}/sys/events/up参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$otaevent_type必选String系统字段，固定为：upgrade_progress_reportevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述result_code必选Integer设备的升级状态，结果码定义如下：0：处理成功3：已经是最新版本4：电量不足5：剩余空间不足6：下载超时7：升级包校验失败8：升级包类型不支持9：内存不足10：安装升级包失败255progress可选Integer设备的升级进度，范围：0到100字段名必选/可选类型参数描述version必选String设备当前版本号（升级完成时上报的版本号要与上传软固件包时在平台设置的版本号一致）。description可选String升级状态描述信息，可以返回具体升级失败原因。Topic:$oc/devices/{device_id}/sys/events/up数据格式：{Topic:$oc/devices/{device_id}/sys/events/up数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$ota","event_type":"upgrade_progress_report","event_time":"20151212T121212Z","paras":{"result_code":0,"progress":80,"version":"V2.0","description":"upgradeprocessing"}}]}网关与子设备管理平台通知网关子设备新增功能介绍

平台将该网关新增的子设备列表信息通知给网关设备。Topic

下行:$oc/devices/{device_id}/sys/events/down参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$sub_device_managerevent_type必选String系统字段，固定为：add_sub_device_notifyevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述devices必选List<DeviceInfo>设备列表version必选Long子设备信息版本。网关设备可以保存此信息用于同步子设备列表时携带此参数。DeviceInfo定义表字段名必选/可选类型参数描述parent_device_id必选String父节点设备IDnode_id必选String设备标识码。device_id必选String设备IDname可选String设备名称description可选String设备描述manufacturer_id可选String厂商IDmodel可选String设备型号product_id可选String产品IDfw_version可选String固件版本sw_version可选String软件版本status可选String设备在线状态ONLINE：设备在线OFFLINE：设备离线INACTIVE：设备未激活字段名必选/可选类型参数描述extension_info可选Object设备扩展信息。用户自定义的的扩展信息Topic:$oc/devices/{device_id}/sys/events/down数据格式：{Topic:$oc/devices/{device_id}/sys/events/down数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$sub_device_manager","event_type":"add_sub_device_notify","event_time":"20151212T121212Z","paras":{"devices":[{"parent_device_id":"c6b39067b0325db34663d3ef421a42f6_12345678","node_id":"subdevice11","device_id":"2bb4ddba-fb56-4566-8577-063ad2f5a6cc","name":"subDevice11","description":null,"manufacturer_id":"ofo","model":"twx2","product_id":"c6b39067b0325db34663d3ef421a42f6","fw_version":null,"sw_version":null,"status":"ONLINE"}],"version":1}}]}平台通知网关子设备删除功能介绍

平台将该网关删除的子设备信息通知给网关设备。Topic

下行:$oc/devices/{device_id}/sys/events/down参数说明字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<ServiceEvent>事件服务列表ServiceEvent定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$sub_device_managerevent_type必选String系统字段，固定为：delete_sub_device_notifyevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述devices必选List<DeviceInfo>设备列表version必选Long子设备信息版本DeviceInfo定义表字段名必选/可选类型参数描述parent_device_id必选String父节点设备IDnode_id可选String设备标识。device_id必选String设备IDTopic:$oc/devices/{device_id}/sys/events/down数据格式：{Topic:$oc/devices/{device_id}/sys/events/down数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$sub_device_manager","event_type":"delete_sub_device_notify","event_time":"20151212T121212Z","paras":{"devices":[{"parent_device_id":"c6b39067b0325db34663d3ef421a42f6_12345678","node_id":"subdevice11","device_id":"2bb4ddba-fb56-4566-8577-063ad2f5a6cc"}],"version":1}}]}网关同步子设备列表功能介绍

段时间内新增或者删除的子设备信息。新增的子设备信息会通过新增接口通知网关设备，删除的子设备信息会通过平台通知网关子设备删除通知网关设备。Topic

上行:$oc/devices/{device_id}/sys/events/up参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<EventService>事件服务列表EventService定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$sub_device_managerevent_type必选String系统字段，固定为：sub_device_sync_requestevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述version可选Long子设备信息版本。网关设备收到的最近一次的子设备新增或删除通知时的子设备版本信息。平台会根据此版本信息将此版本后新增或者删除的子设备信息通知给网关设备。Topic:$oc/devices/{device_id}/sys/events/up数据格式：{Topic:$oc/devices/{device_id}/sys/events/up数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$sub_device_manager","event_type":"sub_device_sync_request","event_time":"20151212T121212Z","paras":{"version":1}}]}网关更新子设备状态功能介绍Topic

网关更新子设备状态。上行:$oc/devices/{device_id}/sys/events/up参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<EventService>事件服务列表EventService定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$sub_device_managerevent_type必选String系统字段，固定为：sub_device_update_statusevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述device_statuses必选List<DeviceStatus>设备状态列表，列表大小1~100DeviceStatus定义表:字段名必选/可选类型参数描述device_id必选String子设备IDstatus必选String子设备状态。OFFLINE：设备离线ONLINE：设备上线Topic:$oc/devices/{device_id}/sys/events/up数据格式：{Topic:$oc/devices/{device_id}/sys/events/up数据格式：{"services":[{"service_id":"$sub_device_manager","event_type":"sub_device_update_status","event_time":"20151212T121212Z","paras":{"device_statuses":[{"device_id":"bf40f0c4-4022-41c6-a201-c5133122054a","status":"ONLINE"},{"device_id":"4459c0f7-10bb-4718-9b07-7a82c2d508a5","status":"ONLINE"}]}}]}网关上报获取平台产品信息消息功能介绍Topic

网关上报获取平台产品信息消息。上行:$oc/devices/{device_id}/sys/events/up参数说明示例

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<EventService>事件服务列表EventService定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$sub_device_managerevent_type必选String系统字段，固定为：get_productsevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述product_ids必选List<String>产品列表Topic:$oc/devices/{device_id}/sys/events/upTopic:$oc/devices/{device_id}/sys/events/up数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$sub_device_manager","event_type":"get_products","event_time":"20151212T121212Z","paras":{"product_ids":["c3badd4a-2941-476b-804e-5ba9eafef331"]}}]}平台下发产品信息响应消息功能介绍

平台下发产品信息响应消息。Topic

下行:$oc/devices/{device_id}/sys/events/down参数说明示例

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<EventService>事件服务列表EventService定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$sub_device_managerevent_type必选String系统字段，固定为：get_products_responseevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述products必选List<ProudctInfo>产品信息列表Topic:$oc/devices/{device_id}/sys/events/downTopic:$oc/devices/{device_id}/sys/events/down数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$sub_device_manager","event_type":"get_products_response","event_time":"20151212T121212Z","paras":{"products":[]}}]}平台下发启动子设备扫描通知功能介绍

平台下发子设备扫描命令。Topic

下行:$oc/devices/{device_id}/sys/events/down参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备services可选List<EventService>事件服务列表EventService定义表字段名必选/可选类型参数描述service_id必选String系统字段，固定为：$sub_device_discoveryevent_type必选String系统字段，固定为：start_scanevent_time可选String事件时间paras必选Object事件参数JSON对象paras参数列表字段名必选/可选类型参数描述protocol可选String协议类型channel可选String通道parent_device_id可选String父节点Idscan_settings可选JsonObject扫描设置Topic:$oc/devices/{device_id}/sys/events/down数据格式：{Topic:$oc/devices/{device_id}/sys/events/down数据格式：{"object_device_id":"{object_device_id}","services":[{"service_id":"$sub_device_discovery","event_type":"start_scan","event_time":"20151212T121212Z","paras":{"protocol_type":"","channel":"","parent_device_id":"","scan_settings":""}}]}网关上报子设备列表信息功能介绍

网关上报子设备列表信息。Topic

上行:$oc/devices/{device_id}/sys/events/up参数说明

字段名必选/可选类型参数描述object_device_id可选String事件对应的最终目标设备，没有携带则表示目标设备即topic设备service