智能家居安防系统指南
action.devices.types.SECURITYSYSTEM - 安防系统的报警器可以开启和关闭。它们的报警器可以设置为多个安全等级（例如，“在家”与“外出”），安防系统还可以报告有关某些传感器的信息，例如用于检测运动或打开的窗户的传感器。
此类型表示设备会获得“安全系统”图标以及一些相关的同义词和别名。
设备功能
如需了解实现详情（例如服务应支持的属性和状态），以及如何构建 EXECUTE 和 QUERY 响应，请参阅相应特征的文档。
必需特征
如果这些特征和命令适用于您的设备，则必须实现它们。如果设备不支持这些特征，请在 QUERY 或 EXECUTE 响应中输入错误代码 functionNotSupported。如需了解详情，请参阅错误和异常。
推荐的特征
如果这些特征适用于您的设备，建议您实现它们。 不过，您可以随意组合所有可用的特征，以最贴合您现有的产品功能。
示例设备：简单安全系统
此部分包含表示常见“安防系统”的 intent 载荷示例，这些示例基于上述设备类型和特征。如果您在实现中添加或移除了特征，请相应地修改响应以反映这些变化。
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": "EXCEPTIONS",
"states": {
"online": true,
"isArmed": false,
"currentArmLevel": "L2",
"currentStatusReport": [
{
"blocking": true,
"priority": 0,
"statusCode": "windowOpen",
"deviceTarget": "sensor_id1"
}
]
}
}
]
}
}启用双重身份验证
如果您的布防流程要求用户通过双重身份验证对话框输入 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 码。为了支持第二轮，您应该使用包含其他信息的 ackNeeded 质询进行响应，包括目标 ARM 级别和包含阻塞性异常的当前状态报告。
{ "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 } } ] } }