スマートホーム蛇口ガイド
action.devices.types.FAUCET - 蛇口からさまざまな量やプリセットで液体を移すことができます。中にはさまざまなモードを備えた蛇口もあり、各モードにはそれぞれ固有の設定があります。これらは蛇口に固有であり、一般化された形式で解釈されます。
このタイプは、デバイスに蛇口アイコン、関連する類義語、エイリアスを受け取ることを示します。
デバイスの機能
サービスがサポートする属性や状態、EXECUTE レスポンスと QUERY レスポンスの構築方法など、実装の詳細については、対応するトレイトのドキュメントをご覧ください。
推奨されるトレイト
これらのトレイトは、お客様のデバイスに該当する場合におすすめです。 ただし、既存のプロダクトの機能に合わせて、使用可能なすべてのトレイトを自由に組み合わせて使用できます。
-
action.devices.traits.Dispense -
action.devices.traits.StartStop -
action.devices.traits.TemperatureControl
品質要件
- レイテンシ: 800 ミリ秒以下
- 信頼性: 97% 以上を指定します。
デバイスの例: 蛇口がシンプルな
このセクションでは、上記のデバイスタイプとトレイトに基づいた、一般的な「蛇口」を表すインテント ペイロードの例について説明します。実装でトレイトを追加または削除する場合は、その変更を反映するようにレスポンスを変更します。
SYNC レスポンスの例
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.FAUCET",
"traits": [
"action.devices.traits.Dispense",
"action.devices.traits.TemperatureControl",
"action.devices.traits.OnOff"
],
"name": {
"name": "Simple faucet"
},
"willReportState": true,
"attributes": {
"supportedDispenseItems": [
{
"item_name": "water_key",
"item_name_synonyms": [
{
"lang": "en",
"synonyms": [
"Water"
]
},
{
"lang": "es",
"synonyms": [
"Agua"
]
},
{
"lang": "fr",
"synonyms": [
"Eau"
]
}
],
"supported_units": [
"TEASPOONS",
"TABLESPOONS",
"FLUID_OUNCES",
"CUPS",
"PINTS",
"QUARTS",
"GALLONS",
"MILLILITERS",
"LITERS",
"DECILITERS"
],
"default_portion": {
"amount": 2,
"unit": "CUPS"
}
}
],
"supportedDispensePresets": [
{
"preset_name": "cat_water_bowl_key",
"preset_name_synonyms": [
{
"lang": "en",
"synonyms": [
"Cat water bowl",
"Cat water dish",
"Cat water cup"
]
},
{
"lang": "es",
"synonyms": [
"Plato de agua para gato",
"Bebedero para gato"
]
},
{
"lang": "fr",
"synonyms": [
"Bol d'eau de chat",
"Bac \u00e0 eau pour chat",
"Tasse d'eau de chat"
]
}
]
}
],
"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,
"dispenseItems": [
{
"itemName": "water_key",
"amountLastDispensed": {
"amount": 2.5,
"unit": "CUPS"
},
"isCurrentlyDispensing": false
}
]
}
}
}
}
EXECUTE コマンドの例
Dispense
コマンド パラメータの詳細については、
action.devices.traits.Dispense リファレンスをご覧ください。
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.Dispense",
"params": {
"amount": 1,
"unit": "CUPS",
"item": "water_key"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"dispenseItems": [
{
"itemName": "water_key",
"amountLastDispensed": {
"amount": 1,
"unit": "CUPS"
},
"isCurrentlyDispensing": true
}
]
}
}
]
}
}
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": 65
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654518",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"temperatureSetpointCelsius": 65
}
}
]
}
}
オン
コマンド パラメータの詳細については、
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
}
}
]
}
}