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

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

ローカルホームのデバッグ

1. 始める前に

スマートホームの統合により、ユーザーの家にある接続済みデバイスを Google アシスタントを通じて制御できるようになります。スマートホームアクションを構築するには、スマートホームインテントを処理できる Cloud Webhook エンドポイントを用意する必要があります。たとえば、ユーザーが「OK Google, 電気をつけて」と言うと、アシスタントはクラウドフルフィルメントにコマンドを送信してデバイスの状態を更新します。

一方、Local Home SDK を使用すると、スマートホームインテントを Google Home デバイスに直接ルーティングするローカルパスを追加できます。これによりスマートホームの統合を強化でき、ユーザーコマンドの処理の信頼性を向上させレイテンシを短縮できます。また、デバイスを識別するローカルフルフィルメントアプリを TypeScript や JavaScript で記述してデプロイし、Google Home スマートスピーカーや Google Nest スマートディスプレイでコマンドを実行することもできます。ユーザーコマンドの実行に既存の標準プロトコルを使用することで、アプリがローカルエリアネットワーク経由で既存のスマートデバイスと直接通信することが可能になります。

スマートホームアクションのデバッグは、本番環境の品質でアクションを構築するための重要なステップですが、有益で使いやすいトラブルシューティングツールとテストツールがなければ、困難で時間がかかります。スマートホームアクションのデバッグを容易にするために、Google Cloud Platform（GCP）の指標、ロギング、スマートホーム用テストスイートを使用すると、アクションの問題を特定して解決できます。

Prerequisites

スマートホームアクションの作成に関するデベロッパーガイド
スマートホームアクションのローカルフルフィルメントを有効にする Codelab を実行します。

作成するアプリの概要

この Codelab では、スマートホームアクションのローカルフルフィルメントを構築してアシスタントに接続し、スマートホームと Google Cloud Platform（GCP）の指標とロギングのテストスイートを介してローカルホームアプリをデバッグします。

学習内容

GCP の指標とロギングを使用して本番環境の問題を特定し、解決する方法
テストスイートを使用して機能と API の問題を特定する方法
ローカルホームアプリの開発中に Chrome のデベロッパーツールを使用する方法。

必要なもの

最新バージョンの Google Chrome
Google Home アプリがインストールされている iOS または Android デバイス
Google Home スマートスピーカーまたは Google Nest スマートディスプレイ
Node.js バージョン 10.16 以降
Google アカウント
Google Cloud 請求先アカウント

2. 洗濯アプリを実行する

ソースコードを取得する

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

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

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

プロジェクトについて

スターターアプリには、スマートホームアクションのローカルフルフィルメントを有効にする Codelab と同様のサブディレクトリや Cloud Functions 関数が含まれています。ここでは、app-start ではなく app-faulty を使用しています。最初はローカルホームアプリを使用しますが、適切に機能しません。

Firebase に接続する

ここでは、スマートホームアクションのローカルフルフィルメントを有効にする Codelab で作成したプロジェクトを使用しますが、この Codelab でダウンロードしたファイルをデプロイします。

app-faulty ディレクトリに移動し、スマートホームアクションのローカルフルフィルメントを有効にする Codelab で作成した Actions プロジェクトで Firebase CLI を設定します。

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

Firebase にデプロイする

app-faulty/functions フォルダに移動し、npm を使用して必要な依存関係をすべてインストールします。

$ cd functions
$ npm install

注: 次のメッセージが表示された場合は、無視して続行できます。この警告は古い依存関係が原因で発生します。詳細についてはこちらをご覧ください。

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

TypeScript コンパイラをダウンロードしてアプリをコンパイルするため、app-faulty/local/ ディレクトリに移動して次のコマンドを実行します。

$ cd ../local
$ npm install
$ npm run build

これにより、index.ts（TypeScript）のソースがコンパイルされ、以下のファイルが app-faulty/public/local-home/ ディレクトリに格納されます。

bundle.js - ローカルアプリと依存関係を含むコンパイル済み JavaScript の出力。
index.html - デバイスでのテストでアプリの配信に使用するローカルホスティングページ。

これで依存関係のインストールとプロジェクトの設定が完了し、アプリを実行する準備が整いました。

$ firebase deploy

コンソールに次のような出力が表示されます。

...

✔ Deploy complete!

Project Console: https://console.firebase.google.com/project/<project-id>/overview
Hosting URL: https://<projectcd -id>.web.app

このコマンドは、いくつかの Cloud Functions for Firebase とともにウェブアプリをデプロイします。

HomeGraph を更新する

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

Google Home アプリを開き、「洗濯機の不具合」という新しい名前で洗濯機が表示されることを確認します。必ず、Google Nest デバイスが設置されている部屋にデバイスを割り当ててください。

