Skip to content
This repository was archived by the owner on Jan 31, 2025. It is now read-only.

Commit 6d1bdef

Browse files
committed
Update dependencies, update readme
1 parent 11eadc2 commit 6d1bdef

File tree

4 files changed

+28
-21
lines changed

4 files changed

+28
-21
lines changed

lib_files/README.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,30 @@
22
This projects aims at possibility to easily launch Matter internet-of-things protocol on ESP32 with Arduino. Repository contains precompiled and ready to use components from two projects: [Espressif's SDK for Matter](https://github.com/espressif/esp-matter) and [Matter](https://github.com/project-chip/connectedhomeip).
33

44
## Installing on Arduino IDE
5-
1. Make sure that ESP32 board version is {{ ARDUINO_ESP32_VERSION }}
6-
2. [Turn on C++17 support for Arduino](#enabling-c17-on-arduino-ide)
7-
3. [Download](https://github.com/jakubdybczak/esp32-arduino-matter/releases) and [import library into Arduino IDE](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries)
8-
4. Choose larger partition scheme, for example `Minimal SPIFFS`
9-
5. To prevent some issues related to old data, enable `Erase Flash Before Sketch Upload` option
10-
6. Run example sketch
5+
1. Make sure that ESP32 board version is **{{ ARDUINO_ESP32_VERSION }}**. **This is crucial**, because this library contains pre-compiled files.
6+
2. [Turn on C++17 support for Arduino](#enabling-c17-on-arduino-ide).
7+
3. [Download](https://github.com/Yacubane/esp32-arduino-matter/releases) and [import library into Arduino IDE](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries).
8+
4. Choose larger partition scheme, for example `Minimal SPIFFS`.
9+
5. To prevent some issues related to old data, enable `Erase Flash Before Sketch Upload` option.
10+
6. Run example sketch.
1111

1212
## Installing on PlatformIO
13-
1. Use espressif32 platform at version {{ PLATFORMIO_ESPRESSIF_VERSION }}
14-
2. Turn on C++17 support, by setting `build_unflags=-std=gnu++11` and `build_flags=-std=gnu++17`.
15-
3. [Download](https://github.com/jakubdybczak/esp32-arduino-matter/releases) and put library into lib folder of project (:warning: you cannot use `lib_deps` in `platformio.ini`, because this repository does not contain binaries due to too big size)
16-
4. Choose larger partition scheme, for example `board_build.partitions=min_spiffs.csv`
17-
5. Run example sketch
13+
1. Use espressif32 platform at version **{{ PLATFORMIO_ESPRESSIF_VERSION }}**, by setting `platform = espressif32@{{ PLATFORMIO_ESPRESSIF_VERSION }}` in `platformio.ini`. **This is crucial**, because this library contains pre-compiled files.
14+
2. Turn on C++17 support, by setting `build_unflags=-std=gnu++11` and `build_flags=-std=gnu++17` in `platformio.ini`.
15+
3. [Download](https://github.com/Yacubane/esp32-arduino-matter/releases) and put library into `lib` folder of project (:warning: you cannot use `lib_deps` in `platformio.ini`, because this repository does not contain binaries due to too big size). The desired structure is as follows:
16+
```
17+
|--platformio-project
18+
| |--lib
19+
| | |--esp32-arduino-matter
20+
| | | |--examples
21+
| | | |--src
22+
| | | |--...
23+
```
24+
4. Choose larger partition scheme, for example `board_build.partitions=min_spiffs.csv` in `platformio.ini`. `min_spiffs.csv` is one of build-in partition schemas and does need to be created.
25+
5. Run example sketch.
1826

1927
## Example usage
20-
Please look at [examples](https://github.com/jakubdybczak/esp32-arduino-matter/tree/master/examples).
28+
In `examples` folder there are some sketches that demonstrates usage of Matter. `Light` example is tested every release. Example sketches are in [release](https://github.com/Yacubane/esp32-arduino-matter/releases) created from [esp32-arduino-matter-builder repository](https://github.com/Yacubane/esp32-arduino-matter-builder/tree/master/lib_files/examples).
2129

2230
## Compatibility
2331
This project contains precompiled libraries based on specific version of ESP32 SDK and this library does not guarantee support for other versions. Current build is based on `esp-idf` at version {{ ESP_IDF_VERSION }} and will work with:
@@ -30,19 +38,18 @@ This project contains precompiled libraries based on specific version of ESP32 S
3038
* There is no known possibility to change setup PIN.
3139
* This library comes with precompiled NimBLE, because default Bluedroid shipped with arduino-esp32 takes too much RAM memory.
3240
* Matter Controllers such as Apple Home, Google Home, SmartThings and others might not have full support of all device types.
33-
* This repository does not contain source code of this library, because binaries were too big and exceeded Github limits. Please look at Github [releases](https://github.com/jakubdybczak/esp32-arduino-matter/releases) to download whole package. All library files without binaries are stored [here](https://github.com/jakubdybczak/esp32-arduino-matter-builder).
41+
* This repository does not contain source code of this library, because binaries were too big and exceeded Github limits. Please look at Github [releases](https://github.com/Yacubane/esp32-arduino-matter/releases) to download whole package. All library files without binaries are stored [here](https://github.com/Yacubane/esp32-arduino-matter-builder).
3442

3543
## Versions
3644
This project is currently build based on these projects:
3745

3846
| Project | Tag / Commit hash |
3947
| ------------- | ------------- |
40-
| [esp32-arduino-matter-builder ](https://github.com/jakubdybczak/esp32-arduino-matter-builder) | {{ ESP32_ARDUINO_MATTER_BUILDER_VERSION }} |
48+
| [esp32-arduino-matter-builder](https://github.com/Yacubane/esp32-arduino-matter-builder) | {{ ESP32_ARDUINO_MATTER_BUILDER_VERSION }} |
4149
| [Matter](https://github.com/project-chip/connectedhomeip) | {{ MATTER_VERSION }} |
4250
| [esp-matter](https://github.com/espressif/esp-matter) | {{ ESP_MATTER_VERSION }} |
4351
| [esp-idf](https://github.com/espressif/esp-idf) | {{ ESP_IDF_VERSION }} |
44-
45-
52+
| [arduino-esp32](https://github.com/espressif/arduino-esp32) | {{ ARDUINO_ESP32_VERSION }} |
4653

4754
## Enabling C++17 on Arduino IDE
4855
1. Find `platform.txt` for ESP32 board. Location of this file is platform depended.
@@ -56,4 +63,4 @@ This project is currently build based on these projects:
5663
3. Restart Arduino IDE.
5764

5865
## Rest of files and process of building custom version of this library
59-
Please look [here](https://github.com/jakubdybczak/esp32-arduino-matter-builder).
66+
Please look [here](https://github.com/Yacubane/esp32-arduino-matter-builder).

lib_files/examples/Light/Light.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ static esp_err_t on_attribute_update(attribute::callback_type_t type, uint16_t e
4848
if (type == attribute::PRE_UPDATE && endpoint_id == light_endpoint_id &&
4949
cluster_id == CLUSTER_ID && attribute_id == ATTRIBUTE_ID) {
5050
// We got an light on/off attribute update!
51-
boolean new_state = val->val.b;
51+
bool new_state = val->val.b;
5252
digitalWrite(LED_PIN, new_state);
5353
}
5454
return ESP_OK;

lib_files/examples/TwoEndpointsPluginUnit/TwoEndpointsPluginUnit.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ static esp_err_t on_attribute_update(attribute::callback_type_t type,
5454
void *priv_data) {
5555
if (type == attribute::PRE_UPDATE && cluster_id == CLUSTER_ID && attribute_id == ATTRIBUTE_ID) {
5656
// We got an plugin unit on/off attribute update!
57-
boolean new_state = val->val.b;
57+
bool new_state = val->val.b;
5858
if (endpoint_id == plugin_unit_endpoint_id_1) {
5959
digitalWrite(LED_PIN_1, new_state);
6060
} else if (endpoint_id == plugin_unit_endpoint_id_2) {

scripts/download.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ cd tools
33

44
ESP_IDF_VERSION="v4.4.4"
55
MATTER_VERSION="bd17b9f"
6-
ESP_MATTER_VERSION="575d51c"
7-
ARDUINO_ESP32_VERSION="2.0.7"
6+
ESP_MATTER_VERSION="0b1762e"
7+
ARDUINO_ESP32_VERSION="2.0.8"
88

99
git clone --recursive -b $ESP_IDF_VERSION https://github.com/espressif/esp-idf
1010
git clone --recursive https://github.com/espressif/esp-matter

0 commit comments

Comments
 (0)