スマートホーム除湿器ガイド
action.devices.types.DEHUMIDIFIER - 除湿器は、空気中の湿気を取り除くデバイスです。スイッチのオン / オフ、現在の湿度の報告、目標湿度の調整ができます。中には、調整可能な各種モードやファン速度の設定機能を備えているものもあります。
このタイプのデバイスには除湿機のアイコンが設定され、類義語や別名が与えられます。
デバイスの機能
サービスがサポートする必要がある属性や状態、EXECUTE レスポンスと QUERY レスポンスの作成方法など、実装の詳細については、対応するトレイトのドキュメントを参照してください。
必須のトレイト
これらの特性とコマンドは、デバイスに該当する場合に必要です。デバイスがこれらの特性をサポートしていない場合は、QUERY または EXECUTE レスポンスで functionNotSupported のエラーコードを入力します。詳しくは、エラーと例外をご覧ください。
推奨トレイト
これらのトレイトは、デバイスに適用できる場合は推奨されます。ただし、利用可能なすべてのトレイトの中から、既存の製品機能に最適な組み合わせを自由に選択できます。
-
action.devices.traits.FanSpeed -
action.devices.traits.HumiditySetting -
action.devices.traits.StartStop
デバイスの例: シンプルな除湿機
このセクションでは、上記のデバイスタイプとトレイトに基づく一般的な「除湿機」を表すインテント ペイロードの例を示します。実装で特性を追加または削除する場合は、それらの変更を反映するようにレスポンスを適宜変更します。
SYNC レスポンスの例
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}{ "requestId": "6894439706274654512", "payload": { "agentUserId": "user123", "devices": [ { "id": "123", "type": "action.devices.types.DEHUMIDIFIER", "traits": [ "action.devices.traits.FanSpeed", "action.devices.traits.HumiditySetting", "action.devices.traits.OnOff", "action.devices.traits.StartStop" ], "name": { "name": "Simple dehumidifier" }, "willReportState": true, "attributes": { "humiditySetpointRange": { "minPercent": 5, "maxPercent": 50 }, "availableFanSpeeds": { "speeds": [ { "speed_name": "low_key", "speed_values": [ { "lang": "en", "speed_synonym": [ "Low", "Slow" ] }, { "lang": "de", "speed_synonym": [ "Niedrig", "Schleppend" ] } ] }, { "speed_name": "high_key", "speed_values": [ { "lang": "en", "speed_synonym": [ "High" ] }, { "lang": "de", "speed_synonym": [ "Hoch" ] } ] } ], "ordered": true } }, "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, "currentFanSpeedSetting": "low_key", "humiditySetpointPercent": 10, "humidityAmbientPercent": 20, "isRunning": true, "isPaused": false } } } }
EXECUTE コマンドの例
SetFanSpeed
コマンド パラメータの詳細については、
action.devices.traits.FanSpeed リファレンスをご覧ください。
{ "requestId": "6894439706274654516", "inputs": [ { "intent": "action.devices.EXECUTE", "payload": { "commands": [ { "devices": [ { "id": "123" } ], "execution": [ { "command": "action.devices.commands.SetFanSpeed", "params": { "fanSpeed": "high_key" } } ] } ] } } ] }
{ "requestId": "6894439706274654516", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "currentFanSpeedSetting": "high_key" } } ] } }
SetHumidity
コマンド パラメータの詳細については、
action.devices.traits.HumiditySetting リファレンスをご覧ください。
{ "requestId": "6894439706274654518", "inputs": [ { "intent": "action.devices.EXECUTE", "payload": { "commands": [ { "devices": [ { "id": "123" } ], "execution": [ { "command": "action.devices.commands.SetHumidity", "params": { "humidity": 15 } } ] } ] } } ] }
{ "requestId": "6894439706274654518", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "humiditySetpointPercent": 15, "humidityAmbientPercent": 20 } } ] } }
OnOff
コマンド パラメータの詳細については、
action.devices.traits.OnOff リファレンスをご覧ください。
{ "requestId": "6894439706274654520", "inputs": [ { "intent": "action.devices.EXECUTE", "payload": { "commands": [ { "devices": [ { "id": "123" } ], "execution": [ { "command": "action.devices.commands.OnOff", "params": { "on": true } } ] } ] } } ] }
{ "requestId": "6894439706274654520", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "on": true } } ] } }
StartStop
コマンド パラメータの詳細については、
action.devices.traits.StartStop リファレンスをご覧ください。
{ "requestId": "6894439706274654522", "inputs": [ { "intent": "action.devices.EXECUTE", "payload": { "commands": [ { "devices": [ { "id": "123" } ], "execution": [ { "command": "action.devices.commands.StartStop", "params": { "start": true } } ] } ] } } ] }
{ "requestId": "6894439706274654522", "payload": { "commands": [ { "ids": [ "123" ], "status": "PENDING", "states": { "online": true, "isRunning": true, "isPaused": false } } ] } }
PauseUnpause
コマンド パラメータの詳細については、
action.devices.traits.StartStop リファレンスをご覧ください。
{ "requestId": "6894439706274654524", "inputs": [ { "intent": "action.devices.EXECUTE", "payload": { "commands": [ { "devices": [ { "id": "123" } ], "execution": [ { "command": "action.devices.commands.PauseUnpause", "params": { "pause": true } } ] } ] } } ] }
{ "requestId": "6894439706274654524", "payload": { "commands": [ { "ids": [ "123" ], "status": "PENDING", "states": { "online": true, "isRunning": false, "isPaused": true } } ] } }