Google Home Developer Center へようこそ。スマートホームアクションの開発方法を学習できます。注: アクションの構築は、引き続き Actions Console で行います。

このページは Cloud Translation API によって翻訳されました。

スマートホームをデバッグする

1. 始める前に

モノのインターネット（IoT）の開発者は、スマートホームアクションを構築して、ユーザーが Google Home アプリのタップ操作や Google アシスタントの音声コマンドでデバイスを操作できるようにすることができます。

スマートホームアクションのデバッグツールを学習することは、本番環境の品質を Google アシスタントと統合するための重要なステップです。モニタリングとデバッグを簡単に行えるように、Google Cloud Platform（GCP）の指標、ロギング、スマートホーム用テストスイートを使用して、アクションの問題を特定して解決できます。

前提とする環境

スマートホームアクションの作成に関するデベロッパーガイドを読む
スマートホームデバイスを Google アシスタントに接続する Codelab を実行する

作業内容

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

学習内容

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

必要なもの

ウェブブラウザ（Google Chrome など）
Google Home アプリがインストールされた iOS または Android デバイス
Node.js バージョン 10.16 以降
Google Cloud 請求先アカウント

2. 障害が発生したアプリを実行する

ソースコードを取得する

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

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

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

プロジェクトについて

洗濯アプリには、次のサブディレクトリが含まれています。

public: スマート洗濯機の状態を簡単に制御してモニタリングするためのフロントエンド UI。
functions: Cloud Functions for Firebase と Firebase 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

HomeGraph を更新する

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

Google Home アプリを開き、[不具合のある洗濯機] という洗濯機が表示されていることを確認します。

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

プロジェクトのデプロイ後、アクションで洗濯機を制御していることを確認します。

洗濯機をテストする

スマートフォンで以下の音声コマンドを試して、値の変更を確認します。

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

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

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

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

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

洗濯を一時停止または再開すると、アシスタントは何かエラーがあることを応答します。

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

この問題をデバッグするには、まずエラーの詳細を確認して、根本原因を特定する必要があります。

スマートホーム分析ダッシュボード

エラーを調べるには、Smart Analytics Analytics ダッシュボードがおすすめです。これは、Cloud フルフィルメントの使用状況と健全性の指標をまとめたグラフです。

使用状況の指標には、スマートホームアクションの使用状況の傾向（1 日のアクティブユーザー数、フルフィルメントに対する合計リクエスト数など）が反映されます。
[Health] 指標を使用すると、スマートホームアクションの異常な発生をモニタリングでき、リクエストのレイテンシ、成功率、エラーの内訳をカバーできます。

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

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

Google Cloud のプロジェクトのダッシュボードのリストが表示されます。[Google Home Analytics - Cloud Integration] ダッシュボードを選択します。

5edd3751323176dd

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

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

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

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

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

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

エラーログには、スマートホームイベントに関するエラーの詳細が表示されます。

ユーザーの操作は「resumasher」（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

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

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

「かしこまりました。洗濯機を一時停止します。」

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

「かしこまりました。洗濯機を再開します。」

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

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

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

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

4. テストスイートを使用してアクションをテストする

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

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

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

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

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

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

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

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

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

上記の最初の失敗したテストケースの場合、

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

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

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

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

Report State からホームグラフに状態変化を送信する reportstate 関数を含む functions/index.js を開きます。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 状態を Report State ペイロードに追加して、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

スマートホーム用のテストスイートを再実行すると、すべてのテストケースに合格しています。

5. 完了

これで完了です。スマートホームと GCP の指標とロギングについて、Test Suite を使用してスマートホームアクションの問題を解決する方法を学習しました。

詳細

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

その他のサポートされているトレイトをデバイスに追加し、テストスイートを使用してテストします。
ダッシュボードを作成してアラートを設定し、指標データにプログラムでアクセスして、アクションに関する有用な使用状況の指標を取得します。
スマートホーム用のローカルフルフィルメントを確認する。
詳しくは、GitHub サンプルをご確認ください。

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

スマートホームをデバッグする

1. 始める前に

前提とする環境

作業内容

学習内容

必要なもの

2. 障害が発生したアプリを実行する

ソースコードを取得する

プロジェクトについて

Firebase に接続する

Firebase にデプロイする

HomeGraph を更新する

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

洗濯機をテストする

スマートホーム分析ダッシュボード

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

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

エラーを修正する

修正をテストする

4. テストスイートを使用してアクションをテストする

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

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

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

エラーを修正する

修正をテストする

5. 完了

詳細

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