スマートホーム加湿器ガイド
action.devices.types.HUMIDIFIER - 加湿器は空気中に湿気を加えるデバイスです。オン / オフの切り替え、目標湿度の報告と調整が可能です。さまざまな調整可能モードやファン速度設定がある場合もあります。
このタイプのデバイスには加湿器のアイコンと、関連する類義語や別名が与えられます。
デバイスの機能
サービスがサポートする属性や状態、EXECUTE レスポンスや QUERY レスポンスの作成方法など、実装の詳細については、対応するトレイトのドキュメントをご覧ください。
必要なトレイト
デバイスに応じて、これらのトレイトとコマンドは必須です。デバイスがこれらのトレイトをサポートしていない場合は、QUERY または EXECUTE レスポンスに functionNotSupported のエラーコードを入力します。詳細については、エラーと例外をご覧ください。
推奨されるトレイト
デバイスに応じて、これらのトレイトが推奨されます。 ただし、利用可能なすべてのトレイトを自由に組み合わせて、既存の製品機能に最も適合させることができます。
-
action.devices.traits.FanSpeed -
action.devices.traits.HumiditySetting -
action.devices.traits.StartStop
品質要件
- レイテンシ: 1,000 ミリ秒以下
- 信頼性: 97% 以上
デバイスの例: シンプルな加湿器
このセクションでは、上記のデバイスタイプとトレイトに基づく一般的な「Humidifier」を表すインテント ペイロードの例を紹介します。実装でトレイトを追加または削除した場合は、その変更を反映するようにレスポンスを適宜変更してください。
SYNC レスポンスの例
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.HUMIDIFIER",
"traits": [
"action.devices.traits.FanSpeed",
"action.devices.traits.HumiditySetting",
"action.devices.traits.OnOff"
],
"name": {
"name": "Simple humidifier"
},
"willReportState": true,
"attributes": {
"humiditySetpointRange": {
"minPercent": 30,
"maxPercent": 100
},
"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
}
},
"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": 50,
"humidityAmbientPercent": 40
}
}
}
}
サンプル 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": 60
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654518",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"humiditySetpointPercent": 60,
"humidityAmbientPercent": 40
}
}
]
}
}
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
}
}
]
}
}