The Google Home Sample App for Matter (GHSAFM-3p-ecosystem) provides a concrete example of how to
use the Home Mobile SDK to make it
easy to commission and share Matter devices
across Apps and ecosystems. It also demonstrates how to use commissioning and Cluster libraries
from the
Matter repo (connectedhomeip).
This is a sample application that can be used as the starting point to build your smart home application for Matter devices.
It can also be used as a learning tool to better understand key Matter concepts, as well as a tool to debug and troubleshoot interactions with Matter devices.
The Sample app GitHub repository includes third party libraries from the
Matter repo (connectedhomeip).
To clone the repository, do the following:
```console
$ git clone https://github.com/google-home/sample-apps-for-matter-android.git
```
Google Home Sample App for Matter follows the Semantic and Android versioning guidelines for release cycle transparency and to maintain backwards compatibility.
Always use the latest release as shown at https://github.com/google-home/sample-apps-for-matter-android/releases
- Check the presentation "Building Smart Home Apps with the Google Home Mobile SDK" (docs/GoogleHomeMobileSDK.pdf) for an overview of the Sample App and key APIs of the Mobile SDK.
- To make sure that your device has the latest Matter support, review the Verify Matter Modules & Services guide.
- Build a Matter device with On/Off capabilities. This sample app works with a virtual device
and an ESP32.
- Matter Virtual Device (MVD) To minimize environment issues, we strongly suggest that you use MVD to start with. If you ever run into issues, it will be much easier to investigate if the sample app is used against MVD.
- Build a Matter Virtual Device
with the
rootnode_dimmablelight_bCwGYSDpoeapp. When you Create a Matter integration in the Home Developer Console, use0xFFF1as your Vendor ID and0x8000as your Product ID. - Build an Espressif Device
with the
all-clusters-app. When you Create a Matter integration in the Home Developer Console, use0xFFF1as your Vendor ID and0x8001as your Product ID.
- For an overview of the user interface and features, refer to the Google Home Sample App for Matter Guide.
- To review code samples and start building, refer to the Build an Android App for Matter Codelab.
If you run into problems with the sample app, please submit an issue on the Issues page.
It is always greatly appreciated if you can try to reproduce the issue you encountered from a clean state as described in document "How to investigate issues with GHSAFM‐3p‐ecosystem".
Google Home Sample App for Matter is licensed under the Apache License, Version 2.0.
Only use the Google Home Sample App for Matter name and marks when accurately referencing this software distribution. Do not use the marks in a way that suggests you are endorsed by or otherwise affiliated with Nest, Google, or the Connectivity Standards Alliance (CSA).