esp32-core/libraries/Matter/examples/MatterComposedLights

Matter Composed Lights Example

This example demonstrates how to create a Matter node with multiple light endpoints using an ESP32 SoC microcontroller.
The application showcases Matter commissioning, a single Matter node containing three different light types (On/Off Light, Dimmable Light, and Color Light), and factory reset using a physical button.

Supported Targets

SoC	Wi-Fi	Thread	BLE Commissioning	Status
ESP32	✅	❌	❌	Fully supported
ESP32-S2	✅	❌	❌	Fully supported
ESP32-S3	✅	❌	✅	Fully supported
ESP32-C3	✅	❌	✅	Fully supported
ESP32-C5	❌	✅	✅	Supported (Thread only)
ESP32-C6	✅	❌	✅	Fully supported
ESP32-H2	❌	✅	✅	Supported (Thread only)

Note on Commissioning:

• ESP32 & ESP32-S2 do not support commissioning over Bluetooth LE. For these chips, you must provide Wi-Fi credentials directly in the sketch code so they can connect to your network manually.
• ESP32-C6 Although it has Thread support, the ESP32 Arduino Matter Library has been pre compiled using Wi-Fi only. In order to configure it for Thread-only operation it is necessary to build the project using Arduino as an IDF Component and to disable the Matter Wi-Fi station feature.
• ESP32-C5 Although it has Wi-Fi 2.4 GHz and 5 GHz support, the ESP32 Arduino Matter Library has been pre compiled using Thread only. In order to configure it for Wi-Fi operation it is necessary to build the project using Arduino as an ESP-IDF component and disable Thread network, keeping only Wi-Fi station.

Features

• Matter protocol implementation for a composed device with multiple light endpoints
• Three light endpoints in a single Matter node:
  • Light #1: Simple On/Off Light
  • Light #2: Dimmable Light (on/off with brightness control)
  • Light #3: Color Light (RGB color control)
• Support for both Wi-Fi and Thread(*) connectivity
• Button control for factory reset (decommission)
• Matter commissioning via QR code or manual pairing code
• Integration with Apple HomeKit, Amazon Alexa, and Google Home
• Periodic state display of all three lights (*) It is necessary to compile the project using Arduino as IDF Component.

Hardware Requirements

• ESP32 compatible development board (see supported targets table)
• User button for factory reset (uses BOOT button by default)

Pin Configuration

• Button: Uses BOOT_PIN by default for factory reset (long press >5 seconds)

Software Setup

Prerequisites

1. Install the Arduino IDE (2.0 or newer recommended)
2. Install ESP32 Arduino Core with Matter support
3. ESP32 Arduino libraries:
   • Matter
   • Wi-Fi (only for ESP32 and ESP32-S2)

Configuration

Before uploading the sketch, configure the following:

1. Wi-Fi credentials (if not using BLE commissioning - mandatory for ESP32 | ESP32-S2):

   const char *ssid = "your-ssid";         // Change to your Wi-Fi SSID
   const char *password = "your-password"; // Change to your Wi-Fi password
   

2. Button pin configuration (optional): By default, the BOOT button (GPIO 0) is used for factory reset. You can change this to a different pin if needed.

   const uint8_t buttonPin = BOOT_PIN;  // Set your button pin here
   

Building and Flashing

1. Open the MatterComposedLights.ino sketch in the Arduino IDE.
2. Select your ESP32 board from the Tools > Board menu.

3. Select "Huge APP (3MB No OTA/1MB SPIFFS)" from Tools > Partition Scheme menu.

4. Enable "Erase All Flash Before Sketch Upload" option from Tools menu.
5. Connect your ESP32 board to your computer via USB.
6. Click the Upload button to compile and flash the sketch.

Expected Output

Once the sketch is running, open the Serial Monitor at a baud rate of 115200. The Wi-Fi connection messages will be displayed only for ESP32 and ESP32-S2. Other targets will use Matter CHIPoBLE to automatically setup the IP Network. You should see output similar to the following, which provides the necessary information for commissioning:

Connecting to your-wifi-ssid
.......
Wi-Fi connected
IP address: 192.168.1.100

Matter Node is not commissioned yet.
Initiate the device discovery in your Matter environment.
Commission it to your Matter hub with the manual pairing code or QR code
Manual pairing code: 34970112332
QR code URL: https://project-chip.github.io/connectedhomeip/qrcode.html?data=MT%3A6FCJ142C00KA0648G00
Matter Node not commissioned yet. Waiting for commissioning.
Matter Node not commissioned yet. Waiting for commissioning.
...
Matter Node is commissioned and connected to the network. Ready for use.
======================
Matter Light #1 is OFF
Matter Light #2 is OFF
Matter Light #3 is OFF
======================
Light1 changed state to: ON
Light2 changed state to: ON
Light3 changed state to: ON
======================
Matter Light #1 is ON
Matter Light #2 is ON
Matter Light #3 is ON

Using the Device

Manual Control

The user button (BOOT button by default) provides factory reset functionality:

• Long press (>5 seconds): Factory reset the device (decommission)

Smart Home Integration

Use a Matter-compatible hub (like an Apple HomePod, Google Nest Hub, or Amazon Echo) to commission the device. After commissioning, you will see three separate light devices in your smart home app:

• Light #1: Simple on/off light
• Light #2: Dimmable light with brightness control
• Light #3: Color light with RGB color control

Apple Home

1. Open the Home app on your iOS device
2. Tap the "+" button > Add Accessory
3. Scan the QR code displayed in the Serial Monitor, or
4. Tap "I Don't Have a Code or Cannot Scan" and enter the manual pairing code
5. Follow the prompts to complete setup
6. The device will appear as three separate lights in your Home app

Amazon Alexa

1. Open the Alexa app
2. Tap More > Add Device > Matter
3. Select "Scan QR code" or "Enter code manually"
4. Complete the setup process
5. The three lights will appear in your Alexa app

Google Home

1. Open the Google Home app
2. Tap "+" > Set up device > New device
3. Choose "Matter device"
4. Scan the QR code or enter the manual pairing code
5. Follow the prompts to complete setup
6. The three lights will appear in your Google Home app

Code Structure

The MatterComposedLights example consists of the following main components:

1. setup(): Initializes hardware (button), configures Wi-Fi (if needed), sets up three Matter endpoints (OnOffLight, DimmableLight, ColorLight), and registers callbacks for state changes.
2. loop(): Checks the Matter commissioning state, displays the state of all three lights every 5 seconds, handles button input for factory reset, and allows the Matter stack to process events.
3. Callbacks:
   • setLightOnOff1(): Handles on/off state changes for Light #1.
   • setLightOnOff2(): Handles on/off state changes for Light #2.
   • setLightOnOff3(): Handles on/off state changes for Light #3.

Troubleshooting

• Device not visible during commissioning: Ensure Wi-Fi or Thread connectivity is properly configured
• Only one or two lights appear: Some smart home platforms may group or display lights differently. Check your app's device list
• Failed to commission: Try factory resetting the device by long-pressing the button. Other option would be to erase the SoC Flash Memory by using Arduino IDE Menu -> Tools -> Erase All Flash Before Sketch Upload: "Enabled" or directly with esptool.py --port <PORT> erase_flash
• No serial output: Check baudrate (115200) and USB connection

Related Documentation

• Matter Overview
• Matter Endpoint Base Class
• Matter On/Off Light Endpoint
• Matter Dimmable Light Endpoint
• Matter Color Light Endpoint

License

This example is licensed under the Apache License, Version 2.0.