Google Git
Sign in
testsuite-smarthome-matter / ui-automator / adbfa03c44ee80d169c0d41912644b9d9bc3ef7b
commitadbfa03c44ee80d169c0d41912644b9d9bc3ef7b[log] [tgz]
authorKate Hsieh <yuchihsieh@google.com>Fri Nov 29 00:02:23 2024 -0800
committerCopybara-Service <copybara-worker@google.com>Fri Nov 29 00:03:58 2024 -0800
treebe37dbfbfe8be9a7babb2da1bed6221852e277eb
parent86d22469fa5f67014e40b0eada572e0e92942ca2 [diff]
Add third party license

PiperOrigin-RevId: 701197181
3 files changed
tree: be37dbfbfe8be9a7babb2da1bed6221852e277eb
  1. ui_automator/
  2. .gitignore
  3. CHANGELOG.md
  4. CONTRIBUTING.md
  5. LICENSE
  6. MANIFEST.in
  7. README.md
  8. requirements.txt
  9. setup.py
README.md

Google Home UI Automator

Google Home Automator can help you automate your Google Home App.

Getting Started

Prerequisites

Python 3

You need a python 3 environment to run the script. Google Home UI Automator requires python 3.11 or newer.

Android phone

  1. Turn on User Debugging mode on your android phone.
  2. Connect your android phone to computer.

Google Home App

  1. You need to install Google Home App on your Android phone.
  2. Login to your Google Home App.
  3. Make sure the Google Home App's version is between 3.1.1.14 and 3.25.1.4.

NOTE: Please select the correct Google account on Google Home App.

NOTE: This tool only works with the English version of the Google Home App.

Installation

PyPI (recommended)

$ pip install google-home-ui-automator

Build from source code

  1. clone this repo.

    $ git clone https://testsuite-smarthome-matter.googlesource.com/ui-automator

  2. cd to the folder.

  3. Run pip install .

Usage

Commissioning Matter device

Follow the steps below to automatically commission a matter device.

$ ui-automator --commission DEVICE_NAME,PAIRING_CODE,ROOM_NAME
  • DEVICE_NAME: desired Matter device, e.g. m5stack
  • PAIRING_CODE: pairing code of your Matter device, e.g. 34970112332
  • ROOM_NAME: room that is going to be assigned, e.g. Office

Decommissioning Matter device

Follow the steps below to decommission a matter device.

$ ui-automator --decommission DEVICE_NAME
  • DEVICE_NAME: display name of commissioned Matter device on GHA, e.g. m5stack

Regression Test

Follow the steps below to run a regression test.

$ ui-automator --commission DEVICE_NAME,PAIRING_CODE,ROOM_NAME --regtest [--repeat <REPEAT_TIMES>] [--hub <HUB_VERSION>] [--dut <MODEL>,<TYPE>,<PROTOCOL>] [--fw <DEVICE_FIRMWARE>]
  • flag --regtest is required
  • regression test need to be used with flag --commission
  • regression test now only supports commissioning/decommissioning cycle
  • defaultly, regression test will run until users use keyboard interrupt to stop the process
  • optionally add --repeat to run regression test in limited times
    • REPEAT_TIMES: repeated times for regression test
  • optionally add --hub to include hub version in produced test report
    • HUB_VERSION: version of hub for controlling devices on GHA
  • optionally add --dut to include device under test in produced test report
    • MODEL: Model of the device. e.g. X123123
    • TYPE: Type of the device. e.g. LIGHT
    • PROTOCOL: Used protocol of the device. e.g. MATTER
  • optionally add --fw to include device firmware in produced test report
    • DEVICE_FIRMWARE: Firmware of test device.

Roadmap

  • [x] Commissioning Matter device
  • [x] Decommissioning Matter device
  • [x] Regression test of cycling commissioning/decommissioning
  • [ ] Support regression test for devices that need additionally manual operations after decommissioning to recover to BLE commissioning mode
  • [ ] Share Fabric
  • [ ] Get pairing code when sharing fabric

Notice

  • While UI Automation is processing, interfering android phone with any UI operation might fail the automation.

Report issue

  • Click here to report any encountered issues.

Disclaimer

This project is not an official Google project. It is not supported by Google and Google specifically disclaims all warranties as to its quality, merchantability, or fitness for a particular purpose.