スマートホーム空気クーラー ガイド

action.devices.types.AIRCOOLER - 冷房装置は、温度の冷房と湿度の調整ができるデバイスです。このようなデバイスは一般に、エアコンよりも軽量で持ち運びやすく、水タンクがついています。冷房は暖房や正確な温度設定に対応していない場合があります。空気冷却器で可能な操作には、ファンの速度と湿度の設定変更が含まれます。

このタイプのデバイスには空気クーラーのアイコンが設定され、関連する類義語や別名が与えられます。

デバイスの機能

サービスがサポートする必要がある属性や状態、EXECUTE および QUERY レスポンスの作成方法など、実装の詳細については、対応するトレイトのドキュメントをご覧ください。

必要なトレイト

デバイスに適用可能な場合は、これらのトレイトとコマンドが必要です。デバイスがこれらのトレイトをサポートしていない場合は、QUERY または EXECUTE レスポンスに functionNotSupported のエラーコードを入力します。詳細については、エラーと例外をご覧ください。

品質要件

  • レイテンシ: 1000 ミリ秒以下。
  • 信頼性: 97% 以上

デバイスの例: シンプルな冷風機

このセクションでは、上記のデバイスタイプとトレイトに基づく一般的な「Air Cooler」を表すインテント ペイロードの例を紹介します。実装でトレイトを追加または削除した場合は、それに合わせてレスポンスを変更し、変更を反映します。

SYNC レスポンスの例

リクエスト
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
レスポンス
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.AIRCOOLER",
        "traits": [
          "action.devices.traits.FanSpeed",
          "action.devices.traits.HumiditySetting",
          "action.devices.traits.OnOff",
          "action.devices.traits.TemperatureSetting"
        ],
        "name": {
          "name": "Simple air cooler"
        },
        "willReportState": true,
        "attributes": {
          "humiditySetpointRange": {
            "minPercent": 0,
            "maxPercent": 50
          },
          "availableFanSpeeds": {
            "speeds": [
              {
                "speed_name": "off_key",
                "speed_values": [
                  {
                    "speed_synonym": [
                      "Off",
                      "0"
                    ],
                    "lang": "en"
                  }
                ]
              },
              {
                "speed_name": "low_key",
                "speed_values": [
                  {
                    "speed_synonym": [
                      "Low",
                      "1"
                    ],
                    "lang": "en"
                  }
                ]
              },
              {
                "speed_name": "medium_key",
                "speed_values": [
                  {
                    "speed_synonym": [
                      "Medium",
                      "2"
                    ],
                    "lang": "en"
                  }
                ]
              },
              {
                "speed_name": "high_key",
                "speed_values": [
                  {
                    "speed_synonym": [
                      "High",
                      "3"
                    ],
                    "lang": "en"
                  }
                ]
              }
            ],
            "ordered": true
          },
          "availableThermostatModes": [
            "off",
            "cool",
            "on",
            "fan-only",
            "eco"
          ],
          "thermostatTemperatureUnit": "C"
        },
        "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",
        "thermostatMode": "cool",
        "thermostatTemperatureAmbient": 25,
        "thermostatTemperatureSetpoint": 20,
        "humiditySetpointPercent": 15,
        "humidityAmbientPercent": 10
      }
    }
  }
}

EXECUTE コマンドの例

SetFanSpeed

コマンド パラメータの詳細については、 action.devices.traits.FanSpeed リファレンスをご覧ください。

リクエスト
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.SetFanSpeed",
                "params": {
                  "fanSpeed": "high_key"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
レスポンス
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "currentFanSpeedSetting": "high_key"
        }
      }
    ]
  }
}

SetHumidity

コマンド パラメータの詳細については、 action.devices.traits.HumiditySetting リファレンスをご覧ください。

リクエスト
{
  "requestId": "6894439706274654520",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.SetHumidity",
                "params": {
                  "humidity": 20
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
レスポンス
{
  "requestId": "6894439706274654520",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "humiditySetpointPercent": 20,
          "humidityAmbientPercent": 10
        }
      }
    ]
  }
}

OnOff

コマンド パラメータの詳細については、 action.devices.traits.OnOff リファレンスをご覧ください。

リクエスト
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OnOff",
                "params": {
                  "on": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
レスポンス
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "on": true
        }
      }
    ]
  }
}

ThermostatTemperatureSetpoint

コマンド パラメータの詳細については、 action.devices.traits.TemperatureSetting リファレンスをご覧ください。

リクエスト
{
  "requestId": "6894439706274654522",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.ThermostatTemperatureSetpoint",
                "params": {
                  "thermostatTemperatureSetpoint": 22
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
レスポンス
{
  "requestId": "6894439706274654522",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "thermostatMode": "cool",
          "thermostatTemperatureSetpoint": 22,
          "thermostatTemperatureAmbient": 25.1
        }
      }
    ]
  }
}

ThermostatSetMode

コマンド パラメータの詳細については、 action.devices.traits.TemperatureSetting リファレンスをご覧ください。

リクエスト
{
  "requestId": "6894439706274654524",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.ThermostatSetMode",
                "params": {
                  "thermostatMode": "cool"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
レスポンス
{
  "requestId": "6894439706274654524",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "thermostatMode": "cool",
          "thermostatTemperatureSetpoint": 22,
          "thermostatTemperatureAmbient": 25.1
        }
      }
    ]
  }
}

デバイスエラー

エラーと例外の全リストをご覧ください。