设备属性、事件、服务

Topic和数据格式（上行）：

• 透传/自定义

  Topic	数据格式
  请求Topic：/sys/${productKey}/${deviceName}/thing/model/up_raw	请求数据是设备上报的原始报文。 说明 通过MQTT协议透传的数据为16进制格式。 透传的上报数据中，必须包含请求方法method参数，取值需与数据解析脚本中定义的对应请求方法一致。例如JavaScript脚本示例中设备上传属性数据到云端的ALINK_PROP_REPORT_METHOD值thing.event.property.post。 示例如下： 0x00002233441232013fa00000
  响应Topic：/sys/${productKey}/${deviceName}/thing/model/up_raw_reply	云端返回数据格式如下： 成功返回示例 { "code": 200, "data": {}, "id": "123", "message": "success", "version": "1.0" } 失败返回示例 { "code": 6813, "data": {}, "id": "123", "message": "topic illegal", "version": "1.0" }

• Alink JSON

  Topic	数据格式
  请求Topic：/sys/${productKey}/${deviceName}/thing/event/property/post	请求数据格式： { "id": "123", "version": "1.0", "sys":{ "ack":0 }, "params": { "Power": { "value": "on", "time": 1524448722000 }, "WF": { "value": 23.6, "time": 1524448722000 } }, "method": "thing.event.property.post" }
  响应Topic：/sys/${productKey}/${deviceName}/thing/event/property/post_reply	云端返回数据格式如下： 成功返回示例 { "code": 200, "data": {}, "id": "123", "message": "success", "method": "thing.event.property.post", "version": "1.0" } 失败返回示例 { "code": 6813, "data": {}, "id": "123", "message": "The format of result is error!", "method": "thing.event.property.post", "version": "1.0" }

参数说明：

"params": {
    "Power": "on",
    "WF": 23.6
}

"test:Power": {
    "value": "on",
    "time": 1524448722000
}

Topic和数据格式（下行）：

请求数据格式：

{
    "id": "123",
    "version": "1.0",
    "params": {
        "temperature": "30.5"
    },
    "method": "thing.service.property.set"
}

响应数据格式：

• 成功返回示例

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

• 失败返回示例

  {
      "code": 9201,
      "data": {},
      "id": "123",
      "message": "device offLine",
      "version": "1.0"
  }

参数说明：

Topic和数据格式（上行）：

• 透传/自定义

  Topic	数据格式
  请求Topic：/sys/${productKey}/${deviceName}/thing/model/up_raw	请求数据是设备上报的原始报文。 说明 透传的上报数据中，必须包含请求方法method参数，取值需与数据解析脚本中定义的对应请求方法一致。例如，取值为thing.event.${tsl.event.identifier}.post。 示例如下： 0xff0000007b00
  响应Topic：/sys/${productKey}/${deviceName}/thing/model/up_raw_reply	云端返回数据格式如下： 成功返回示例 { "code": 200, "data": {}, "id": "123", "message": "success", "version": "1.0" } 失败返回示例 { "code": 6813, "data": {}, "id": "123", "message": "topic illegal", "version": "1.0" }

