スマートホーム セキュリティ システム ガイド
action.devices.types.SECURITYSYSTEM
- セキュリティ システムによる監視の開始と解除を行えます。また、複数のセキュリティ レベル(在宅と外出など)で監視させることができ、特定のセンサー(動きや開いている窓を検知するセンサーなど)に関する情報を報告できます。
このタイプのデバイスにはセキュリティ システム アイコンと、関連する類義語や別名が与えられます。
デバイスの機能
サービスがサポートする属性や状態、EXECUTE レスポンスや QUERY レスポンスの作成方法など、実装の詳細については、対応するトレイトのドキュメントをご覧ください。
必要なトレイト
デバイスに応じて、これらのトレイトとコマンドは必須です。デバイスがこれらのトレイトをサポートしていない場合は、QUERY または EXECUTE レスポンスに functionNotSupported
のエラーコードを入力します。詳細については、エラーと例外をご覧ください。
推奨されるトレイト
デバイスに応じて、これらのトレイトが推奨されます。 ただし、利用可能なすべてのトレイトを自由に組み合わせて、既存の製品機能に最も適合させることができます。
品質要件
- レイテンシ: 2000 ミリ秒以下
- 信頼性: 97% 以上
デバイスの例: シンプルなセキュリティ システム
このセクションでは、上記のデバイスタイプとトレイトに基づく一般的な「セキュリティ システム」を表すインテント ペイロードの例を紹介します。実装でトレイトを追加または削除した場合は、その変更を反映するようにレスポンスを適宜変更してください。
SYNC レスポンスの例
{ "requestId": "6894439706274654512", "inputs": [ { "intent": "action.devices.SYNC" } ] }
{ "requestId": "6894439706274654512", "payload": { "agentUserId": "user123", "devices": [ { "id": "123", "type": "action.devices.types.SECURITYSYSTEM", "traits": [ "action.devices.traits.StatusReport", "action.devices.traits.ArmDisarm" ], "name": { "name": "Simple security system" }, "willReportState": true, "attributes": { "availableArmLevels": { "levels": [ { "level_name": "home_key", "level_values": [ { "level_synonym": [ "Home and Guarding", "level 1", "home", "SL1" ], "lang": "en" } ] }, { "level_name": "away_key", "level_values": [ { "level_synonym": [ "Away and Guarding", "level 2", "away", "SL2" ], "lang": "en" } ] } ], "ordered": true } }, "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, "isArmed": true, "currentArmLevel": "home_key", "currentStatusReport": [ { "blocking": false, "deviceTarget": "123", "priority": 0, "statusCode": "lowBattery" } ] } } } }
サンプル EXECUTE コマンド
ArmDisarm
コマンド パラメータの詳細については、
action.devices.traits.ArmDisarm
リファレンスをご覧ください。
{ "requestId": "6894439706274654516", "inputs": [ { "intent": "action.devices.EXECUTE", "payload": { "commands": [ { "devices": [ { "id": "123" } ], "execution": [ { "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "armLevel": "away_key" } } ] } ] } } ] }
{ "requestId": "6894439706274654516", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "isArmed": true, "currentArmLevel": "away_key" } } ] } }
デバイスエラー
エラーと例外の全リストをご覧ください。監視の例外を報告する
システムの監視、監視の解除を行う際は、StatusReport トレイトで報告する例外コードを使用して、追加のコンテキストを提供できます。例外は、ブロックまたは非ブロックとして報告できます。
- 「SUCCESS」ステータスでレポートされる非ブロック例外は、例外によって監視または監視解除が妨げられなかったことを示します。
- 「EXCEPTIONS」ステータスで報告されるブロック例外は、監視または監視解除がこれらの例外のために停止されたことを示します。
セキュリティ システムに関連する例外コードには、次のようなものがあります。
doorOpen
: ドアが開いています。windowOpen
: ウィンドウが開いています。isOpen
: センサーが、何かが開いていることを検出しました(ただし、それがドアか窓かはわかりません)。
例: 非ブロック例外
この例は、ウィンドウが開いていると報告されているにもかかわらず、セキュリティ システムが監視する非ブロック例外を示しています。
ユーザー | セキュリティシステムを高セキュリティに設定します。 |
Google アシスタント | 前の窓が開いています。セキュリティ システムを高セキュリティに設定します。 |
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [{ "intent": "action.devices.EXECUTE", "payload": { "commands": [{ "devices": [{ "id": "123" }], "execution": [{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "armLevel": "L2" } }] }] } }] }
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "isArmed": true, "currentArmLevel": "L2", "currentStatusReport": [ { "blocking": false, "priority": 0, "statusCode": "windowOpen", "deviceTarget": "sensor_id1" } ] } } ] } }
例: ブロックの例外
ユーザー | セキュリティシステムを高セキュリティに設定します。 |
Google アシスタント | セキュリティ システムの制御中にエラーが発生しました。正面の窓が開いています。 |
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [{ "intent": "action.devices.EXECUTE", "payload": { "commands": [{ "devices": [{ "id": "123" }], "execution": [{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "armLevel": "L2" } }] }] } }] }
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "isArmed": false, "currentArmLevel": "L2", "currentStatusReport": [ { "blocking": true, "priority": 0, "statusCode": "windowOpen", "deviceTarget": "sensor_id1" } ] } } ] } }
2 要素認証による監視
監視フローにおいて、ユーザーに 2 要素認証ダイアログから PIN を入力する必要がある場合は、アクティブな例外が発生したとき(窓やドアが開いているときなど)にシステムの監視を続行するかどうかをユーザーが確認する必要があります。
このシナリオでは、PIN とパスフレーズの両方を入力し、確認応答を求める場合があります。
例: 確認チャレンジ
この例は、ユーザーがセキュリティ システムを作動させようとしているものの、玄関のドアが開いていると検出される様子を示しています。ユーザーは、玄関のドアが開いていても、セキュリティ システムが動作することを確認しています。
ユーザー | セキュリティ システムを作動させます。 |
Google アシスタント | 玄関のドアは開いています。 セキュリティ システムを作動してもよろしいですか? |
ユーザー | はい、できます。 |
Google アシスタント | はい、セキュリティ システムによる監視を開始します。 |
最初のターンで、ackNeeded
チャレンジで応答します。
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [{ "intent": "action.devices.EXECUTE", "payload": { "commands": [{ "devices": [{ "id": "123" }], "execution": [{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true } }] }] } }] }
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "commands": [ { "ids": [ "123" ], "status": "ERROR", "errorCode": "challengeNeeded", "challengeNeeded": { "type": "ackNeeded" }, "states": { "isArmed": true, "currentArmLevel": "L2", "currentStatusReport": [ { "blocking": false, "priority": 0, "statusCode": "doorOpen", "deviceTarget": "456" } ] } } ] } }
その後の Google からのリクエストには ack
の結果が含まれます。
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [{ "intent": "action.devices.EXECUTE", "payload": { "commands": [{ "devices": [{ "id": "123" }], "execution": [{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true }, "challenge": { "ack": true } }] }] } }] }
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "isArmed": true } } ] } }
例: PIN と確認応答の確認
この例は、PIN の入力を必要とするセキュリティ システムを作動させようとしているユーザーを示しています。前面と背面のウィンドウが開いていることをシステムが検出し、監視を続行することを確認するようユーザーに求めます。
ユーザー | 監視して外出。 |
Google アシスタント | PIN を教えてください。 |
ユーザー | 1234. |
Google アシスタント | 前面のウィンドウと背面のウィンドウが開いているようです。セキュリティ システムの監視を外出中に実行してもよろしいですか? |
ユーザー | はい、できます。 |
Google アシスタント | わかりました。外出用にセキュリティ システムを作動させます |
最初のターンでは、標準の pinNeeded
チャレンジで応答する必要があります。
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [{ "intent": "action.devices.EXECUTE", "payload": { "commands": [{ "devices": [{ "id": "123" }], "execution": [{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true } }] }] } }] }
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "commands": [{ "ids": ["456"], "status": "ERROR", "errorCode": "challengeNeeded", "challengeNeeded": { "type": "pinNeeded" } }] } }
Google から、提供された PIN を含むリクエストが送信されます。2 番目のターンをサポートするには、ackNeeded
チャレンジで、対象テスト群のレベルやブロック例外を含む現在のステータス レポートを含む追加情報を返す必要があります。
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [{ "intent": "action.devices.EXECUTE", "payload": { "commands": [{ "devices": [...], "execution": [{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "armLevel": "away" }, "challenge": { "pin": "1234" } }] }] } }] }
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "commands": [{ "ids": ["456"], "status": "ERROR", "states": { "targetArmLevel": "away", "currentStatusReport": [{ "blocking": true, "priority": 1, "deviceTarget": "front_window_id", "statusCode": "deviceOpen" }, { "blocking": true, "priority": 1, "deviceTarget": "back_window_id", "statusCode": "deviceOpen" } ] }, "errorCode": "challengeNeeded", "challengeNeeded": { "type": "ackNeeded" } }] } }
Google から次に行われるリクエストには、ack
の結果のみが含まれ、最初のターンで提供された PIN は含まれません。
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [{ "intent": "action.devices.EXECUTE", "payload": { "commands": [{ "devices": [...], "execution": [{ "command": "action.devices.commands.ArmDisarm", "params": { "arm": true, "armLevel": "away" }, "challenge": { "ack": true } }] }] } }] }
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "isArmed": true } } ] } }