设备端API

通用设备数据上下行接口

设备具备发布权限，用于设备上报数据

• iot/{projectCode}/{productCode}/{deviceCode}/event

设备具备订阅权限，用于设备获取应用下发的数据

• iot/{projectCode}/{productCode}/{deviceCode}/control

设备拓扑关系

获取设备的拓扑关系

网关设备

• 请求Topic：iot/{projectCode}/{productCode}/{deviceCode}/thing/topo/get

{
    "id": "123",
    "version": "1.0",
    "params": "",
    "method": ""
}

• 响应Topic：iot/{projectCode}/{productCode}/{deviceCode}/thing/topo/get_reply

{
    "id":"123",
    "code":"200",
    "data":[
        {
            " IotDeviceCode ":"deviceName1234",
            " IotModelCode ":"1234556554"
        }
    ]
}

子设备上下线

子设备上线

• 请求Topic：iot/{projectCode}/{productCode}/{deviceCode}/online

因为子设备通过网关通道与物联网平台通信，以上Topic为网关设备的Topic。Topic中变量 {projectCode}/{productCode}/{deviceCode}需替换为网关设备的对应信息。

{
    "id":"123",
    "params":{
        "IotModelCode":"123",
        "IotDeviceCode":"test"
    }
}

• 响应Topic：

iot/{projectCode}/{productCode}/{deviceCode}/online_reply

{
    "id":"123",
    "code":"200",
    "message":"success",
    "data":"",
    "ts": 1565838594136
}

子设备下线

• 请求Topic：iot/{projectCode}/{productCode}/{deviceCode}/offline

因为子设备通过网关通道与物联网平台通信，以上Topic为网关设备的Topic。Topic中变量 {projectCode}/{productCode}/{deviceCode}需替换为网关设备的对应信息。

{
    "id": 123,
    "params": {
        "IotModelCode": "123",
        "IotDeviceCode": "test"
    }
}

• 响应Topic：iot/{projectCode}/{productCode}/{deviceCode}/offline_reply

{
    "id": "123",
    "code": "200",
    "message": "success",
    "data": "",
    "ts": 1559734298019
}

设备生命周期变更

设备上下线状态

通过该Topic获取设备的上下线状态。

• 数据流转Topic：iot/{projectCode}/{productCode}/{deviceCode}/mqtt/status

{
   "status" : "online",
   "IotModelCode" : "xxxxxxxxxxx",
   "IotDeviceCode" :"xxxxxxxxxx",
   "time": 1565851637014 
}

TSL物模型模板

设备可以通过上行请求获取设备的TSL模板。

• TOPIC：iot/{projectCode}/{productCode}/{deviceCode}/thing/dsltemplate/get

{
   "id": "123",
   "version": "1.0",
   "params": "",
   "method": "thing.dsltemplate.get"
   }

• REPLY TOPIC：iot/{projectCode}/{productCode}/{deviceCode}/thing/dsltemplate/get_reply

物模型示例：

{
    "schema": "https://iop.com/schema.json",
    "profile": {
        "modelCode": "4rdep3ll"
    },
    "link": "",
    "properties": [{
        "identifier": "1",
        "dataType": {
            "specs": {
                "unit": "平方米 / ㎡",
                "min": "1",
                "max": "1",
                "step": "1"
            },
            "type": "float"
        },
        "name": "1",
        "accessMode": "rw",
        "required": false
    }, {
        "identifier": "temperature",
        "dataType": {
            "specs": {
                "unit": "摄氏度 / °C",
                "min": "1",
                "max": "100",
                "step": "0.1"
            },
            "type": "float"
        },
        "name": "温度",
        "accessMode": "rw",
        "required": false
    }]
}

TSL物模型属性上报

• TOPIC：iot/{projectCode}/{productCode}/{deviceCode}/thing/event/property/post

{
    "id": "123",
    "params": {
        "EnumTest": 3,
        "TextTest": "testTeasdfasdfasst",
        "boolTest": 0,
        "doubleTest": 422332,
        "floatTest": 513412,
        "dateTest": "1574309532419",
        "intTest": 41
    },
    "version": "1.0",
    "method": "thing.event.property.post"
}

报文说明：

• REPLY TOPIC：iot/{projectCode}/{productCode}/{deviceCode}/thing/event/property/post_reply

属性上报响应（暂不支持事件和服务）：

{
    "code": 200,
    "data": {
        "floatTest": "6307:tsl parse: float value is bigger than max 532 -> floatTest",
        "EnumTest": "tsl parse: params not exist",
        "doubleTest": "6322:tsl parse: double value is bigger than max 5423 -> doubleTest",
        "TextTest": "tsl parse: params not exist"
    },
    "id": "123",
    "message": "success",
    "method": "thing.event.property.post",
    "version": "1.0"
}

响应报文说明

错误码