スマートホーム コーヒー メーカー ガイド

action.devices.types.COFFEE_MAKER - コーヒーメーカーで可能な操作には、オン / オフの切り替え、調理モードやフード プリセットの調整、設定温度の調整、調理モード以外のさまざまな設定の調整が含まれます。

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

デバイスの機能

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

必須のトレイト

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

これらのトレイトは、デバイスに適用できる場合は推奨されます。ただし、利用可能なすべてのトレイトの中から、既存の製品機能に最適な組み合わせを自由に選択できます。

デバイスの例: シンプルなコーヒー メーカー

このセクションには、上記のデバイスタイプとトレイトに基づく一般的な「コーヒーメーカー」を表すインテント ペイロードの例が含まれています。実装で特性を追加または削除する場合は、それらの変更を反映するようにレスポンスを適宜変更します。

SYNC レスポンスの例

リクエスト
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
レスポンス
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.COFFEE_MAKER",
        "traits": [
          "action.devices.traits.Cook",
          "action.devices.traits.TemperatureControl",
          "action.devices.traits.OnOff"
        ],
        "name": {
          "name": "Simple coffee maker"
        },
        "willReportState": true,
        "attributes": {
          "temperatureRange": {
            "minThresholdCelsius": 0,
            "maxThresholdCelsius": 100
          },
          "temperatureUnitForUX": "F",
          "supportedCookingModes": [
            "BREW"
          ],
          "foodPresets": [
            {
              "food_preset_name": "coffee_key",
              "supported_units": [
                "NO_UNITS",
                "CUPS"
              ],
              "food_synonyms": [
                {
                  "synonym": [
                    "Coffee"
                  ],
                  "lang": "en"
                }
              ]
            }
          ]
        },
        "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,
        "temperatureSetpointCelsius": 70,
        "currentCookingMode": "BREW",
        "currentFoodPreset": "coffee_key",
        "currentFoodQuantity": 2,
        "currentFoodUnit": "CUPS"
      }
    }
  }
}

EXECUTE コマンドの例

料理

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

リクエスト
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.Cook",
                "params": {
                  "start": false,
                  "cookingMode": "BREW"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
レスポンス
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "PENDING",
        "states": {
          "online": true,
          "currentCookingMode": "NONE",
          "currentFoodPreset": "NONE"
        }
      }
    ]
  }
}

SetTemperature

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

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

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
        }
      }
    ]
  }
}

デバイスエラー

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