适用于 Android Studio 的 Google Home 插件

Google Home Plugin for Android Studio 专为 Google Home 平台开发者设计和打造。借助此插件,您可以使用 Google Assistant Simulator、Cloud Logging 和其他工具,从而简化智能家居开发流程。

适用于 Android Studio 的 Google Home 插件

安全通知

如需阻止 Android Studio 存储 Secret 和密码,请完成以下步骤:

  1. 点击文件,然后点击设置...
  2. Appearance & Behavior 中,展开 System Settings,然后点击 Password
  3. 选择重启后不保存,忘记密码
适用于 Android Studio 的 Google Home 插件

特性

Google 助理模拟器

如需测试您的智能家居设备能否在 Google Home 生态系统中正常运行,您可以在不退出 Android Studio 的情况下随时与 Assistant Simulator 互动。

Actions on Google Console 控制台中提供的现有 Google 助理模拟器类似,Assistant Simulator 可让您通过输入查询内容轻松控制设备,例如“开灯”。Android Studio 中,Assistant Simulator 会根据您的命令返回短信,例如“好的,开灯”。

使用 Google 助理模拟器进行测试

查看 Cloud Logging

Google Cloud Logging 提供调试信息和关键指标,可让您深入了解 Action 的使用情况。为了简化开发,在排查问题期间,Google Home Plugin 会在您的代码旁边显示实时 Cloud Logging 消息。

您可以显示实时日志或选择日期范围。

Cloud Logging 视图

批量话语

对单一话语的 Assistant Simulator 响应具有不确定性。例如,响应可以是以下任一短语:

  • 知道了,正在打开这 2 盏灯。
  • 没问题,正在打开这 2 盏灯。
  • 知道了,正在打开这 2 盏灯。
  • 好的,正在打开这 2 盏灯。

如需运行自动化测试并验证您的 Google 集成是否能处理这些不同的响应,您可以通过运行话语脚本将批量话语发送到 Assistant Simulator。保存脚本后,您可以收集响应并对查询运行多个测试。

Home Graph 查看器

借助 Home Graph Viewer,您可以显示设备的状态,并在浏览器中启动 Google Home 测试套件

Android 调试桥 (adb) 日志查看器

Adb 日志查看器是一款工具,用于查看和分析日志文件,例如 Matter 设备日志文件、Google Home 日志和 Android 日志。

安装

如需在 Android Studio 中安装 Google Home Plugin,请按以下步骤操作:

  1. 下载或更新 Android Studio 下载 Android Studio
  2. 依次前往 File > Settings(在 MacOS 上,依次前往 Android Studio > Preferences)。
  3. Plugins 部分中,点击 Marketplace,然后搜索“google home”。
  4. 安装该工具并重启 Android Studio

您也可以直接从 JetBrains Marketplace 下载该插件。

设置

安装该插件后,您需要先完成以下步骤,然后才能使用 Assistant Simulator 和查看 Cloud Logging:

使用 Google 账号登录

您可以从 Google Home 面板登录您的开发者账号,授权 Android Studio 代表您与 Google 服务进行通信。

  1. 点击 Android Studio 窗口左侧纵向标签页列中的 Google 首页标签页。

  2. 使用以下账号登录部分,点击 Google 以启动浏览器。

    Android Studio Google 登录
  3. 选择与你的智能家居设备相关联的账号。

  4. 使用 Google 账号登录授权页面上,点击允许

  5. 关闭浏览器窗口,然后返回 Android Studio

You should now be logged in, with the option to Sign Out.

选择 Cloud 项目

登录后,从下拉列表中选择 Project。如需过滤项目列表,请输入 Filter 表达式,例如 matter,然后按 Enter

项目下拉列表会根据您的过滤条件加载前 100 个项目。当您退出 Android Studio 时,系统会保留您的选择。

选择项目

如需项目过滤条件方面的帮助,请参阅 Google Cloud 参考文档中的查询参数

使用 Google 助理模拟器

如需在 Android Studio 中打开 Assistant Simulator,请点击 Google Home Plugin 面板中的话语面板

打开话语面板

您可以通过多种方式向 Assistant Simulator 发送查询。接下来,我们将逐一介绍各个选项

输入查询并收集响应

如需与 Assistant Simulator 交互,请输入您的查询,然后按 Enter 键。

您可以点击查询末尾的 重新发送图标来重新发送查询。

提交一个或多个查询后,请点击 重放以重新运行查询并检查响应。话语面板会跟踪存储的缓存中的查询和响应。重放仅会将新响应添加到此内部缓存,不会在您每次点击按钮时复制查询。

使用 Google 助理模拟器重放话语

点击 保存,以保存您在话语面板中输入的查询和响应。您的互动将按以下格式转换为 JSON:

  • ask:您的查询。
  • answers:一组可能的 Assistant Simulator 响应。

您可以在 Android Studio 中修改此 JSON 文件。

{
  "collected": false,
  "lines": [
    {
      "ask": "turn lights on",
      "answers": [
        "OK, turning 2 lights on.",
        "Sure, turning on 2 lights."
      ]
    }
  ]
}

收集批量响应

Google Home Plugin 面板中,点击话语文件,以在新标签页中打开保存的 JSON 文件。在选择路径部分,您可以选择文件或文件夹。如果您选择了一个文件夹,CollectTest 将处理该文件夹中的所有话语 .json 文件。

您可以打开同一文件或不同文件的多个标签页,例如 lightslights(1)plug

