スマートホーム空気清浄ガイド
action.devices.types.AIRPURIFIER - 空気清浄機は、オン / オフの切り替えが可能で、エアフィルターの清浄度とエアフィルターの寿命を報告し、さまざまなモード設定に調整できます。
デバイスは、空気清浄機のアイコンと、関連する類義語や別名があることを示します。
デバイスの機能
サービスがサポートする属性や状態、EXECUTE レスポンスと QUERY レスポンスの構築方法など、実装の詳細については、対応するトレイトのドキュメントをご覧ください。
必要な特性
これらのトレイトとコマンドは、お使いのデバイスに必須です。デバイスがこれらのトレイトをサポートしていない場合は、クエリまたは EXECUTE のレスポンスに functionNotSupported のエラーコードを入力します。詳細については、エラーと例外をご覧ください。
推奨されるトレイト
これらのトレイトは、お客様のデバイスに該当する場合におすすめです。 ただし、既存のプロダクトの機能に合わせて、使用可能なすべてのトレイトを自由に組み合わせて使用できます。
品質要件
- レイテンシ: 1,000 ミリ秒以下にする必要があります。
- 信頼性: 97% 以上を指定します。
デバイスの例: シンプルな空気清浄機
このセクションでは、上記のデバイスタイプとトレイトに基づいた、一般的な「空気清浄機」を表すインテント ペイロードの例について説明します。実装でトレイトを追加または削除する場合は、その変更を反映するようにレスポンスを変更します。
SYNC レスポンスの例
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.AIRPURIFIER",
"traits": [
"action.devices.traits.FanSpeed",
"action.devices.traits.SensorState",
"action.devices.traits.OnOff"
],
"name": {
"name": "Simple air purifier"
},
"willReportState": true,
"attributes": {
"availableFanSpeeds": {
"speeds": [
{
"speed_name": "low_key",
"speed_values": [
{
"speed_synonym": [
"Low",
"Slow"
],
"lang": "en"
},
{
"speed_synonym": [
"Low",
"Slow"
],
"lang": "de"
}
]
},
{
"speed_name": "high_key",
"speed_values": [
{
"speed_synonym": [
"High"
],
"lang": "en"
},
{
"speed_synonym": [
"High"
],
"lang": "de"
}
]
}
],
"ordered": true
},
"sensorStatesSupported": [
{
"name": "FilterCleanliness",
"descriptiveCapabilities": {
"availableStates": [
"clean",
"dirty",
"needs replacement"
]
}
}
]
},
"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",
"currentSensorStateData": [
{
"name": "FilterCleanliness",
"currentSensorState": "clean"
}
]
}
}
}
}
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"
}
}
]
}
}
オン
コマンド パラメータの詳細については、
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
}
}
]
}
}