IoT Platform:デバイスのプロパティ、イベント、サービス

トピックとデータフォーマット (デバイス発信)：

• パススルー/カスタム

  トピック	データフォーマット
  リクエストトピック： /sys/${productKey}/${deviceName}/thing/model/up_raw	リクエストデータは、デバイスが報告する未加工のメッセージです。 説明 Message Queuing Telemetry Transport (MQTT) プロトコルを介してパススルーモードで送信されるデータは、16進数フォーマットです。 アップロードされるパススルーデータには method パラメータを含める必要があり、その値はデータ解析スクリプトで定義された対応するリクエストメソッドと一致する必要があります。たとえば、JavaScript スクリプトの例では、デバイスがプロパティデータをクラウドにアップロードする際、ALINK_PROP_REPORT_METHOD の値は thing.event.property.post です。 例： 0x00002233441232013fa00000
  レスポンストピック： /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

  トピック	データフォーマット
  リクエストトピック： /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" }
  レスポンストピック： /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
}

トピックとデータフォーマット (下り)：

リクエストデータフォーマット：

{
    "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： /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

  TSL モデルモジュール	Topic	データフォーマット
  デフォルトモジュール	リクエストTopic： /sys/${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/post 応答Topic： /sys/${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/post_reply	デフォルトの TSL モデルモジュールを例にすると、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 記述は次の通りです。パラメーターの詳細については、「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": "Fan alarm",
            "type": "alert",
            "required": true,
            "outputData": [
                {
                    "identifier": "errorCode",
                    "name": "Error code",
                    "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"
}

IoT Platform は、同期および非同期の呼び出しをサポートしています。TSL モデルでサービスを定義する際に、呼び出し方法を指定する必要があります。デバイスサービスの呼び出し方法については、「Alink プロトコルでのサービス呼び出しの図」をご参照ください。

• 同期： InvokeThingService API または InvokeThingsService API を呼び出します。IoT Platform は、RRPC を使用して同期的にリクエストを送信します。サービスは同期呼び出しに設定する必要があり、IoT Platform は対応する RRPC トピックをサブスクライブします。RRPC とは。

• 非同期： InvokeThingService API または InvokeThingsService API を呼び出してサービスを起動します。IoT Platform は非同期的にリクエストを送信し、デバイスは非同期的に結果を返します。この場合、サービスは非同期呼び出しに設定されており、IoT Platform はこのセクションで説明する非同期応答トピックをサブスクライブします。

トピックとデータフォーマット (下り)：

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": "古い重量"
                },
                {
                    "identifier": "CollectTime",
                    "dataType": {
                        "specs": {
                            "length": "2048"
                        },
                        "type": "text"
                    },
                    "name": "収集時刻"
                }
            ],
            "identifier": "SetWeight",
            "inputData": [
                {
                    "identifier": "NewWeight",
                    "dataType": {
                        "specs": {
                            "unit": "kg",
                            "min": "0",
                            "max": "200",
                            "step": "1"
                        },
                        "type": "double"
                    },
                    "name": "新しい重量"
                }
            ],
            "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"
}

トピックとデータフォーマット (デバイスからの送信)：

• パススルー/カスタム

  トピック	データフォーマット
  リクエストトピック： /sys/${productKey}/${deviceName}/thing/model/up_raw	リクエストデータは、デバイスが報告する RAW メッセージです。 説明 パススルーデータには method パラメーターを含める必要があります。値は、データ解析スクリプトで定義された対応するリクエストメソッドと一致させる必要があります。たとえば、値は thing.event.property.pack.post に設定できます。 例： 0xff0000007b00
  レスポンストピック： /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

  リクエストとレスポンスのトピック	リクエストとレスポンスのデータ
  リクエストトピック： /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" }
  レスポンストピック： /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
}

トピックとデータ形式：

• リクエストトピック： /sys/${productKey}/${deviceName}/thing/event/property/history/post

• レスポンストピック： /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
}

メッセージ転送： 履歴 TSL (Thing Specification Language) モデルデータは、サーバー側サブスクリプションまたはデータ転送を介して、お使いのサーバーまたは他のクラウドプロダクトに転送できます。トピックとデータ形式については、「履歴プロパティのレポート」と「履歴イベントのレポート」をご参照ください。

トピックとデータ形式 (上り)：

• リクエストトピック： /sys/${productKey}/${deviceName}/thing/event/property/batch/post

• 応答トピック： /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
}