状态栏会显示上次测试的结果(如果适用)、黄色或绿点(指示文件是否已收集)以及语音 .json 文件路径。点击 收集后,Assistant Simulator 会运行您的查询。当系统收集到新响应时,您会收到通知,并且在系统处理您的查询时,状态栏会显示一个计数器。

使用 Google 助理模拟器收集话语

Collect 完成后,Status Bar 会更新,.json 路径前面会显示一个绿色对勾标记,并且您的语音文件中将会填充可能的响应。

使用 Google 助理模拟器收集话语
{
  "collected": true,
  "lines": [
    {
      "ask": "turn lights on",
      "answers": [
        "OK, turning 2 lights on.",
        "Sure, turning on 2 lights.",
        "Sure, turning 2 lights on.",
        "Got it, turning 2 lights on.",
        "Alright, turning on 2 lights.",
        "OK, turning on 2 lights.",
        "Got it, turning on 2 lights.",
        "Alright, turning 2 lights on."
      ]
    }
  ]
}

如果您提前停止收集,则 .json 路径将不会被标记为“已收集”。

测试批量语音

收集到响应后,点击 测试即可重放查询并检查您的响应和日志。测试批量语音时,Assistant Simulator 需要保存到 JSON 文件中的响应。如果测试返回的响应尚未收集,您会收到类似于以下响应的通知:

Expected one of: "Got it, turning on 2 lights."

使用 Google 助理模拟器运行话语

此情形表示测试失败。否则,Assistant Simulator 将运行您的每个查询并返回响应。如果测试成功,状态栏中会显示 检查。

使用 Google 助理模拟器运行话语

查看 Cloud Logging

如需在 Cloud Logs 工具窗口中打开项目标签页,请点击 Google Home Plugin 面板中的 Cloud Logs。您可以为每个项目打开单独的 Cloud Log 标签页。

Cloud Logging 标签页

查询字词

对于所选项目,您还可以使用查询字段过滤日志。例如,如需过滤 light 关键字的日志,请使用以下代码:

Cloud Logging 查询

选择使用 QL 以使用 Logging 查询语言

Cloud Logging 查询语言

下面列举了一些 QL 查询示例,以帮助您上手:

severity = (DEBUG OR INFO OR NOTICE OR WARNING OR ERROR OR CRITICAL OR ALERT OR EMERGENCY) AND resource.type="assistant_action_project" AND timestamp > "2022-04-07T00:40:18Z"
jsonPayload.executionLog.executionResults.actionResults.action.trait = "TRAIT_ON_OFF"
jsonPayload.executionLog.executionResults.actionResults.action.actionType = "ONOFF_ON"

日期和时间查询

按日期查询日志也是可选操作,可以通过点击之后之前来启用。您可以在提供的文本字段(例如 5/11/22, 12:37 PM)中输入日期和时间格式,也可以使用日期选择器 来选择日期,然后在文本字段中输入时间。

  • 如需选择 5/1/22之后的日期,请选择之后,然后点击日期图标
  • 如需选择 5/1/22之前的日期,请选择早于,然后点击日期图标
  • 如需选择 5/1/226/30/22 之间的日期,请选择之前之后,然后从日期图标 中选择日期。

选择实时可提取实时项目日志。点击停止即可结束实时 Feed。

严重级别

您还可以从下拉列表中选择最低严重级别

查询结果

点击 提取以提交查询参数。

加载日志后,点击任意记录 即可展开完整的 JSON 载荷。再次点击 可显示完整消息。

(可选)您可以在过滤条件框中输入关键字以缩小日志结果的范围。点击 x 移除过滤条件并返回原始提取结果。

查看 Cloud Logging

查看 Home Graph 并运行测试

如需列出您的设备,请从 Google Home Plugin 面板中选择 Home Graph

点击 Refresh 以显示与所选项目关联的设备的 Device nameDevice idDevice type。您可以为不同的项目打开多个 Google Home Graph 面板。

加载设备后,点击任意记录 即可展开完整的 JSON 载荷。

Home Graph JSON 载荷

您还可以使用展开收起来显示和隐藏设备的 JSON 载荷。

Home Graph 展开和收起 JSON

如需针对特定设备启动测试套件,请点击 Test。这样会在浏览器中启动测试套件,选择您的设备并准备好进行测试。点击 Start,然后等待测试结果。

Home Graph 运行测试

测试完成后,您可以查看测试详细信息并查看日志。

Home Graph 已完成测试

Android 调试桥 (adb) 日志查看器

若要在 Adb 日志工具窗口中打开项目标签页,请点击 Google Home 插件工具栏(左侧)中的 Adb 日志命令。您可以为每个日志文件打开单独的“通告日志”标签页。如需删除标签页,请点击 图标。

使用选择字段选择要查看的特定日志记录组件,使用严重性下拉列表仅显示具有匹配日志严重性的条目。

对于所选的 adb 日志,您可以使用过滤条件字段和可选的区分大小写Regex 修饰符来过滤日志条目。

此外,您可以:

  • 使用 Find 字段和 Find Next 图标)和 Find Previous 图标)命令查找特定条目。
  • 使用可选的区分大小写Regex 修饰符。
  • 跳至行 (Jump to line) 可跳转到日志中的指定行(按数字)。

选择编号可查看已添加行号的日志行。选择 Raw 可查看原始日志条目。

adb 日志查看器

资源和反馈

点击资源,查看开发者工具和资源列表。

如需提交您对于我们如何使用 Google Home Plugin 改进开发体验的想法或反馈,请点击反馈

发送反馈