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

前提条件
Google Home UI Automator を使用するには、次のものを用意します。
Python 3
スクリプトを実行するには、Python 3 環境を使用することをおすすめします。Google Home UI Automator には python 3.11 以降が必要です。
Android スマートフォン
- Android スマートフォンで ユーザー デバッグモードをオンにします。デバッグ設定をオンにするには、開発者向けオプションを有効にするをご覧ください。
 - Android スマートフォンをパソコンに接続します。
 
Google Home アプリ
- Android スマートフォンに GHA をインストールします。GHA のバージョンが 
3.1.1.14と3.32.126.2であることを確認します。 - GHA で Google アカウントにログインします。
 
Google Home UI Automator をインストールする
Google Home UI Automator をインストールするには、PyPI からインストールする方法と、ソースコードからインストールする方法の 2 つがあります。PyPI を使用してインストールすることをおすすめします。
PyPI(推奨)
pip install google-home-ui-automator
ソースコードからビルドする
ソースコードからビルドするには、ターミナルで次の手順を行います。
このリポジトリのクローンを作成します。
git clone https://testsuite-smarthome-matter.googlesource.com/ui-automatorクローンを作成したリポジトリに移動します。
cd ui-automator次のコマンドを実行します。
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 デバイスの利用を停止する
Matter デバイスを廃止するには、次のコマンドを入力します。
ui-automator --decommission DEVICE_NAME [--google_account GOOGLE_ACCOUNT]
| 入力値 | 説明 | 例 | 
|---|---|---|
DEVICE_NAME | 
GHA で、コミッショニングされた Matter デバイスの名前を表示します。 | m5stack | 
GOOGLE_ACCOUNT | 
GHA で使用するアカウント。 | test@gmail.com | 
回帰テストを実行する
回帰テストを実行するには、次のコードを入力します。回帰テストを実行するには、フラグ --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 の使用感に関するご意見やフィードバックをお寄せいただくには、フィードバック フォームにご記入ください。
問題を報告する
発生した問題は、公開バグトラッカーを使用して報告してください。