Google Home UI Automator

Matter

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.1.1.14 と 3.32.126.2 であることを確認します。
  2. GHA で Google アカウントにログインします。

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

Google Home UI Automator をインストールするには、PyPI からインストールする方法と、ソースコードからインストールする方法の 2 つがあります。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 [--google_account GOOGLE_ACCOUNT]
入力値 説明 例
DEVICE_NAME Matter 台のデバイスを選択しました。 m5stack
PAIRING_CODE Matter デバイスのペア設定コード。 34970112332
ROOM_NAME 割り当てられた部屋。 Office
GOOGLE_ACCOUNT GHA で使用するアカウント。 test@gmail.com

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

Matter デバイスの利用を停止する

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

ui-automator --decommission DEVICE_NAME [--google_account GOOGLE_ACCOUNT]
入力値 説明 例
DEVICE_NAME GHA で、コミッショニングされた Matter デバイスの名前を表示します。 m5stack
GOOGLE_ACCOUNT GHA で使用するアカウント。 test@gmail.com
この図は、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] [--google_account GOOGLE_ACCOUNT]
入力値 説明 例
DEVICE_NAME Matter 台のデバイスを選択しました。 m5stack
PAIRING_CODE Matter デバイスのペア設定コード。 34970112332
ROOM_NAME 割り当てられた部屋。 Office
GOOGLE_ACCOUNT GHA で使用するアカウント。 test@gmail.com

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

次の情報を追加すると、より詳細なテスト結果が得られます。

値 入力値 説明 例
--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 の使用感の改善点など、ご意見やフィードバックがありましたら、フィードバック フォームにご記入ください。

問題を報告する

発生した問題は、公開バグトラッカーを使用して報告してください。