IoT视频云

  • IoT视频云 > 产品手册 > 设备管理 >设备影子 >设备影子JSON详情

    设备影子JSON详情

    最近更新时间:2019-12-19 12:14:37

    本章介绍设备影子的JSON格式表达方法。

    设备影子文档示例

    {
          "stateReported": {
                "attr_name1 ": "value1"
          },
          "stateDesired": {
                "attr_name2": "value2"
          },
          "lastReportUpdateTime":{
                "attr_name1": 123456789
          },
          "lastDesiredUpdateTime":{
                "attr_name2": 123456789
         },
          "timestamp": 123456789,
          "version": 1
    }
    

    JSON参数说明:

    参数名称 说明
    stateReported 设备自身上报的状态。设备可以向本文档部分写入数据,以报告其新状态。应用程序可以读取本文档部分,以获取设备的状态。
    stateDesired 设备预期的状态。应用程序通过 HTTP RESTful API 向本文档写入数据更新设备状态,设备 SDK 通过注册相关属性和回调,设备影子服务同步影子数据到设备。
    lastReportUpdateTime stateReported 部分每个属性项的最后更新时间。
    lastDesiredUpdateTime stateDesired 部分每个属性项的最后更新时间。
    timestamp 设备影子文档的最后一次更新时间。
    version 设备影子文档的版本号,每次设备影子文档更新之后,版本号都会递增。版本号由IoT视频云平台后台维护,这可以确保设备的数据与设备影子的数据保持一致。

    空白部分
    当设备影子文档为空时,此时获取到设备影子文档为:

    {
          "stateReported": {},
          "stateDesired": {},
          "lastReportUpdateTime":{},
          "lastDesiredUpdateTime":{},
          "version": 0
    }
    

    当设备影子文档具有预期状态时,才会有 stateDesired 部分,stateReported 部分可以为空,例如:

    {
          "stateReported": {},
          "stateDesired": {
               "attr_name2": "value2"
          },
          "lastReportUpdateTime":{
              "attr_name2": 123456789
          },
          "lastDesiredUpdateTime":{},
          "timestamp": 123456789,
          "version": 1
    }
    
    以上内容是否对您有帮助?
  • Icon free helper
    Close