智能家居安全系统指南
action.devices.types.SECURITYSYSTEM
- 安防系统可以开启和关闭。它们可以开启多个安全等级(例如“在家”和“外出”模式),并且可以报告有关某些传感器的信息,例如用于检测动作或打开的窗户的传感器。
此类型表示设备会获取“安全系统”图标以及一些相关的同义词和别名。
设备功能
如需了解实现详情(例如服务应支持的属性和状态,以及如何构建 EXECUTE 和 QUERY 响应),请参阅相应的 trait 文档。
必需的特征
必须具备这些特征和命令(如果适用于您的设备)。如果您的设备不支持这些特征,请在 QUERY 或 EXECUTE 响应中输入错误代码 functionNotSupported
。如需了解详情,请参阅错误和异常。
推荐特征
建议采用这些特征(如果适用于您的设备)。 不过,您可以随意混搭所有可用的特征,以最好地匹配您现有的产品功能。
质量要求
- 延迟时间:必须小于或等于 2000 毫秒。
- 可靠性:必须大于或等于 97%。
设备示例:简单的安防系统
本部分包含基于上述设备类型和特征表示常见“安全系统”的 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
:传感器检测到东西开着(但不知道是门还是窗)。
示例:非阻塞异常
此示例展示了一个非阻塞异常,其中即使某个窗口被报告为打开,安防系统也处于开启状态。
User | 将安防系统的安保等级设为高 |
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"
}
]
}
}
]
}
}
示例:阻塞异常
User | 将安防系统的安保等级设为高 |
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 码或口令,然后进行确认。
示例:确认验证
该示例显示了用户尝试开启安防系统报警器,但系统检测到前门处于打开状态。用户确认即使前门打开,安防系统也应开启。
User | 开启安防系统报警器。 |
Google 助理 | 前门是开着的。 确定要开启安防系统吗? |
User | 是。 |
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 码来报警安防系统。 系统检测到前窗和后窗已打开,并要求用户确认应继续开启报警器。
User | 伸出手臂。 |
Google 助理 | 您的 PIN 码是什么? |
User | 1234。 |
Google 助理 | 前窗和后窗好像是开着的。确定要继续开启安防系统并开启远离模式吗? |
User | 是。 |
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
质询响应并提供更多信息,包括目标实验组级别和包含阻止异常的当前状态报告。
{ "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 } } ] } }