スマートホーム ボイラーガイド
action.devices.types.BOILER
- ボイラーはオン / オフの切り替えが可能です。温度の調整に対応している場合があります。
このタイプのデバイスにはボイラー アイコンと、関連する類義語や別名が与えられます。
デバイスの機能
サービスがサポートする属性や状態、EXECUTE レスポンスや QUERY レスポンスの作成方法など、実装の詳細については、対応するトレイトのドキュメントをご覧ください。
必要なトレイト
デバイスに応じて、これらのトレイトとコマンドは必須です。デバイスがこれらのトレイトをサポートしていない場合は、QUERY または EXECUTE レスポンスに functionNotSupported
のエラーコードを入力します。詳細については、エラーと例外をご覧ください。
推奨されるトレイト
デバイスに応じて、これらのトレイトが推奨されます。 ただし、利用可能なすべてのトレイトを自由に組み合わせて、既存の製品機能に最も適合させることができます。
品質要件
- レイテンシ: 800 ミリ秒以下
- 信頼性: 97% 以上
デバイスの例: シンプルなボイラー
このセクションでは、上記のデバイスタイプとトレイトに基づいて一般的な「ボイラー」を表すインテント ペイロードの例を紹介します。実装でトレイトを追加または削除した場合は、その変更を反映するようにレスポンスを適宜変更してください。
SYNC レスポンスの例
{ "requestId": "6894439706274654512", "inputs": [ { "intent": "action.devices.SYNC" } ] }
{ "requestId": "6894439706274654512", "payload": { "agentUserId": "user123", "devices": [ { "id": "123", "type": "action.devices.types.BOILER", "traits": [ "action.devices.traits.TemperatureControl", "action.devices.traits.OnOff" ], "name": { "name": "Simple boiler" }, "willReportState": true, "attributes": { "temperatureRange": { "minThresholdCelsius": 10, "maxThresholdCelsius": 50 }, "temperatureUnitForUX": "F" }, "deviceInfo": { "manufacturer": "smart-home-inc", "model": "hs1234", "hwVersion": "3.2", "swVersion": "11.4" } } ] } }
QUERY レスポンスの例
{ "requestId": "6894439706274654514", "inputs": [ { "intent": "action.devices.QUERY", "payload": { "devices": [ { "id": "123" } ] } } ] }
{ "requestId": "6894439706274654514", "payload": { "devices": { "123": { "status": "SUCCESS", "online": true, "on": true, "temperatureSetpointCelsius": 35 } } } }
サンプル EXECUTE コマンド
SetTemperature
コマンド パラメータの詳細については、
action.devices.traits.TemperatureControl
リファレンスをご覧ください。
{ "requestId": "6894439706274654516", "inputs": [ { "intent": "action.devices.EXECUTE", "payload": { "commands": [ { "devices": [ { "id": "123" } ], "execution": [ { "command": "action.devices.commands.SetTemperature", "params": { "temperature": 40 } } ] } ] } } ] }
{ "requestId": "6894439706274654516", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "temperatureSetpointCelsius": 40 } } ] } }
OnOff
コマンド パラメータの詳細については、
action.devices.traits.OnOff
リファレンスをご覧ください。
{ "requestId": "6894439706274654518", "inputs": [ { "intent": "action.devices.EXECUTE", "payload": { "commands": [ { "devices": [ { "id": "123" } ], "execution": [ { "command": "action.devices.commands.OnOff", "params": { "on": true } } ] } ] } } ] }
{ "requestId": "6894439706274654518", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "on": true } } ] } }