スマートホーム スプリンクラー ガイド
action.devices.types.SPRINKLER - スプリンクラーでは、起動と停止（またはオンとオフ）を行うことができます。タイマーやスケジュールに対応している場合もあります。
このタイプのデバイスは、スプリンクラー アイコンとそれに関連する類義語とエイリアスを示します。
デバイスの機能
サービスがサポートする属性や状態、EXECUTE レスポンスや QUERY レスポンスの作成方法など、実装の詳細については、対応するトレイトのドキュメントをご覧ください。
必要なトレイト
これらのトレイトとコマンドは、デバイスに応じて必要です。
推奨されるトレイト
これらのトレイトは、お使いのデバイスに推奨されます（推奨）。ただし、既存のプロダクトの機能に合わせて、利用可能なすべてのトレイトを自由に組み合わせてマッチングできます。
品質要件
- レイテンシ: 800 ミリ秒以下でなければなりません。
- 信頼性: 97% 以上である必要があります。
デバイスの例: シンプルなスプリンクラー
このセクションでは、上記のデバイスタイプとトレイトに基づく一般的な「スプリンクラー」を表すインテント ペイロードの例について説明します。実装でトレイトを追加または削除する場合は、その変更を反映するようにレスポンスを修正してください。
SYNC レスポンスの例
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.SPRINKLER",
"traits": [
"action.devices.traits.Timer",
"action.devices.traits.StartStop"
],
"name": {
"name": "Simple sprinkler"
},
"willReportState": true,
"attributes": {
"availableZones": [
"front",
"back"
],
"maxTimerLimitSec": 3600
},
"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,
"isRunning": true,
"activeZones": [
"front"
],
"timerRemainingSec": 300
}
}
}
}
EXECUTE コマンドの例
TimerStart
コマンド パラメータの詳細については、
action.devices.traits.Timer リファレンスをご覧ください。
{
"requestId": "6894439706274654518",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerStart",
"params": {
"timerTimeSec": 300
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654518",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 300
}
}
]
}
}
TimerAdjust
コマンド パラメータの詳細については、
action.devices.traits.Timer リファレンスをご覧ください。
{
"requestId": "6894439706274654520",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerAdjust",
"params": {
"timerTimeSec": -10
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654520",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 290
}
}
]
}
}
TimerPause
コマンド パラメータの詳細については、
action.devices.traits.Timer リファレンスをご覧ください。
{
"requestId": "6894439706274654522",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerPause"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654522",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 300,
"timerPaused": true
}
}
]
}
}
TimerResume
コマンド パラメータの詳細については、
action.devices.traits.Timer リファレンスをご覧ください。
{
"requestId": "6894439706274654524",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerResume"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654524",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 300,
"timerPaused": false
}
}
]
}
}
TimerCancel
コマンド パラメータの詳細については、
action.devices.traits.Timer リファレンスをご覧ください。
{
"requestId": "6894439706274654526",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerCancel"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654526",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": -1
}
}
]
}
}
StartStop
コマンド パラメータの詳細については、
action.devices.traits.StartStop リファレンスをご覧ください。
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.StartStop",
"params": {
"start": true,
"zone": "back"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"isRunning": true,
"activeZones": [
"back"
]
}
}
]
}
}