:デバイスのプロパティ、イベント、およびサービス

デバイスからIoT Platformにデータを送信するためのトピックとデータ形式:

• カスタム

  トピック	データ形式
  リクエストトピック: /sys/${productKey}/${deviceName}/thing/model/up_raw	リクエストには、デバイスがIoT Platformに送信する必要がある生データが含まれます。 説明 16進データは、MQTT (Message Queuing Telemetry Transport) を介して送信されます。 送信されたデータには、リクエストメソッドを指定するmethodパラメーターが含まれている必要があります。 パラメーターの値は、データ解析スクリプトで指定したリクエストメソッドと同じである必要があります。 たとえば、サンプルJavaScriptスクリプトのトピックでは、デバイスがIoT Platformに送信する必要があるデータに、methodパラメーターが含まれている必要があります。 パラメーターの値は、データ解析スクリプトのALINK_PROP_REPORT_METHODパラメーターに指定したthing.event.property.postの値と同じである必要があります。 例： 0x00002233441232013fa0000 0
  レスポンストピック: /sys/${productKey}/${deviceName}/thing/model/up_raw_reply	レスポンス例： 通常のレスポンス例 { "code": 200, "data": {}, "id": "123", "message": "success", "version": "1.0" } 失敗応答のサンプル { "code": 6813、 "data": {}, "id": "123", "message": "トピック違法" 、 "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": "結果の形式はエラーです!" 、 "method": "thing.event.property.post", "version": "1.0" }

パラメータ:

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

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

IoT Platformからデバイスにデータを送信するためのトピックとデータ形式:

サンプルリクエスト:

{
    "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"
  } 

パラメータ:

デバイスからIoT Platformにデータを送信するためのトピックとデータ形式:

• カスタム

  トピック	データ形式
  リクエストトピック: /sys/${productKey}/${deviceName}/thing/model/up_raw	リクエストには、デバイスがIoT Platformに送信する必要がある生データが含まれます。 説明 送信されたデータには、リクエストメソッドを指定するmethodパラメーターが含まれている必要があります。 パラメーターの値は、データ解析スクリプトで指定したリクエストメソッドと同じである必要があります。 たとえば、methodパラメーターをthing.event.${tsl.event.identifier}.postに設定できます。 例： 0xff0000007b0 0
  レスポンストピック: /sys/${productKey}/${deviceName}/thing/model/up_raw_reply	レスポンス例： 通常のレスポンス例 { "code": 200, "data": {}, "id": "123", "message": "success", "version": "1.0" } 失敗応答のサンプル { "code": 6813、 "data": {}, "id": "123", "message": "トピック違法" 、 "version": "1.0" }

• Alink JSON

  TSLモジュール	トピック	データ形式
  デフォルトモジュール	リクエストトピック: /sys/${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/post レスポンストピック: /sys/${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/post_reply	デフォルトのTSLモジュールが使用されている場合、Alink JSON形式のサンプルリクエスト: { "id": "123", "version"： "1.0"、 "sys":{ "ack":0 }, "params": { "value"：{ "Power": "on", "WF": "2" }, "time": 1524448722000 }, "method": "thing.event.${tsl.event.identifier}.post" } Alink JSON形式のサンプル応答: { "code": 200, "data": {}, "id": "123", "message": "success", "method": "thing.event.${tsl.event.identifier}.post" 、 "version": "1.0" } リクエストが失敗した場合、{} が返されます。
  カスタムモジュール	リクエストトピック: /sys/${productKey}/${deviceName}/thing/event/${tsl.functionBlockId }:{ tsl.event.identifier}/post レスポンストピック: /sys/${productKey}/${deviceName}/thing/event/${tsl.functionBlockId }:{ tsl.event.identifier}/post_reply

パラメータ:

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

Alink JSON形式の例: アラームイベントは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 alert",
            "type": "alert",
            "required": true,
            "outputData": [
                {
                    "identifier": "errorCode",
                    "name": "Error code",
                    "dataType": {
                        "type": "text",
                        "specs": {
                            "length": "255"
                        }
                    }
                }
            ],
            "method": "thing.event.alarm.post"
        }
    ]
}

デバイスは、Alink JSONデータ形式の次のリクエストでイベントを送信します。

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

