スマートホームオーブンガイド

action.devices.types.OVEN - オーブンで可能な操作には、特定の温度で焼く、またはあぶる機能が含まれます。オーブン内部の物理的な温度はオーブンの加熱状態に応じて変化するため、それを管理できる場合もあります。オーブンには、加熱の持続時間を制限する調理時間機能が備わっています。

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

オーブンには、action.devices.traits.OnOff と action.devices.traits.TemperatureControl に対するタイプベースの文法があります。

デバイスが OnOff に対応している場合、「オーブンを予熱して」と指定すると、action.devices.commands.OnOff コマンドが送信されます。
デバイスが TemperatureControl に対応している場合、「オーブンを 350 度に予熱して」と指定すると、オーブンをその温度に設定するコマンドが送信されます。

デバイスの機能

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

必須のトレイト

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

action.devices.traits.OnOff

推奨されるトレイト

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

品質要件

レイテンシ: 3,000 ms 以下にする必要があります。
信頼性: 97% 以上である必要があります。

デバイスの例: シンプルなオーブン

このセクションでは、上記のデバイスタイプとトレイトに基づいて一般的な「オーブン」を表すインテントペイロードの例を示します。実装でトレイトを追加または削除する場合は、変更を反映するようにレスポンスを変更します。

SYNC レスポンスの例

リクエスト

{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}

レスポンス

{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.OVEN",
        "traits": [
          "action.devices.traits.Cook",
          "action.devices.traits.OnOff",
          "action.devices.traits.TemperatureControl",
          "action.devices.traits.Timer",
          "action.devices.traits.StartStop"
        ],
        "name": {
          "name": "Simple oven"
        },
        "willReportState": true,
        "attributes": {
          "supportedCookingModes": [
            "BAKE",
            "CONVECTION_BAKE",
            "ROAST"
          ],
          "maxTimerLimitSec": 3600,
          "temperatureRange": {
            "minThresholdCelsius": 65,
            "maxThresholdCelsius": 288
          },
          "temperatureUnitForUX": "F"
        },
        "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,
        "isRunning": true,
        "temperatureSetpointCelsius": 175,
        "currentCookingMode": "BAKE",
        "timerRemainingSec": -1
      }
    }
  }
}

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": true,
                  "cookingMode": "ROAST"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

レスポンス

{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "currentCookingMode": "ROAST"
        }
      }
    ]
  }
}

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

SetTemperature

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

リクエスト

{
  "requestId": "6894439706274654520",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.SetTemperature",
                "params": {
                  "temperature": 200
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

レスポンス

{
  "requestId": "6894439706274654520",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "temperatureSetpointCelsius": 200,
          "temperatureAmbientCelsius": 100
        }
      }
    ]
  }
}