Google Home UI Automator

Matter    Device 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.1.1.143.24.1.4 であることを確認します。
  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 を使用して報告してください。