IoT Platformでは、同期モードまたは非同期モードでサービスを呼び出すことができます。 TSLモデルでサービスを定義する場合は、サービスを呼び出すモードを指定する必要があります。 サービスの定義方法の詳細については、「TSL機能の追加」をご参照ください。 デバイスサービスを呼び出す方法の詳細については、「デバイスサービスの呼び出しまたはデバイスプロパティの設定」をご参照ください。

• 同期モード: InvokeThingServiceまたはInvokeThingsService操作を呼び出して、デバイスのサービスを呼び出すことができます。 IoT Platformは、Revert-Remote Procedure Call (RRPC) 同期通信メカニズムを使用して、デバイスにリクエストを送信します。 同期モードでサービスを呼び出すと、IoT PlatformはRRPCトピックをサブスクライブします。 詳細については、「RRPCの概要」をご参照ください。

• 非同期モード: InvokeThingServiceまたはInvokeThingsService操作を呼び出して、デバイスのサービスを呼び出すことができます。 IoT Platformは、デバイスにリクエストを非同期に送信します。 非同期モードでサービスを呼び出すと、IoT Platformは非同期応答トピックにサブスクライブします。

IoT Platformからデバイスにデータを送信するためのトピックとデータ形式:

Alink JSON形式のサンプルリクエスト:

{
    "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 JSON形式の例: 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 JSON形式のサンプルリクエスト:

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

Alink JSON形式のサンプル応答:

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

ゲートウェイからIoT Platformにデータを送信するためのトピックとデータ形式:

• カスタム

  トピック	データ形式
  リクエストトピック: /sys/${productKey}/${deviceName}/thing/model/up_raw	リクエストには、ゲートウェイがIoT Platformに送信する必要がある生データが含まれます。 説明 送信されたデータには、リクエストメソッドを指定するmethodパラメーターが含まれている必要があります。 パラメーターの値は、データ解析スクリプトで指定したリクエストメソッドと同じである必要があります。 たとえば、methodパラメーターをthing.event.property.pack.postに設定できます。 例： 0xff0000007b0 0
  レスポンストピック: /sys/${productKey}/${deviceName}/thing/model/up_raw_reply	レスポンス例： 通常のレスポンス例 { "code": 200, "data": {}, "id": "123", "message": "success", "version": "1.0" } 失敗応答のサンプル { "code": 6813、 "data": {}, "id": "123", "message": "トピック違法" 、 "version": "1.0" }

• Alink JSON

  リクエストとレスポンスのトピック	リクエストデータとレスポンスデータ
  リクエストトピック: /sys/${productKey}/${deviceName}/thing/event/property/pack/post	Alink JSON形式のサンプルリクエスト: { "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 JSON形式のサンプル応答: { "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
} 

デバイスからIoT Platformにデータを送信するためのトピックとデータ形式:

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

• レスポンストピック: /sys/${productKey}/${deviceName}/thing/event/property/history/post_reply

Alink JSON形式のサンプルリクエスト:

{
    "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"：{
                            "パワー": "オフ" 、 
                            "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"：{
                            "パワー": "オフ" 、 
                            "WF": "3"
                        }, 
                        "time": 1524448722000
                    }
                }
            ]
        }
    ]
}

Alink JSON形式のサンプル応答:

• 通常のレスポンス例

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

• 失敗応答のサンプル

  {
      "code": 5092、
      "data": {},
      "id": "123",
      "message": "プロパティが見つかりません" 、
      "method": "thing.event.property.history.post" 、
      "version": "1.0"
  } 

パラメータ:

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

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

データ転送: IoT Platformは、サーバー側サブスクリプションまたはデータ転送機能を使用して、デバイスから送信された過去のTSLデータをサーバーまたは他のAlibaba Cloudサービスに転送できます。 関連するトピックとデータ形式の詳細については、「履歴プロパティの送信」および「履歴イベントの送信」をご参照ください。

デバイスからIoT Platformにデータを送信するためのトピックとデータ形式:

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

• レスポンストピック: /sys/${productKey}/${deviceName}/thing/event/property/batch/post_reply

Alink JSON形式のサンプルリクエスト:

{
    "id": "123", 
    "version"： "1.0"、
    "sys":{
        "ack":0
    }, 
    "method": "thing.event.property.batch.post" 、 
    "params": {
        "properties": {
            "パワー": [
                {
                    "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 JSON形式のサンプル応答:

• 通常のレスポンス例

  {
      "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
}