スマートホーム扇風機ガイド
action.devices.types.FAN
- 扇風機では通常、電源のオン / オフの切り替えとファン速度の設定が可能です。扇風機によっては、ファンの方向や向きなどのその他のモードをサポートするものもあります(たとえば、壁面ユニットには送風方向(上/下)を調整する設定が付いている場合があります)。
このタイプのデバイスには扇風機のアイコンが設定され、関連する類義語や別名が与えられます。
デバイスの機能
サービスがサポートする必要がある属性や状態、EXECUTE レスポンスと QUERY レスポンスを構築する方法など、実装の詳細については、対応するトレイトのドキュメントをご覧ください。
必須のトレイト
これらの特性とコマンドは、デバイスに該当する場合に必要です。デバイスがこれらのトレイトをサポートしていない場合は、QUERY レスポンスまたは EXECUTE レスポンスにエラーコード functionNotSupported
を入力します。詳細については、エラーと例外をご覧ください。
品質要件
- レイテンシ: 700 ms 以下にする必要があります。
- 信頼性: 97% 以上である必要があります。
デバイスの例: シンプルなファン
このセクションでは、上記のデバイスタイプとトレイトに基づく一般的な「ファン」を表すインテントのペイロードの例を示します。実装でトレイトを追加または削除する場合は、変更を反映するようにレスポンスを変更します。
SYNC レスポンスの例
{ "requestId": "6894439706274654512", "inputs": [ { "intent": "action.devices.SYNC" } ] }
{ "requestId": "6894439706274654512", "payload": { "agentUserId": "user123", "devices": [ { "id": "123", "type": "action.devices.types.FAN", "traits": [ "action.devices.traits.FanSpeed", "action.devices.traits.OnOff" ], "name": { "name": "Simple fan" }, "willReportState": true, "attributes": { "availableFanSpeeds": { "speeds": [ { "speed_name": "low_key", "speed_values": [ { "speed_synonym": [ "Low", "Slow" ], "lang": "en" }, { "speed_synonym": [ "Niedrig", "Schleppend" ], "lang": "de" } ] }, { "speed_name": "high_key", "speed_values": [ { "speed_synonym": [ "High" ], "lang": "en" }, { "speed_synonym": [ "Hoch" ], "lang": "de" } ] } ], "ordered": true }, "reversible": 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" } } } }
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" } } ] } }
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 } } ] } }