调试智能家居

1. 准备工作

作为一名物联网 (IoT) 开发者，您可以构建云到云集成，让用户能够通过 Google Home 应用中的触控功能和 Google 助理的语音指令来控制设备。

a4657871181b5ad2.gif

了解适用于云到云集成的调试工具，是构建与 Google 助理相集成的正式版产品的重要一步。为了便于轻松监控和调试，Google Cloud Platform (GCP) 指标、日志记录和智能家居测试套件可帮助您发现和解决集成问题。

前提条件

构建内容

在本 Codelab 中，您将部署一个存在 2 个缺陷的云到云集成并将其关联到 Google 助理，然后通过智能家居测试套件和 Google Cloud Platform (GCP) 指标和日志记录功能调试集成的缺陷。

学习内容

  • 如何使用 GCP Metrics 和 Logging 来识别和解决生产问题
  • 如何使用智能家居测试套件来查找功能和 API 问题

所需条件

2. 运行有故障的应用

获取源代码

点击以下链接，将此 Codelab 的示例下载到您的开发机器上：

...或者，您也可以通过命令行克隆 GitHub 代码库：

$ git clone https://github.com/google-home/smarthome-debug.git

项目简介

洗衣机应用包含以下子目录：

关联到 Firebase

在开发机器上打开终端。前往 washer-faulty 目录，然后使用在将智能家居设备连接到 Google 助理 Codelab 中构建的集成项目设置 Firebase CLI：

$ cd washer-faulty
$ firebase use <firebase-project-id>

部署到 Firebase

前往 functions 文件夹，然后使用 npm. 安装所有必要的依赖项

$ cd functions
$ npm install

注意：如果您看到以下消息，可以忽略并继续操作。此警告是由于一些较旧的依赖项而导致的，您可以点击此处了解详情。

found 5 high severity vulnerabilities
  run `npm audit fix` to fix them, or `npm audit` for details

依赖项安装完毕且配置好项目后，您就可以部署有故障的洗衣机应用了。

$ firebase deploy

您应该会看到以下控制台输出：

...

✔ Deploy complete!

Project Console: https://console.firebase.google.com/project/<Firebase-project-id>/overview
Hosting URL: https://<Firebase-project-id>.firebaseapp.com

更新 HomeGraph