3. スマート洗濯機を起動する

「スマートホームアクションのローカルフルフィルメントを有効にする」Codelab を実行している場合は、仮想スマート洗濯機がすでに開始されているはずです。停止する場合は、仮想デバイスを必ず再起動してください。

デバイスを起動する

virtual-device/ ディレクトリに移動し、引数として設定パラメータを渡してデバイススクリプトを実行します。

$ cd ../../virtual-device
$ npm install
$ npm start -- \
  --deviceId=deviceid123 --projectId=<project-id> \
  --discoveryPortOut=3311 --discoveryPacket=HelloLocalHomeSDK

デバイススクリプトが、想定どおりのパラメータで実行されたことを確認します。

(...): UDP Server listening on 3311
(...): Device listening on port 3388
(...): Report State successful

4. Local Home アプリをテストする

音声コマンドで Google Home デバイスに次のようなコマンドを送信します。

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

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

「OK Google, ローカルに強制して」

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

「フォースローカル」の後に洗濯機を操作しようとすると、Google アシスタントが「現在、不具合のある洗濯機はご利用いただけません」と応答します。

つまり、ローカルパスを介してデバイスにアクセスできません。以前は「OK Google, ローカルで強制的に起動」と発行する前に動作していました。デバイスがローカルパス経由で到達できない場合、クラウドパスにフォールバックするからです。しかし、「ローカルで強制」された後、クラウドパスにフォールバックするオプションは無効になります。

何が問題かを調べるために、Google Cloud Platform（GCP）の指標、ロギング、Chrome デベロッパーツールというツールを活用してみましょう。

5. Local Home アプリをデバッグする

次のセクションでは、Google が提供するツールを使用して、ローカルパスからデバイスにアクセスできない理由を調べます。Google Chrome デベロッパーツールを使用すると、Google Home デバイスへの接続、コンソールのログの表示、ローカルホームアプリのデバッグを行えます。また、カスタムログを Cloud Logging に送信して、ユーザーがローカルホームアプリで検出している主なエラーを把握することもできます。

Chrome デベロッパーツールを接続する

次の手順に沿って、デバッガをローカルフルフィルメントアプリに接続します。

Actions Console プロジェクトへのアクセス権限を持つユーザーに Google Home デバイスをリンクしていることを確認します。
Google Home デバイスを再起動します。これにより、Actions Console で設定した HTML の URL とスキャン設定が取得されます。
開発マシンで Chrome を起動します。
新しい Chrome タブを開き、アドレスフィールドに「chrome://inspect」と入力して、インスペクタを起動します。

ページ上にデバイスのリストが表示され、Google Home デバイスの名前の下にアプリの URL が表示されます。

インスペクタを起動する

アプリの URL の下にある [Inspect]（検査）をクリックして Chrome デベロッパーツールを起動します。[Console]（コンソール）タブを選択し、TypeScript アプリによって出力された IDENTIFY インテントの内容が表示されることを確認します。

この出力は、IDENTIFY ハンドラが正常にトリガーされたものの、IdentifyResponse で返された verificationId が HomeGraph のどのデバイスとも一致しないことを意味します。カスタムログを追加して、その理由を確認しましょう。

カスタムログの追加

Local Home SDK によって DEVICE_VERIFICATION_FAILED エラーが出力されますが、これは根本的な原因の特定にはあまり役立ちません。スキャンデータが正しく読み取られて処理されるようにカスタムログを追加しましょう。エラーを伴って Promise を拒否した場合、実際にはエラーメッセージが Cloud Logging にも送信されます。

local/index.ts

identifyHandler(request: IntentFlow.IdentifyRequest):
    Promise<IntentFlow.IdentifyResponse> {
  console.log("IDENTIFY intent: " + JSON.stringify(request, null, 2));

  const scanData = request.inputs[0].payload.device.udpScanData;
  if (!scanData) {
    const err = new IntentFlow.HandlerError(request.requestId,
        'invalid_request', 'Invalid scan data');
    return Promise.reject(err);
  }

  // In this codelab, the scan data contains only local device id.
  // Is there something wrong here?
  const localDeviceId = Buffer.from(scanData.data);
  console.log(`IDENTIFY handler: received local device id
      ${localDeviceId}`);

  // Add custom logs
  if (!localDeviceId.toString().match(/^deviceid[0-9]{3}$/gi)) {
    const err = new IntentFlow.HandlerError(request.requestId,
        'invalid_device', 'Invalid device id from scan data ' +
        localDeviceId);
    return Promise.reject(err);
  }

  const response: IntentFlow.IdentifyResponse = {
    intent: Intents.IDENTIFY,
    requestId: request.requestId,
    payload: {
      device: {
        id: 'washer',
        verificationId: localDeviceId.toString(),
      }
    }
  };
  console.log("IDENTIFY response: " + JSON.stringify(response, null, 2));

  return Promise.resolve(response);
}

