スマートホーム給湯器ガイド
action.devices.types.WATERHEATER - 給湯器は、水を加熱するためのデバイスです。電源のオンとオフを切り替えたり、水温を調整したりできます。
このタイプのデバイスには給湯器のアイコンが設定され、関連する類義語や別名が与えられます。
デバイスの機能
サービスがサポートする必要がある属性や状態、EXECUTE および QUERY レスポンスの作成方法など、実装の詳細については、対応するトレイトのドキュメントをご覧ください。
必要なトレイト
デバイスに適用可能な場合は、これらのトレイトとコマンドが必要です。デバイスがこれらのトレイトをサポートしていない場合は、QUERY または EXECUTE レスポンスに functionNotSupported のエラーコードを入力します。詳細については、エラーと例外をご覧ください。
推奨されるトレイト
デバイスに応じて、これらのトレイトをおすすめします。 ただし、既存のプロダクトの機能に合わせて、利用可能なすべてのトレイトを自由に組み合わせることができます。
品質要件
- レイテンシ: 800 ミリ秒以下。
- 信頼性: 97% 以上
デバイスの例: シンプルな給湯器
このセクションでは、上記のデバイスタイプとトレイトに基づいて一般的な「給湯器」を表すインテント ペイロードの例を示します。実装でトレイトを追加または削除した場合は、それに合わせてレスポンスを変更し、変更を反映します。
SYNC レスポンスの例
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.WATERHEATER",
"traits": [
"action.devices.traits.TemperatureControl",
"action.devices.traits.OnOff"
],
"name": {
"name": "Simple water heater"
},
"willReportState": true,
"attributes": {
"temperatureRange": {
"minThresholdCelsius": 25,
"maxThresholdCelsius": 100
},
"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": false,
"temperatureSetpointCelsius": 30
}
}
}
}
EXECUTE コマンドの例
設定温度
コマンド パラメータの詳細については、
action.devices.traits.TemperatureControl リファレンスをご覧ください。
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.SetTemperature",
"params": {
"temperature": 45
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"temperatureSetpointCelsius": 45
}
}
]
}
}
オンオフ
コマンド パラメータの詳細については、
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
}
}
]
}
}