• Alink JSON

  物模型模块	Topic	数据格式
  默认模块	请求Topic：/sys/${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/post 响应Topic：/sys/${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/post_reply	以默认模块物模型为例，Alink请求数据格式： { "id": "123", "version": "1.0", "sys":{ "ack":0 }, "params": { "value": { "Power": "on", "WF": "2" }, "time": 1524448722000 }, "method": "thing.event.${tsl.event.identifier}.post" } Alink响应数据格式： { "code": 200, "data": {}, "id": "123", "message": "success", "method": "thing.event.${tsl.event.identifier}.post", "version": "1.0" } 若请求失败，返回{}。
  自定义模块	请求Topic：/sys/${productKey}/${deviceName}/thing/event/${tsl.functionBlockId}:${tsl.event.identifier}/post 响应Topic：/sys/${productKey}/${deviceName}/thing/event/${tsl.functionBlockId}:${tsl.event.identifier}/post_reply

参数说明：

{
    "Power": "on",
    "WF": "2"
}

Alink格式示例：假设产品中定义了一个alarm事件，它的TSL描述如下。参数说明，请参见什么是物模型。

{
    "schema": "https://iot-tsl.oss-cn-shanghai.aliyuncs.com/schema.json",
    "link": "/sys/${productKey}/airCondition/thing/",
    "profile": {
        "productKey": "${productKey}",
        "deviceName": "airCondition"
    },
    "events": [
        {
            "identifier": "alarm",
            "name": "alarm",
            "desc": "风扇警报",
            "type": "alert",
            "required": true,
            "outputData": [
                {
                    "identifier": "errorCode",
                    "name": "错误码",
                    "dataType": {
                        "type": "text",
                        "specs": {
                            "length": "255"
                        }
                    }
                }
            ],
            "method": "thing.event.alarm.post"
        }
    ]
}

当设备上报事件时，Alink请求数据格式：

{
    "id": "123",
    "version": "1.0",
    "params": {
        "value": {
            "errorCode": "error"
        },
        "time": 1524448722000
    },
    "method": "thing.event.alarm.post"
}

物联网平台支持同步调用和异步调用。物模型定义服务时，需设置此项。实现设备服务调用的原理，请参见Alink协议中服务调用原理图。

• 同步方式：通过InvokeThingService或InvokeThingsService接口调用服务，物联网平台直接使用RRPC同步方式下行推送请求。此时，服务选择为同步调用方式，物联网平台订阅RRPC对应Topic。设备RRPC的集成方式，请参见什么是RRPC。

• 异步方式：通过InvokeThingService或InvokeThingsService接口调用服务，物联网平台采用异步方式下行推送请求，设备也采用异步方式返回结果。此时，服务选择为异步调用方式，物联网平台订阅此处的异步响应Topic。

Topic和数据格式（下行）：

Alink请求数据格式：

{
    "id": "123",
    "version": "1.0",
    "params": {
        "Power": "on",
        "WF": "2"
    },
    "method": "thing.service.${tsl.service.identifier}"
}

响应数据格式：

• 成功返回示例：

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

• 失败返回示例：

  {
      "code": 9201,
      "data": {},
      "id": "123",
      "message": "device offLine",
      "version": "1.0"
  }

参数说明：

{
    "Power": "on",
    "WF": "2"
}

Alink格式示例：例如产品中定义了服务SetWeight，它的TSL描述如下：

{
    "schema": "https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json",
    "profile": {
        "productKey": "testProduct01"
    },
    "services": [
        {
            "outputData": [
                {
                    "identifier": "OldWeight",
                    "dataType": {
                        "specs": {
                            "unit": "kg",
                            "min": "0",
                            "max": "200",
                            "step": "1"
                        },
                        "type": "double"
                    },
                    "name": "OldWeight"
                },
                {
                    "identifier": "CollectTime",
                    "dataType": {
                        "specs": {
                            "length": "2048"
                        },
                        "type": "text"
                    },
                    "name": "CollectTime"
                }
            ],
            "identifier": "SetWeight",
            "inputData": [
                {
                    "identifier": "NewWeight",
                    "dataType": {
                        "specs": {
                            "unit": "kg",
                            "min": "0",
                            "max": "200",
                            "step": "1"
                        },
                        "type": "double"
                    },
                    "name": "NewWeight"
                }
            ],
            "method": "thing.service.SetWeight",
            "name": "设置重量",
            "required": false,
            "callType": "async"
        }
    ]
}

当调用服务时，Alink请求数据格式：

{
    "method": "thing.service.SetWeight",
    "id": "105917531",
    "params": {
        "NewWeight": 100.8
    },
    "version": "1.0"
}

Alink响应数据格式：

{
    "id": "105917531",
    "code": 200,
    "data": {
        "CollectTime": "1536228947682",
        "OldWeight": 100.101
    }
    "message": "success",
    "version": "1.0"
}

Topic和数据格式（上行）：

• 透传/自定义

  Topic	数据格式
  请求Topic：/sys/${productKey}/${deviceName}/thing/model/up_raw	请求数据是设备上报的原始报文。 说明 透传的上报数据中，必须包含请求方法method参数，取值需与数据解析脚本中定义的对应请求方法一致。例如，取值为thing.event.property.pack.post。 示例如下： 0xff0000007b00
  响应Topic：/sys/${productKey}/${deviceName}/thing/model/up_raw_reply	云端返回数据格式如下： 成功返回示例 { "code": 200, "data": {}, "id": "123", "message": "success", "version": "1.0" } 失败返回示例 { "code": 6813, "data": {}, "id": "123", "message": "topic illegal", "version": "1.0" }

• Alink JSON

  请求和响应Topic	请求和响应数据
  请求Topic：/sys/${productKey}/${deviceName}/thing/event/property/pack/post	Alink请求数据格式： { "id": "123", "version": "1.0", "sys":{ "ack":0 }, "params": { "properties": { "Power": { "value": "on", "time": 1524448722000 }, "WF": { "value": { }, "time": 1524448722000 } }, "events": { "alarmEvent1": { "value": { "param1": "on", "param2": "2" }, "time": 1524448722000 }, "alertEvent2": { "value": { "param1": "on", "param2": "2" }, "time": 1524448722000 } }, "subDevices": [ { "identity": { "productKey": "", "deviceName": "" }, "properties": { "Power": { "value": "on", "time": 1524448722000 }, "WF": { "value": { }, "time": 1524448722000 } }, "events": { "alarmEvent1": { "value": { "param1": "on", "param2": "2" }, "time": 1524448722000 }, "alertEvent2": { "value": { "param1": "on", "param2": "2" }, "time": 1524448722000 } } } ] }, "method": "thing.event.property.pack.post" }
  响应Topic：/sys/${productKey}/${deviceName}/thing/event/property/pack/post_reply	Alink响应数据格式： { "code": 200, "data": {}, "id": "123", "message": "success", "method": "thing.event.property.pack.post", "version": "1.0" } 若请求失败，返回{}。

参数说明：

"test:Power": {
    "value": "on",
    "time": 1524448722000
}

"test:alarmEvent1": {
    "value": {
        "param1": "on",
        "param2": "2"
    },
    "time": 1524448722000
}

Topic和数据格式（上行）：

• 请求Topic：/sys/${productKey}/${deviceName}/thing/event/property/history/post

• 响应Topic：/sys/${productKey}/${deviceName}/thing/event/property/history/post_reply

Alink请求数据格式：

{
    "id": "123", 
    "version": "1.0",
    "sys":{
        "ack":0
    }, 
    "method": "thing.event.property.history.post", 
    "params": [
        {
            "identity": {
                "productKey": "", 
                "deviceName": ""
            }, 
            "properties": [
                {
                    "Power": {
                        "value": "on", 
                        "time": 1524448722000
                    }, 
                    "WF": {
                        "value": "3", 
                        "time": 1524448722000
                    }
                }, 
                {
                    "Power": {
                        "value": "on", 
                        "time": 1524448722000
                    }, 
                    "WF": {
                        "value": "3", 
                        "time": 1524448722000
                    }
                }
            ], 
            "events": [
                {
                    "alarmEvent": {
                        "value": {
                            "Power": "on", 
                            "WF": "2"
                        }, 
                        "time": 1524448722000
                    }, 
                    "alertEvent": {
                        "value": {
                            "Power": "off", 
                            "WF": "3"
                        }, 
                        "time": 1524448722000
                    }
                }
            ]
        }, 
        {
            "identity": {
                "productKey": "", 
                "deviceName": ""
            }, 
            "properties": [
                {
                    "Power": {
                        "value": "on", 
                        "time": 1524448722000
                    }, 
                    "WF": {
                        "value": "3", 
                        "time": 1524448722000
                    }
                }
            ], 
            "events": [
                {
                    "alarmEvent": {
                        "value": {
                            "Power": "on", 
                            "WF": "2"
                        }, 
                        "time": 1524448722000
                    }, 
                    "alertEvent": {
                        "value": {
                            "Power": "off", 
                            "WF": "3"
                        }, 
                        "time": 1524448722000
                    }
                }
            ]
        }
    ]
}

Alink响应数据格式：

• 成功返回示例

  {
      "code": 200,
      "data": {},
      "id": "123",
      "message": "success",
      "method": "thing.event.property.history.post",
      "version": "1.0"
  }

• 失败返回示例

  {
      "code": 5092,
      "data": {},
      "id": "123",
      "message": "property not found",
      "method": "thing.event.property.history.post",
      "version": "1.0"
  }

参数说明：

"test:Power": {
    "value": "on",
    "time": 1524448722000
}

"test:alarmEvent": {
    "value": {
        "Power": "on", 
        "WF": "2"
    }, 
    "time": 1524448722000
}

消息转发说明：设备上报至平台的物模型历史数据，可以通过服务端订阅、云产品流转转发到您的服务器或其他云产品。具体Topic和数据格式，请参见历史属性上报和历史事件上报。

Topic和数据格式（上行）：

• 请求Topic：/sys/${productKey}/${deviceName}/thing/event/property/batch/post

• 响应Topic：/sys/${productKey}/${deviceName}/thing/event/property/batch/post_reply

Alink请求数据格式：

{
    "id": "123", 
    "version": "1.0",
    "sys":{
        "ack":0
    }, 
    "method": "thing.event.property.batch.post", 
    "params": {
        "properties": {
            "Power": [
                {
                    "value": "on", 
                    "time": 1524448722000
                },
                {
                    "value": "off", 
                    "time": 1524448722001
                }
            ], 
            "WF": [
                {
                    "value": 3, 
                    "time": 1524448722000
                },
                {
                    "value": 4, 
                    "time": 1524448722009
                }
            ]
        }, 
        "events": {
            "alarmEvent": [
                {
                    "value": {
                        "Power": "on", 
                        "WF": "2"
                    }, 
                    "time": 1524448722000
                },
                {
                    "value": {
                        "Power": "on", 
                        "WF": "2"
                    }, 
                    "time": 1524448722000
                }
            ]
        }
    }
}

Alink响应数据格式：

• 成功返回示例：

  {
      "code": 200,
      "data": {},
      "id": "123",
      "message": "success",
      "method": "thing.event.property.batch.post",
      "version": "1.0"
  }

• 失败返回示例：

  {
      "code": 9201,
      "data": {},
      "id": "123",
      "message": "device offLine",
      "method": "thing.event.property.batch.post",
      "version": "1.0"
  }

参数说明：

"test:Power": {
    "value": "on",
    "time": 1524448722000
}

"test:alarmEvent": {
    "value": {
        "Power": "on", 
        "WF": "2"
    }, 
    "time": 1524448722000
}