スマートホームのデバッグ

1. 始める前に

モノのインターネット(IoT)のデベロッパーは、Google Home アプリのタップ操作や Google アシスタントの音声コマンドを介してデバイスを操作できるスマートホーム アクションを作成できます。

a4657871181b5ad2.gif

スマートホーム アクションのデバッグツールについて学ぶことは、Google アシスタントと本番環境品質の統合を構築するための重要なステップです。モニタリングとデバッグを容易にするために、Google Cloud Platform(GCP)指標Loggingスマートホーム用テストスイートを使用して、アクションの問題を特定して解決することができます。

前提条件

作成するアプリの概要

この Codelab では、2 つの欠陥があるスマートホーム アクションをデプロイし、アシスタントに接続します。その後、スマートホームと Google Cloud Platform(GCP)の指標とロギング用のテストスイートを使用して、アクションの欠陥をデバッグします。

学習内容

  • GCP の指標とロギングを使用して本番環境の問題を特定し解決する方法
  • スマートホーム用テストスイートを使用して機能や API の問題を特定する方法

必要なもの

2. 問題のあるアプリを実行する

ソースコードを取得する

下のリンクをクリックして、この Codelab のサンプルを開発マシンにダウンロードします。

または、コマンドラインから GitHub リポジトリのクローンを作成することもできます。

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

プロジェクトについて

洗濯機アプリには次のサブディレクトリがあります。

  • public: スマート洗濯機の状態を簡単に制御してモニタリングするためのフロントエンド UI。
  • functions: Cloud Functions for FirebaseFirebase Realtime Database を使用してスマート洗濯機を管理する、完全に実装されたクラウド サービス。

Firebase に接続する

開発マシンでターミナルを開きます。washer-faulty ディレクトリに移動し、スマートホーム デバイスを Google アシスタントに接続するの Codelab で作成した Actions プロジェクトを使用して Firebase CLI を設定します。

$ cd washer-faulty
$ firebase use <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/<project-id>/overview
Hosting URL: https://<project-id>.firebaseapp.com

ホームグラフを更新する

ブラウザで Hosting URLhttps://<project-id>.firebaseapp.com)を開いてウェブアプリを表示します。ウェブ UI で [Refresh] ae8d3b25777a5e30.png ボタンをクリックして、[Request Sync] で HomeGraph を更新し、不具合のある洗濯機アプリの最新のデバイス メタデータを使用します。

6f2b1344179977cf.png

Google Home アプリを開き、「洗濯機の不良」という名前の洗濯機が表示されることを確認します。

e357de6a7faff925.png

3. アクションをテストする

プロジェクトをデプロイしたら、アクションが洗濯機を制御するかどうかをテストします。

洗濯機をテストする

スマートフォンから以下の音声コマンドのいずれかを試して、値の変化を確認します。

「OK Google, 洗濯機をオンにして。」

「OK Google, 洗濯を開始して。」

「OK Google, 洗濯機を一時停止して」

「OK Google, 洗濯を再開して」

「OK Google, 洗濯機を止めて。」

洗濯機を一時停止 / 再開すると、アシスタントから音声で応答があります。

「<プロジェクトの表示名> にアクセスできませんでした。」

この問題をデバッグするには、エラーを絞り込んで根本原因を特定するために、まずエラーに関する詳細情報が必要です。

Smarthome Analytics ダッシュボード

エラーを調べるには、Smarthome Analytics ダッシュボードが便利です。これは、クラウド フルフィルメントの使用状況と健全性の指標のグラフを集計するものです。

  • [Usage] 指標は、1 日のアクティブ ユーザー数やフルフィルメントへの合計リクエスト数など、スマートホーム アクションの使用傾向を反映しています。
  • [Health] 指標を使用すると、リクエストのレイテンシ、成功率、エラーの内訳など、スマートホーム アクションの異常発生をモニタリングできます。

エラーの原因を絞り込むには、以下の手順に沿ってプロジェクト ダッシュボードにアクセスします。

  1. Actions Console で、プロジェクト ページに移動します。
  2. スマートホーム プロジェクトを選択します。
  3. [Analytics](分析)タブを選択し、[Go to Google Cloud Platform](Google Cloud Platform に移動)をクリックします。

b1735bbe11a7aff8.png

  1. これにより、Google Cloud 上にあるプロジェクトのダッシュボードのリストが表示されます。[Google Home Analytics - Cloud Integration] ダッシュボードを選択します。

5edd3751323176dd.png

  1. [Cloud Fulfillment Events - Status Breakdown] グラフまでスクロールして、ハイライト表示された期間のエラーコードを表示します。

c468743c20a11c15.png

PARTNER_RESPONSE_MISSING_DEVICE エラーコードは、根本原因のヒントを提供します。次に、エラーコードに基づいてイベントログを取得して詳細を確認します。

イベントログにアクセスする

エラーの詳細を確認するには、Cloud Logging でスマートホーム アクションのイベントログにアクセスします。

