You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 31, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: lib_files/README.md
+24-17Lines changed: 24 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -2,22 +2,30 @@
2
2
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).
3
3
4
4
## 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.
11
11
12
12
## 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.
18
26
19
27
## 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).
21
29
22
30
## Compatibility
23
31
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
30
38
* There is no known possibility to change setup PIN.
31
39
* This library comes with precompiled NimBLE, because default Bluedroid shipped with arduino-esp32 takes too much RAM memory.
32
40
* 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).
34
42
35
43
## Versions
36
44
This project is currently build based on these projects:
0 commit comments