Google Home UI Automator

Matter    デバイス SDK

Google Home UI Automator を使用すると、Google Home app (GHA) を自動化して、Matter のコミッション、廃止、コミッションに対する回帰テストを実施できます。

この図は、Matter 対応デバイスを Google Home とペア設定する方法を示しています

前提条件

Google Home UI Automator を使用するには、次のものを用意してください。

Python 3

スクリプトの実行には Python 3 環境を使用することをおすすめします。Google Home UI Automator には Python 3.11 以降が必要です。

Android スマートフォン

  1. Android スマートフォンで [ユーザー デバッグ] モードをオンにします。デバッグ設定を有効にするには、開発者向けオプションを有効にするをご覧ください。
  2. Android スマートフォンをパソコンに接続します。

Google Home アプリ

  1. Android スマートフォンに GHA をインストールします。 GHA のバージョンが 3.10.1.6 以降であることを確認してください。
  2. GHA で Google アカウントにログインします。

Google Home UI Automator をインストールする

Google Home UI Automator をインストールする方法は 2 つあります。PyPI をインストールする方法と、ソースコードからインストールする方法です。PyPI を使用してインストールすることをおすすめします。

pip install google-home-ui-automator

ソースコードからビルドする

ソースコードからビルドするには、ターミナルで次の手順を行います。

  1. このリポジトリのクローンを作成します。

    git clone https://testsuite-smarthome-matter.googlesource.com/ui-automator
    
  2. クローンを作成したリポジトリに移動します。

    cd ui-automator
    
  3. 次のコマンドを実行します。

    pip install .
    

Matter デバイスをコミッショニングする

Matter デバイスをコミッショニングするには、次のコマンドを入力します。

ui-automator --commission DEVICE_NAME,PAIRING_CODE,ROOM_NAME
入力値 説明
DEVICE_NAME Matter 台のデバイスを選択しました。 m5stack
PAIRING_CODE Matter デバイスのペア設定コード。 34970112332
ROOM_NAME 部屋を割り当てました。 Office

この図は、Matter 対応デバイスを Google Home とペア設定する方法を示しています

Matter デバイスを廃止する

Matter デバイスを廃止するには、次のコマンドを入力します。

ui-automator --decommission DEVICE_NAME
入力値 説明
DEVICE_NAME GHA に稼働中の Matter デバイスの名前を表示します。 m5stack
この図は、Google Home Playground でフィードバックを提供し、問題を報告するためのアイコンを示しています。

回帰テストの実行

回帰テストを実行するには、次のコードを入力します。回帰テストを実行するには、--regtest フラグと --commission フラグを含める必要があります。

ui-automator --commission DEVICE_NAME,PAIRING_CODE,ROOM_NAME --regtest [--repeat REPEAT_TIMES] [--hub HUB_VERSION] [--dut MODEL,TYPE,PROTOCOL] [--fw DEVICE_FIRMWARE]

回帰テストでは、コミッショニングとデコミッションのサイクルのみがサポートされます。デフォルトでは、ユーザーがキーボードを使用してプロセスを停止するまで、回帰テストが実行されます。

より詳細なテスト結果を得るには、以下を追加できます。

入力値 説明
--repeat REPEAT_TIMES 限られた時間と繰り返し回数で回帰テストを実行する。 5
--hub HUB_VERSION GHA でデバイスを操作するためのハブのバージョン。 15.20221210.3.1
--dut テスト対象デバイス。
MODEL デバイスのモデル。 X123123
TYPE デバイスのタイプ。 LIGHT
PROTOCOL デバイスのプロトコル。 MATTER
--fw DEVICE_FIRMWARE デバイスのファームウェア。 2.2.0

この図は、回帰テストの概要を示しています。

フィードバック

Google Home UI Automator の利便性向上のため、フィードバック フォームにフィードバックをお寄せください。

問題を報告する

Issue Tracker を使用して問題を報告します。