此页面由 Cloud Translation API 翻译。

Switch to English

智能家居安防系统指南

action.devices.types.SECURITYSYSTEM - 可以开启报警器或关闭报警器。他们可以通过多种安保等级（例如在家和外出）开启报警器，还可以报告特定传感器（例如，侦测到移动或打开的窗口的传感器）的相关信息。

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

设备功能

如需了解相应的实现详情（例如您的服务应支持的属性和状态），以及如何构建 EXECUTE 和 QUERY 响应，请参阅相应的特征文档。

所需特征

这些特征和指令（若适用于您的设备）是必需的。

action.devices.traits.ArmDisarm

质量要求

延迟时间：必须小于或等于 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"
        }
      }
    ]
  }
}

设备出错

查看错误和异常的完整列表。

举报报警异常

尝试开启或关闭系统时，您可以通过状态报告特征报告的异常代码提供额外的上下文。异常可以报告为阻塞或非阻塞。

报告为“SUCCESS”状态的非阻塞异常表示该异常不会阻止关闭/关闭报警器。
如果出现“屏蔽异常”状态报告为“EXCEPTIONS”，则表示已启用/关闭因这些异常而关闭的报警或关闭报警功能。

通常与安防系统关联的异常代码包括：

doorOpen：门打开了。
windowOpen：已打开一个窗口。
isOpen：传感器检测到某些内容处于打开状态（但不知道它是否是门或窗）。

注意：如果安防系统中心处于离线状态，则不应在 currentStatusReport 字段中报告，而应在常规 errorCode 字段中报告。

示例：非阻塞异常

此示例展示了一个非阻塞的异常情况，即使有人报告窗口为打开状态，安防系统也是如此。

用户级	将安防系统设为高安全性。
Google 助理	好，前窗打开了。正在将安防系统开启到高安全模式

注意：系统会根据响应中的 currentStatusReport 字段生成文字转语音“车窗打开”。

请求

{
  "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 助理	控制安防系统时出错。前窗是开着的

注意：系统会根据响应中的 currentStatusReport 字段生成文字转语音“车窗打开”。

请求

{
  "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": "SUCCESS",
        "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
        }
      }
    ]
  }
}

智能家居安防系统指南

设备功能

所需特征

推荐的特征

质量要求

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

SYNC 响应示例

QUERY 响应示例

EXECUTE 命令示例

ArmDisarm

设备出错

举报报警异常

示例：非阻塞异常

示例：屏蔽异常

使用双重验证启用报警器

示例：确认挑战

示例：PIN 码和确认验证