智能家居安防系统指南

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 trait 报告。异常可以报告为阻塞式或非阻塞式。

  • 如果报告的非阻塞式异常 的状态为“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"
            }
          }]
        }]
      }
    }]
  }
响应 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 码， 则必须确认用户是否要在存在活跃 异常（例如窗户或门已打开）的情况下继续开启系统 。

在这种情况下，可能需要先输入 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 结果。

请求 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质询进行响应，并提供其他信息，包括目标安保等级和包含阻塞式异常的当前状态报告。

请求 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 码。

请求 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
        }
      }
    ]
  }
}