また、正しいバージョンの Google を使用しているかどうかを特定できるように、ローカル Google Home アプリのバージョンを変更します。

local/index.ts

const localHomeSdk = new App('1.0.1');

カスタムログを追加したら、アプリを再度コンパイルして Firebase に再デプロイする必要があります。

$ cd ../app-faulty/local
$ npm run build
$ firebase deploy --only hosting

Google Home デバイスを再起動して、更新したローカルホームアプリを読み込みます。Google Home デバイスが想定バージョンを使用しているかどうかは、Chrome デベロッパーツールのコンソールログで確認できます。

Cloud Logging にアクセスする

Cloud Logging を使用してエラーを特定する方法を見ていきましょう。プロジェクトの Cloud Logging にアクセスする手順は次のとおりです。

Cloud Platform Console で、[プロジェクト] ページに移動します。
スマートホームプロジェクトを選択します。
[オペレーション] で、[ロギング] > [ログエクスプローラ] を選択します。

ロギングデータへのアクセスは、Actions プロジェクトの Identity and Access Management（IAM）によって管理されます。データロギングのロールと権限の詳細については、Cloud Logging のアクセス制御をご覧ください。

高度なフィルタを使用する

ローカルデバイスの識別に失敗してローカルパスが機能しなくなるため、IDENTIFY インテントでエラーが発生しています。問題を正確に把握するため、まず IDENTIFY ハンドラで発生したエラーを除外します。

[クエリのプレビュー] ボックスを開くと、[クエリビルダー] ボックスに変わります。[クエリビルダー] ボックスに「jsonPayload.intent="IDENTIFY"」と入力し、[クエリを実行] ボタンをクリックします。

その結果、IDENTIFY ハンドラでスローされたすべてのエラーログが取得されます。次に、最後のエラーを開きます。IDENTIFY ハンドラで Promise を拒否するときに設定した errorCode と debugString が見つかります。

debugString から、ローカルデバイス ID が想定どおりの形式ではないことがわかります。ローカルホームアプリは、deviceid で始まり 3 桁の数字が続く文字列としてローカルデバイス ID を取得することを想定していますが、ここでのローカルデバイス ID は 16 進文字列です。

エラーを修正する

スキャンデータからローカルデバイス ID を解析したソースコードに戻ると、文字列をバイトに変換する際にエンコードが提供されていないことがわかります。スキャンデータは 16 進数の文字列として受信されるため、Buffer.from() を呼び出すときに文字エンコードとして hex を渡します。

local/index.ts

identifyHandler(request: IntentFlow.IdentifyRequest):
    Promise<IntentFlow.IdentifyResponse> {
  console.log("IDENTIFY intent: " + JSON.stringify(request, null, 2));

  const scanData = request.inputs[0].payload.device.udpScanData;
  if (!scanData) {
    const err = new IntentFlow.HandlerError(request.requestId,
        'invalid_request', 'Invalid scan data');
    return Promise.reject(err);
  }

  // In this codelab, the scan data contains only local device id.
  const localDeviceId = Buffer.from(scanData.data, 'hex');
  console.log(`IDENTIFY handler: received local device id
      ${localDeviceId}`);

  if (!localDeviceId.toString().match(/^deviceid[0-9]{3}$/gi)) {
    const err = new IntentFlow.HandlerError(request.requestId,
      'invalid_device', 'Invalid device id from scan data ' +
      localDeviceId);
    return Promise.reject(err);
  }

  const response: IntentFlow.IdentifyResponse = {
    intent: Intents.IDENTIFY,
    requestId: request.requestId,
    payload: {
      device: {
        id: 'washer',
        verificationId: localDeviceId.toString(),
      }
    }
  };
  console.log("IDENTIFY response: " + JSON.stringify(response, null, 2));

  return Promise.resolve(response);
}

また、正しいバージョンの Google を使用しているかどうかを特定できるように、ローカル Google Home アプリのバージョンを変更します。

local/index.ts

const localHomeSdk = new App('1.0.2');

エラーを修正したら、アプリをコンパイルして Firebase に再デプロイします。app-faulty/local で、以下を実行します。

$ npm run build
$ firebase deploy --only hosting

修正をテストする

デプロイ後、更新したローカルホームアプリを読み込めるように Google Home デバイスを再起動します。ローカルホームアプリのバージョンが 1.0.2 であることを確認します。今回は Chrome デベロッパーツールコンソールにエラーが表示されないはずです。

デバイスにコマンドをもう一度送信してみます。

「OK Google, ローカルに強制して」

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

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

…

「OK Google, 強制的にデフォルトにする」

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

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

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

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