在浏览器 (https://<firebase-project-id>.firebaseapp.com) 中打开托管网址以查看此 Web 应用。在 Web 界面中，点击 Refreshae8d3b25777a5e30.png 按钮，通过请求同步将故障洗衣机应用中的最新设备元数据更新到 HomeGraph：

6f2b1344179977cf.png

打开 Google Home 应用，然后验证您能否看到名为 Faulty Washer 的洗衣机设备。

e357de6a7faff925.png

3. 测试集成

部署项目后，请测试集成是否能够控制洗衣机。

测试洗衣机

通过手机尝试下达以下任意一条语音指令，查看值的变化：

“Ok Google，启动洗衣机。”

“Ok Google，运行洗衣机。”

“Hey Google，让洗衣机暂停运行。”

“Hey Google，让洗衣机恢复运行。”

“Ok Google，让洗衣机停止运行。”

您会注意到，当您暂停 / 继续运行洗衣机时，Google 助理会通过语音响应，告知您出现了问题：

“很抱歉，我联系不上 <project display name>。”

如需调试此问题，您首先需要了解有关该错误的更多信息，以便缩小范围并找出根本原因。

“智能家居分析”信息中心

Smarthome Analytics 信息中心是一个不错的检查错误位置，该信息中心会汇总云执行方式的使用情况和运行状况指标图表：

  • 使用情况指标反映了云到云集成的使用趋势，包括每日活跃用户数和对您的执行服务的请求总数。
  • 运行状况指标可帮助您监控云到云集成出现的异常情况，包括请求延迟时间、成功百分比和错误细分。

如需缩小错误原因范围，请按照以下步骤访问项目信息中心。

  1. 在 Developer Console 中，前往“项目”页面。
  2. 选择你的智能家居项目。
  3. 点击左侧菜单中的数据分析标签页。

b1735bbe11a7aff8.png

  1. 这会打开 Google Cloud 上项目的信息中心列表。选择 Google Home Analytics - Cloud Integration 信息中心。

5edd3751323176dd.png

  1. 向下滚动到 Cloud Fulfillment Errors - Status Breakdown 图表，查看选中时间范围内的错误代码。

c468743c20a11c15.png

PARTNER_RESPONSE_MISSING_DEVICE 错误代码会提供有关根本原因的提示。接下来，根据错误代码检索事件日志以获取更多详细信息。

访问事件日志

如需详细了解该错误，请通过 Cloud Logging 访问云到云集成的事件日志。

在 Google Cloud Platform 中打开导航菜单，然后在运维下，依次选择 Logging > Logs Explorer 以访问项目的事件日志。或者，您也可以在搜索框中搜索 Logs Explorer。

在搜索所有字段输入字段中，输入查询 PARTNER_RESPONSE_MISSING_DEVICE，然后点击运行查询。与查询匹配的日志会显示在结果部分中。

747cca0f1249a5a.png

错误日志会显示一条智能家居事件，其中包含错误详情，指明：

  • 用户执行的操作是“继续使用洗衣机”(actionType:“STARTSTOP_UNPAUSE”)，与最近失败的语音指令相对应。
  • 关联的调试消息为“JSON response does not include device.”

根据调试消息，您应检查洗衣机应用在 EXECUTE 响应中未包含正确设备的原因。

找出错误的根本原因

在 functions/index.js 中，找到用于返回每个命令的状态和新设备状态的 EXECUTE 处理程序（在 onExecute 数组中）。将设备 ID 插入 EXECUTE 响应取决于 updateDevice 函数的解析：

index.js

app.onExecute(async (body) => {
 ...

 for (const command of intent.payload.commands) {
   for (const device of command.devices) {
     for (const execution of command.execution) {
       executePromises.push(
           updateDevice(execution, device.id)
               .then((data) => {
                 result.ids.push(device.id);
                 Object.assign(result.states, data);
               })
               .catch((e) =>
                 functions.logger.error('EXECUTE',
                     device.id, e.message)));
     }
   }
 }

进一步检查 updateDevice 函数如何处理洗衣机的暂停 / 继续操作，您会发现与暂停 / 继续命令匹配的字符串不正确：

index.js

const updateDevice = async (execution, deviceId) => {
 const {params, command} = execution;
 let state; let ref;
 switch (command) {
   ...
   case 'action.devices.commands.PauseUnpausePause':
     state = {isPaused: params.pause};
     if (params.pause) state.isRunning = false;
     ref = firebaseRef.child(deviceId).child('StartStop');
     break;
 }

 return ref.update(state)
     .then(() => state);
};

修正错误

现在，您已经确定了错误的根本原因，可以更正暂停 / 继续命令的字符串了：

index.js

const updateDevice = async (execution, deviceId) => {
 const {params, command} = execution;
 let state; let ref;
 switch (command) {
   ...
   case 'action.devices.commands.PauseUnpause':
     state = {isPaused: params.pause};
     if (params.pause) state.isRunning = false;
     ref = firebaseRef.child(deviceId).child('StartStop');
     break;
 }

 return ref.update(state)
     .then(() => state);
};

测试修复程序

使用 Firebase CLI 部署更新后的代码：

firebase deploy --only functions

请重试以下语音指令，您会发现现在当您暂停 / 继续运行洗衣机时，Google 助理会做出正确的响应。

“Ok Google，让洗衣机暂停运行。”

=>

“好的，正在暂停洗衣机。”

"Hey Google，让洗衣机恢复运行。”

=>

“知道了，正在恢复洗衣机。”

您还可以通过提问来测试洗衣机的当前状态。

“Ok Google，我的洗衣机启动了吗？”

“Ok Google，我的洗衣机在运行吗？”

“Ok Google，我的洗衣机洗到哪一步了？”

4. 使用 Test Suite 测试集成

除了手动测试之外，您还可以使用自动化的智能家居测试套件，以根据与您的集成关联的设备类型和特征来验证用例。测试套件会运行一系列测试来检测集成中的问题，并针对失败的测试用例显示信息丰富的消息，以便您在深入研究事件日志之前加快调试速度。

运行智能家居测试套件

请按照以下说明通过 Test Suite 测试云到云集成：

  1. 在网络浏览器中，打开智能家居测试套件。
  2. 使用右上角的按钮登录 Google。这样一来，测试套件便可直接将命令发送给 Google 助理。
  3. 在 Project ID 字段中，输入云到云集成的项目 ID。然后，点击下一步以继续。
  4. 在测试设置步骤中，您会看到“测试套件”列出了洗衣机的设备类型和特征。

78ed6a1ebdb581bf.png

  1. 停用 Test Request Sync 选项，因为示例洗衣机应用没有用于添加 / 移除 / 重命名洗衣机的界面。在正式版系统中，每当用户添加 / 移除 / 重命名设备时，您都必须触发请求同步。
  2. 点击下一步开始运行测试。

测试套件运行完毕后，查看测试用例的结果。您会注意到，系统捕获了两个失败的测试用例，并显示了相应的错误消息：

5838d10631c98ed2.png

如需对云到云集成进行调试以查明失败原因，您需要先分析错误消息，找出错误的根本原因。

分析错误消息

为了帮助开发者找出根本原因，测试套件会针对每个失败的测试用例显示错误消息，指明失败原因。

对于上面第一个失败的测试用例，

99e4e5d06965a8a7.png

其错误消息表明，测试套件预计从云到云集成报告的状态中包含 "isPause": true，但实际状态仅包含 "isPause": false。

此外，第二个失败的测试用例的错误消息表明，云到云集成从 QUERY 响应中返回的状态包括 "isPause": true，这与云到云集成报告的状态 "isPause": false 不同：

fdb5124102e3a37.png

然后，根据这两条错误消息，您应检查集成报告中 isPaused 的值是否正确。

找出错误的根本原因

打开 functions/index.js，其中包含通过报告状态将状态更改发布到 Home Graph 的 reportstate 函数。检查“Report State”载荷，您会发现该载荷缺少 isPaused 状态，而测试套件正是在失败的测试用例中检查了该状态。

index.js

exports.reportstate = functions.database.ref('{deviceId}').onWrite(
    async (change, context) => {
      ...

      const requestBody = {
        requestId: 'ff36a3cc', /* Any unique ID */
        agentUserId: USER_ID,
        payload: {
          devices: {
            states: {
              /* Report the current state of our washer */
             [context.params.deviceId]: {
                online: true,
                on: snapshot.OnOff.on,
                isRunning: snapshot.StartStop.isRunning,
                currentRunCycle: [{
                  currentCycle: 'rinse',
                  nextCycle: 'spin',
                  lang: 'en',
                }],
                currentTotalRemainingTime: 1212,
                currentCycleRemainingTime: 301,
              },
            },
          },
        },
      };

      const res = await homegraph.devices.reportStateAndNotification({
        requestBody,
      });
      ...
    });

修正错误

现在，您已找出错误的根本原因，接下来请向“报告状态”载荷添加 isPaused 状态，以修改 functions/index.js：

index.js

exports.reportstate = functions.database.ref('{deviceId}').onWrite(
    async (change, context) => {
      ...

      const requestBody = {
        requestId: 'ff36a3cc', /* Any unique ID */
        agentUserId: USER_ID,
        payload: {
          devices: {
            states: {
              /* Report the current state of our washer */
             [context.params.deviceId]: {
                online: true,
                on: snapshot.OnOff.on,
                isPaused: snapshot.StartStop.isPaused,
                isRunning: snapshot.StartStop.isRunning,
                currentRunCycle: [{
                  currentCycle: 'rinse',
                  nextCycle: 'spin',
                  lang: 'en',
                }],
                currentTotalRemainingTime: 1212,
                currentCycleRemainingTime: 301,
              },
            },
          },
        },
      };
      ...
    });

测试修复程序

使用 Firebase CLI 部署更新后的代码：

$ firebase deploy --only functions

重新运行智能家居测试套件，您会发现所有测试用例均已通过。

148837f85d377dd6.png

5. 恭喜

17d485868a6771bc.png

恭喜！您已成功了解如何通过智能家居和 GCP 指标和日志记录测试套件排查云到云集成问题。

了解详情

在此 Codelab 的基础上，尝试做以下练习并浏览其他资源：

您还可以详细了解如何测试和提交集成以供审核，包括用于向用户发布集成的认证流程。