プロジェクトのイベントログにアクセスするには、Google Cloud Platform でナビゲーション メニューを開き、[オペレーション] で [ロギング] > [ログ エクスプローラ] を選択します。または、検索ボックスで「ログ エクスプローラ」を検索することもできます。

[クエリ] セクションでクエリ PARTNER_RESPONSE_MISSING_DEVICE を入力し、[クエリを実行] をクリックします。クエリに一致するログが [クエリ結果] セクションに表示されます。

747cca0f1249a5a.png

エラーログには、次のようなエラーの詳細とともにスマートホーム イベントが表示されます。

  • ユーザーが行う操作は「洗濯機を再開」(actionType:STARTSTOP_UNPAUSE」)です。これは、最近失敗した音声コマンドに対応しています。
  • 関連付けられているデバッグ メッセージは「JSON response does not include device.」です

デバッグ メッセージに基づいて、洗濯機アプリの EXECUTE レスポンスに正しいデバイスが含まれていない理由を確認する必要があります。

エラーの根本原因を特定する

functions/index.js で、各コマンドのステータスとデバイスの新しい状態を返す EXECUTE ハンドラ(onExecute 配列内)を見つけます。EXECUTE レスポンスへのデバイス ID の挿入は、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

次の音声コマンドをもう一度試してみてください。洗濯機を一時停止 / 再開したときに、アシスタントが正しく応答するようになります。

「OK Google, 洗濯機を一時停止して。」

=>

「はい、洗濯機を一時停止します。」

「OK Google, 洗濯を再開して」

=>

「了解しました。洗濯機を再開します。」

質問して現在の洗濯機の状態を確認することもできます。

「OK Google, 洗濯機はオンになってる?」

「OK Google, 洗濯機は動いてる?」

「OK Google, 洗濯機の今のステップを教えて」

4. テストスイートでアクションをテストする

手動でテストするだけでなく、自動化されたスマートホーム用テストスイートを使用して、アクションに関連付けられたデバイスの種類やトレイトに基づいてユースケースを検証できます。テストスイートでは、アクションの問題を検出するための一連のテストが実行されます。また、失敗したテストケースについては有益なメッセージが表示されるので、イベントログを詳しく調べる前にデバッグを迅速に進めることができます。

スマートホーム用のテストスイートを実行する

テストスイートでスマートホーム アクションをテストする手順は次のとおりです。

  1. ウェブブラウザで、Test Suite for smart home を開きます。
  2. 右上のボタンを使用して Google にログインします。これにより、テストスイートから Google アシスタントに直接コマンドを送信できます。
  3. [プロジェクト ID] フィールドに、スマートホーム アクションのプロジェクト ID を入力します。[次へ] をクリックして先に進みます。
  4. [Test Settings] ステップに、洗濯機のデバイスの種類とトレイトが [Test Suite] に表示されます。

78ed6a1ebdb581bf.png

  1. 洗濯機のサンプルアプリには洗濯機の追加 / 削除 / 名前変更を行う UI がないため、[Test Request Sync] オプションを無効にします。本番環境システムでは、ユーザーがデバイスの追加、削除、名前の変更を行うたびに Request Sync をトリガーする必要があります。
  2. [次へ] をクリックしてテストの実行を開始します。

テストスイートの実行が完了したら、テストケースの結果を表示します。失敗したテストケースが 2 つあり、それぞれのエラー メッセージが示されます。

5838d10631c98ed2.png

スマートホーム アクションの障害をデバッグするには、まずエラー メッセージを分析してエラーの根本原因を特定する必要があります。

エラー メッセージを分析する

デベロッパーが根本原因を特定できるように、Test Suite は失敗したテストケースごとにエラー メッセージを表示し、失敗の理由を示します。

上記の最初の失敗したテストケースでは、

99e4e5d06965a8a7.png

エラー メッセージは、テストスイートではスマートホーム アクションから報告された状態に "isPause": true を想定しているが、実際の状態には "isPause": false しか含まれていないことを示しています。

また、2 番目に失敗したテストケースのエラー メッセージでは、スマートホーム アクションからの QUERY レスポンスの状態に "isPause": true が含まれていることがわかります。これは、スマートホーム アクションから報告された状態が "isPause": false と異なります。

fdb5124102e3a37.png

両方のエラー メッセージに基づいて、アクションが isPaused 状態を正しい値で報告するかどうかを確認する必要があります。

エラーの根本原因を特定する

functions/index.js を開きます。ここには、Report State を介してステータス変更をホームグラフに送信する 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,
      });
      ...
    });

エラーを修正する

エラーの根本原因を特定できたので、Report State ペイロードに 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 の指標、Logging のテストスイートを使用して、スマートホーム アクションの問題のトラブルシューティングを行う方法を学習しました。

詳細

この Codelab で学んだことを活かして、追加リソースを参照しながら以下の演習に挑戦してみましょう。

また、アクションをユーザーに公開するための認定プロセスなど、アクションを審査のためにテストして送信する方法の詳細もご確認ください。