智能家居安全系统指南

action.devices.types.SECURITYSYSTEM - 安防系统可以开启和关闭。它们可以开启多个安全等级（例如“在家”和“外出”），并可以报告有关某些传感器的信息，例如检测动作或打开的窗户的传感器。

此类型表示设备会获取“安全系统”图标和一些相关的 同义词和别名。

设备功能

请参阅相应的特征文档， 实现细节，例如您的服务应支持的属性和状态，以及如何 建立 EXECUTE 和 QUERY 响应。

必需的特征

如果适用于您的 设备。如果您的设备不支持这些特征，请输入 functionNotSupported（在 QUERY 或 EXECUTE 响应中）。请参阅 错误和异常。

建议你拥有以下特征（如果适用于你的设备）。 不过，你可以随意混搭所有可用特征，使其与现有的特征最匹配 产品功能。

质量要求

  • 延迟时间：必须小于或等于 2000 毫秒。
  • 可靠性：必须大于或等于 97%。

设备示例：简单的安防系统

本部分包含表示常见“安全系统”的 intent 载荷示例 。如果您在实现中添加或移除 trait， 对您的回答进行相应的修改，以反映这些修改。

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 助理 好的，从前窗拍摄 处于打开状态。正在将安防系统设为高安全模式
<ph type="x-smartling-placeholder">
</ph> <ph type="x-smartling-placeholder">
</ph>
请求
。 
{
    "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 助理 出错了 控制安防系统前窗是开着的
<ph type="x-smartling-placeholder">
</ph> <ph type="x-smartling-placeholder">
</ph>
请求
。 
{
    "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"
            }
          }]
        }]
      }
    }]
  }
回应 2
{
    "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 码或口令，然后进行确认。

示例：确认验证

本例显示了用户尝试开启安防系统报警器 系统检测到前门打开。用户确认 即使前门打开，系统也应开启。

用户 开启安防系统报警器。
Google 助理 前门是开着的 确定要开启安防系统吗？
用户 是。
Google 助理 好的，正在开启 安全系统

第一个回合，您应该以 ackNeeded 质询作为回复。

请求 1
。 
{
    "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
            }
          }]
        }]
      }
    }]
  }
回应 2
{
    "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 结果。

<ph type="x-smartling-placeholder">
</ph> <ph type="x-smartling-placeholder">
</ph>
请求 2
。 
{
    "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 质询作为回复。

请求 1
。 
{
  "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质询， 更多信息，包括目标实验组级别和带有 屏蔽异常

<ph type="x-smartling-placeholder">
</ph> <ph type="x-smartling-placeholder">
</ph>
请求 2
。 
{
  "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 码。

<ph type="x-smartling-placeholder">
</ph> <ph type="x-smartling-placeholder">
</ph>
请求 3
。 
{
  "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
        }
      }
    ]
  }
}