Skip to content

Commit 8d772d5

Browse files
SuGliderpre-commit-ci-lite[bot]
SuGlider
and
pre-commit-ci-lite[bot]
authored
ESP Matter + Arduino as IDF Component Light example (#10290)
* feat(matter): partition file for matter The declaration includes a partition for keys and SSL certificates. * feat(matter): matter light source code Adds necessary Matter + Arduino source code that will create a Matter compatible Light. * feat(matter): adds sdkconfig and CMake files Adds target sdkconfig files and the CMakeLists.txt in orde to build the application using Arduino+Matter as IDF component * fix(matter): wrong folder name * feat(matter): include example into registry * fix(matter): error with type in wrong place A declaration was incorrect due to a typo error. Sintax was corrected by deleting `BuiltInLED`. * feat(matter): add readme documentation * feat(matter): remove soc with no wifi or no ble * feat(matter): adjust all sdkconfig files * feat(matter): improve code and led status * feat(matter): add button and led gpio with kconfig * fix(matter): remove commented lines * fix(matter): remove commented lines * feat(matter): added a 2.4GHz SSID note Both the ESP32 device and the Smartphone running the Matter APP shall be in the same WiFi Network in order to achieve a successful commissioning process. * feat(matter): arduino managed comonent version Preparing the Arduino Managed Component to use Core version 3.0.5 or higher. * feat(matter): adds information about google Goggle Home Assistant requires special configurtation in order to allow the Light to show up in the GHA APP. * feat(matter): arduino component version Set final Arduino Managed Component to 3.0.5 necessary because of -DESP32=ESP32, in order to compile the project. * ci(pre-commit): Apply automatic fixes * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(typo): typo and commentaries * fix(matter): spell check ignore for CI * ci(pre-commit): Apply automatic fixes * fix(matter): spell check ignore for CI * fix(matter): spell check ignore for CI * fix(matter): spell check ignore for CI * ci(pre-commit): Apply automatic fixes --------- Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
1 parent 462870d commit 8d772d5

16 files changed

+1364
-0
lines changed

‎idf_component.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,4 @@ dependencies:
9797
examples:
9898
- path: ./idf_component_examples/hello_world
9999
- path: ./idf_component_examples/hw_cdc_hello_world
100+
- path: ./idf_component_examples/esp_matter_light

‎idf_component_examples/esp_matter_light/CMakeLists.txt‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# The following lines of boilerplate have to be in your project's
2+
# CMakeLists in this exact order for cmake to work correctly
3+
cmake_minimum_required(VERSION 3.5)
4+
5+
set(PROJECT_VER "1.0")
6+
set(PROJECT_VER_NUMBER 1)
7+
8+
# This should be done before using the IDF_TARGET variable.
9+
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
10+
11+
project(arduino_managed_component_light)
12+
13+
# WARNING: This is just an example for using key for decrypting the encrypted OTA image
14+
# Please do not use it as is.
15+
if(CONFIG_ENABLE_ENCRYPTED_OTA)
16+
target_add_binary_data(light.elf "esp_image_encryption_key.pem" TEXT)
17+
endif()
18+
19+
if(CONFIG_IDF_TARGET_ESP32C2)
20+
include(relinker)
21+
endif()
22+
23+
idf_build_set_property(CXX_COMPILE_OPTIONS "-std=gnu++17;-Os;-DCHIP_HAVE_CONFIG_H" APPEND)
24+
idf_build_set_property(C_COMPILE_OPTIONS "-Os" APPEND)
25+
# For RISCV chips, project_include.cmake sets -Wno-format, but does not clear various
26+
# flags that depend on -Wformat
27+
idf_build_set_property(COMPILE_OPTIONS "-Wno-format-nonliteral;-Wno-format-security" APPEND)

‎idf_component_examples/esp_matter_light/README.md‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
| Supported Targets | ESP32-S3 | ESP32-C3 | ESP32-C6 |
2+
| ----------------- | -------- | -------- | -------- |
3+
4+
5+
# Managed Component Light
6+
7+
This example is configured by default to work with the ESP32-S3, which has the RGB LED GPIO set as pin 48 and the BOOT button on GPIO 0.
8+
9+
This example creates a Color Temperature Light device using the esp_matter component downloaded from the [Espressif Component Registry](https://components.espressif.com/) instead of an extra component locally, so the example can work without setting up the esp-matter environment.
10+
11+
See the [docs](https://docs.espressif.com/projects/esp-matter/en/latest/esp32/developing.html) for more information about building and flashing the firmware.
12+
13+
The code is based on the Arduino API and uses Arduino as an IDF Component.
14+
15+
## How to use it
16+
17+
Once the device runs for the first time, it must be commissioned to the Matter Fabric of the available Matter Environment.
18+
Possible Matter Environments are:
19+
- Amazon Alexa
20+
- Google Home Assistant (*)
21+
- Apple Home
22+
- Open Source Home Assistant
23+
24+
(*) Google Home Assistant requires the user to set up a Matter Light using the [Google Home Developer Console](https://developers.home.google.com/codelabs/matter-device#2). It is necessary to create a Matter Light device with VID = 0xFFF1 and PID = 0x8000. Otherwise, the Light won't show up in the GHA APP. This action is necessary because the Firmware uses Testing credentials and Google requires the user to create the testing device before using it.
25+
26+
There is no QR Code to be used when the Smartphone APP wants to add the Matter Device.
27+
Please enter the code manually: `34970112332`
28+
29+
The devboard has a built-in LED that will be used as the Matter Light.
30+
The default setting of the code uses pin 48 for the ESP32-S3.
31+
Please change it in `main/matter_accessory_driver.h` or in the `sdkconfig.defaults.<SOC>` file.
32+
33+
## LED Status and Factory Mode
34+
35+
The WS2812b built-in LED will turn purple as soon as the device is flashed and runs for the first time.
36+
The purple color indicates that the Matter Accessory has not been commissioned yet.
37+
After using a Matter provider Smartphone APP to add a Matter device to your Home Application, it may turn orange to indicate that it has no Wi-Fi connection.
38+
39+
Once it connects to the Wi-Fi network, the LED will turn white to indicate that Matter is working and the device is connected to the Matter Environment.
40+
Please note that Matter over Wi-Fi using an ESP32 device will connect to a 2.4 GHz Wi-Fi SSID, therefore the Commissioner APP Smartphone shall be connected to this SSID.
41+
42+
The Matter and Wi-Fi configuration will be stored in NVS to ensure that it will connect to the Matter Fabric and Wi-Fi Network again once it is reset.
43+
44+
The Matter Smartphone APP will control the light state (ON/OFF), temperature (Warm/Cold White), and brightness.
45+
46+
## On Board Light toggle button
47+
48+
The built-in BOOT button will toggle On/Off and replicate the new state to the Matter Environment, making it visible in the Matter Smartphone APP as well.
49+
50+
## Returning to the Factory State
51+
52+
Holding the BOOT button pressed for more than 10 seconds and then releasing it will erase all Matter and Wi-Fi configuration, forcing it to reset to factory state. After that, the device needs to be commissioned again. Previous setups done in the Smartphone APP won't work again; therefore, the virtual device shall be removed from the APP.
53+
54+
## Building the Application using Wi-Fi and Matter
55+
56+
Use ESP-IDF 5.1.4 from https://github.com/espressif/esp-idf/tree/release/v5.1
57+
This example has been tested with Arduino Core 3.0.4
58+
59+
The project will download all necessary components, including the Arduino Core.
60+
Run `idf.py SDKCONFIG_DEFAULTS="sdkconfig.defaults.<SOC>.idf" -p <PORT> flash monitor`
61+
62+
Example for ESP32-S3/Linux | macOS:
63+
`idf.py SDKCONFIG_DEFAULTS="sdkconfig.defaults.esp32s3" -p /dev/ttyACM0 flash monitor`
64+
Example for ESP32-C3/Windows:
65+
`idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults.esp32c3" -p com3 flash monitor`
66+
67+
It may be necessary to delete some folders and files before running `idf.py`
68+
Linux/macOS: `rm -rf build managed_components sdkconfig dependencies.lock`
69+
Windows: `rmdir /s/q build managed_components` and `del sdkconfig dependencies.lock`
70+
71+
There is a configuration file for these SoC: esp32s3, esp32c3, esp32c6.
72+
Those are the tested devices that have a WS2812 RGB LED and can run BLE, Wi-Fi and Matter.
73+
74+
In case it is necessary to change the Button Pin or the REG LED Pin, please use the `menuconfig`
75+
`idf.py menuconfig` and change the Menu Option `Light Matter Accessory`
76+
77+
## Using OpenThread with Matter
78+
79+
This is possible with the ESP32-C6.
80+
It is neessasy to have a Thread Border Routed in the Matter Environment. Check you matter hardware provider.
81+
In order to build the application that will use Thread Networking instead of Wi-Fi, please execute:
82+
83+
Example for ESP32-S3/Linux | macOS:
84+
`idf.py SDKCONFIG_DEFAULTS="sdkconfig.defaults.c6_thread" -p /dev/ttyACM0 flash monitor`
85+
Example for ESP32-C3/Windows:
86+
`idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults.c6_thread" -p com3 flash monitor`
87+
88+
It may be necessary to delete some folders and files before running `idf.py`
89+
Linux/macOS: `rm -rf build managed_components sdkconfig dependencies.lock`
90+
Windows: `rmdir /s/q build managed_components` and `del sdkconfig dependencies.lock`

‎idf_component_examples/esp_matter_light/main/CMakeLists.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
idf_component_register(SRC_DIRS "."
2+
INCLUDE_DIRS ".")
3+
4+
set_property(TARGET ${COMPONENT_LIB} PROPERTY CXX_STANDARD 17)
5+
target_compile_options(${COMPONENT_LIB} PRIVATE "-DCHIP_HAVE_CONFIG_H")

‎idf_component_examples/esp_matter_light/main/Kconfig.projbuild‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
menu "Light Matter Accessory"
2+
menu "On Board Light ON/OFF Button"
3+
config BUTTON_PIN
4+
int
5+
prompt "Button 1 GPIO"
6+
default ENV_GPIO_BOOT_BUTTON
7+
range -1 ENV_GPIO_IN_RANGE_MAX
8+
help
9+
The GPIO pin for button that will be used to turn on/off the Matter Light. It shall be connected to a push button. It can use the BOOT button of the development board.
10+
endmenu
11+
12+
13+
menu "LEDs"
14+
config WS2812_PIN
15+
int
16+
prompt "WS2812 RGB LED GPIO"
17+
default ENV_GPIO_RGB_LED
18+
range -1 ENV_GPIO_OUT_RANGE_MAX
19+
help
20+
The GPIO pin for the Matter Light that will be driven by RMT. It shall be connected to one single WS2812 RGB LED.
21+
endmenu
22+
23+
# TARGET CONFIGURATION
24+
if IDF_TARGET_ESP32C3
25+
config ENV_GPIO_RANGE_MIN
26+
int
27+
default 0
28+
29+
config ENV_GPIO_RANGE_MAX
30+
int
31+
default 19
32+
# GPIOs 20/21 are always used by UART in examples
33+
34+
config ENV_GPIO_IN_RANGE_MAX
35+
int
36+
default ENV_GPIO_RANGE_MAX
37+
38+
config ENV_GPIO_OUT_RANGE_MAX
39+
int
40+
default ENV_GPIO_RANGE_MAX
41+
42+
config ENV_GPIO_BOOT_BUTTON
43+
int
44+
default 9
45+
46+
config ENV_GPIO_RGB_LED
47+
int
48+
default 8
49+
endif
50+
if IDF_TARGET_ESP32C6
51+
config ENV_GPIO_RANGE_MIN
52+
int
53+
default 0
54+
55+
config ENV_GPIO_RANGE_MAX
56+
int
57+
default 30
58+
# GPIOs 16/17 are always used by UART in examples
59+
60+
config ENV_GPIO_IN_RANGE_MAX
61+
int
62+
default ENV_GPIO_RANGE_MAX
63+
64+
config ENV_GPIO_OUT_RANGE_MAX
65+
int
66+
default ENV_GPIO_RANGE_MAX
67+
68+
config ENV_GPIO_BOOT_BUTTON
69+
int
70+
default 9
71+
72+
config ENV_GPIO_RGB_LED
73+
int
74+
default 8
75+
endif
76+
if IDF_TARGET_ESP32S3
77+
config ENV_GPIO_RANGE_MIN
78+
int
79+
default 0
80+
81+
config ENV_GPIO_RANGE_MAX
82+
int
83+
default 48
84+
85+
config ENV_GPIO_IN_RANGE_MAX
86+
int
87+
default ENV_GPIO_RANGE_MAX
88+
89+
config ENV_GPIO_OUT_RANGE_MAX
90+
int
91+
default ENV_GPIO_RANGE_MAX
92+
93+
config ENV_GPIO_BOOT_BUTTON
94+
int
95+
default 0
96+
97+
config ENV_GPIO_RGB_LED
98+
int
99+
default 48
100+
endif
101+
102+
endmenu

0 commit comments

Comments
 (0)