Google Git
Sign in
pigweed / third_party / github / project-chip / connectedhomeip / dbc6ed396be4b99faa5ea064e13e33c80e1ded4b / . / examples / virtual-device-app / android
tree: 539352f811093211541f986c268a29b7102e4051 [path history] [tgz]
  1. App/
  2. java/
  3. third_party/
  4. build_overrides ⇨ ../../build_overrides
  5. .gn
  6. args.gni
  7. BUILD.gn
  8. README.md
examples/virtual-device-app/android/README.md

Matter Android Virtual Device App Example

This is a Matter Android Device app that can be used as a commissionee device.

This app offers the following features:

  • Work as a commissionee device on Android environment
  • Make custom payload information and display Matter QR code
  • Provide UI for the user to change the cluster attribute values and create the cluster event

Requirements for building

For information about how to build the application, see the Building Android guide.

Preparing for build

Complete the following steps to prepare the Matter build:

  1. Check out the Matter repository.

  2. Run bootstrap (only required first time)

    source scripts/bootstrap.sh

Building & Installing the app

This is the simplest option. In the command line, run the following command from the top Matter directory:

./scripts/build/build_examples.py --target android-arm64-virtual-device-app build

See the table above for other values of TARGET_CPU.

The debug Android package app-debug.apk will be generated at out/android-$TARGET_CPU-virtual-device-app/VirtualDeviceApp/app/outputs/apk/debug/, and can be installed with

adb install out/android-$TARGET_CPU-virtual-device-app/VirtualDeviceApp/app/outputs/apk/debug/app-debug.apk

You can use Android Studio to edit the Android app itself and run it after build_examples.py, but you will not be able to edit Matter Android code from src/controller/java, or other Matter C++ code within Android Studio.