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 のエクスペリエンスを改善する方法に関するご意見やフィードバックを送信するには、フィードバック フォームにご記入ください。

問題を報告する

発生した問題は、Issue Tracker を使用して報告してください。