Google Git
Sign in
testsuite-smarthome-matter / ui-automator / db61d5eaf067ae41fd56e6b73da2627b4b16b781
commitdb61d5eaf067ae41fd56e6b73da2627b4b16b781[log] [tgz]
authorKate Hsieh <yuchihsieh@google.com>Mon Dec 18 04:57:15 2023 -0800
committerCopybara-Service <copybara-worker@google.com>Mon Dec 18 04:57:49 2023 -0800
tree11f9dd2d07139a09d60ffe4a6e783fdb53fd9835
parentebee7eec50d116756bdf7cb27962d01f7a1ee94c [diff]
0.2.1-rc.1

PiperOrigin-RevId: 591861211
4 files changed
tree: 11f9dd2d07139a09d60ffe4a6e783fdb53fd9835
  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 automating 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.9 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.7.1.4.

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

Installation

  1. clone this repo.
  2. cd to the folder.
  3. Run pip install .

Usage

Commissioning 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

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

Regression Test

$ ui-automator --commission DEVICE_NAME,PAIRING_CODE,ROOM_NAME --regtest [--repeat <REPEAT_TIMES>]
  • 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
  • add --repeat to run regression test in limited times
  • REPEAT_TIMES: repeated times for regression test

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 autoation.

Report issue

  • Click here to report any encountered issues.