ウェブブラウザでスマートホーム用テストスイートを開きます。
右上のボタンを使用して Google にログインします。これにより、テストスイートから Google アシスタントにコマンドを直接送信できます。
[Project ID] フィールドに、スマートホームアクションのプロジェクト ID を入力します。[次へ] をクリックして続行します。
[テスト設定] ステップの [デバイスとトレイ] に、不具合のあるワッシャーが表示されます。
サンプルの洗濯機アプリには、洗濯機を追加 / 削除 / 名前変更するための UI がないため、[Test Request Sync] オプションを無効にします。本番環境システムでは、ユーザーがデバイスを追加、削除、名前変更するたびに、Request Sync をトリガーする必要があります。
ローカルパスとクラウドパスの両方をテストするため、[Local Home SDK] オプションをオンのままにします。
[次へ] をクリックして、テストの実行を開始します。

テストが完了すると、クラウドパスの一時停止/再開テストに合格する間、ローカルパスの一時停止/再開テストは失敗します。

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

失敗したテストケースのエラーメッセージを詳しく見てみましょう。テストの想定される状態と、実際の状態が示されます。この場合、「Washer Washer」の場合、想定される状態は isPaused: true ですが、実際の状態では isPaused: false です。同様に、「Washer Washer」の場合、想定される状態は isPaused: true ですが、実際の状態では isPaused: false です。

エラーメッセージから、ローカルパスでは isPaused 状態を逆に設定しているようです。

エラーを特定して修正する

ローカルホームアプリがデバイスに実行コマンドを送信するソースコードを見てみましょう。getDataCommand() は、デバイスに送信される実行コマンドで payload を設定するために executeHandler() によって呼び出される関数です。

local/index.ts

getDataForCommand(command: string, params: IWasherParams): unknown {
    switch (command) {
        case 'action.devices.commands.OnOff':
            return {
                on: params.on ? true : false
            };
        case 'action.devices.commands.StartStop':
            return {
                isRunning: params.start ? true : false
            };
        case 'action.devices.commands.PauseUnpause':
            return {
                // Is there something wrong here?
                isPaused: params.pause ? false : true
            };
        default:
            console.error('Unknown command', command);
            return {};
    }
}

実際、isPause を逆の状態に設定しており、params.pause が true の場合は true、それ以外の場合は false に設定する必要があります。修正しましょう。

local/index.ts

getDataForCommand(command: string, params: IWasherParams): unknown {
    switch (command) {
        case 'action.devices.commands.OnOff':
            return {
                on: params.on ? true : false
            };
        case 'action.devices.commands.StartStop':
            return {
                isRunning: params.start ? true : false
            };
        case 'action.devices.commands.PauseUnpause':
            return {
                isPaused: params.pause ? true : false
            };
        default:
            console.error('Unknown command', command);
            return {};
    }
}

正しいバージョンを使用しているかどうかを確認できるように、ローカルホームアプリバージョンを変更します。

local/index.ts

const localHomeSdk = new App('1.0.3');

必ずアプリを再度コンパイルして、Firebase に再デプロイしてください。app-faulty/local で、以下を実行します。

$ npm run build
$ firebase deploy --only hosting

Google Home デバイスを再起動して、更新したローカルホームアプリを読み込みます。ローカルホームアプリのバージョンが 1.0.3 であることを確認します。

修正をテストする

同じ構成でスマートホーム用のテストスイートを再実行すると、すべてのテストケースに合格したことがわかります。

7. 完了

これで完了です。スマートホームと Cloud Logging 用のテストスイートを使用して、ローカルホームアプリのトラブルシューティングを行う方法を習得しました。

詳細

他にも以下のことを試してみてください。

その他のサポートされているトレイトをデバイスに追加し、テストスイートを使用してテストします。
各インテントハンドラにカスタムログをさらに追加し、Cloud Logging で表示する。
ダッシュボードを作成してアラートを設定し、指標データにプログラムでアクセスして、アクションに関する有用な使用状況の指標を取得します。

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

ローカルホームのデバッグ

1. 始める前に

Prerequisites

作成するアプリの概要

学習内容

必要なもの

2. 洗濯アプリを実行する

ソースコードを取得する

プロジェクトについて

Firebase に接続する

Firebase にデプロイする

HomeGraph を更新する

3. スマート洗濯機を起動する

デバイスを起動する

4. Local Home アプリをテストする

5. Local Home アプリをデバッグする

Chrome デベロッパー ツールを接続する

インスペクタを起動する

カスタムログの追加

Cloud Logging にアクセスする

高度なフィルタを使用する

エラーを修正する

修正をテストする

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

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

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

エラーを特定して修正する

修正をテストする

7. 完了

詳細

Chrome デベロッパーツールを接続する

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