Google Home Sample App for Matter

The Google Home Sample App for Matter (GHSA for Matter) 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.

Warning: There is still work to be done on this sample app, but we are making it available at this point to allow developers to get a headstart on learning how to use the Home Mobile SDK.

Clone the repository

The Sample app GitHub repository includes third party libraries from the Matter repo (connectedhomeip). These native libraries are over 50MB, and require the use of Git Large File Storage (LFS).

To clone the repository, complete the following steps:

1. Install Git LFS.

2. Initialize Git LFS.

   $ git lfs install

   When complete, the console displays the following:

   Updated Git hooks.
   Git LFS initialized.

3. Once Git LFS is installed and initialized, you're ready to clone the repository. When cloning completes, Git checks out the main branch and downloads the native libraries for you.

   $ git clone https://github.com/google-home/sample-app-for-matter-android.git

Version

Google Home Sample App for Matter follows the Semantic and Android versioning guidelines for release cycle transparency and to maintain backwards compatibility.

Releases

Always use the latest release as shown at https://github.com/google-home/sample-app-for-matter-android/releases

Get started

• 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.
  • Build a Matter Virtual Device with the rootnode_dimmablelight_bCwGYSDpoe app. When you Create a Matter integration in the Home Developer Console, use 0xFFF1 as your Vendor ID and 0x8000 as your Product ID.
  • Build an Espressif Device with the all-clusters-app. When you Create a Matter integration in the Home Developer Console, use 0xFFF1 as your Vendor ID and 0x8001 as 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.

Issues?

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 "Investigating Issues with the Sample App".

License

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