IoT Platform：裝置屬性、事件、服務

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
}