Skip to content

Commit 57ff4c9

Browse files
committed
Update readme
1 parent f59ad42 commit 57ff4c9

File tree

1 file changed

+29
-19
lines changed

1 file changed

+29
-19
lines changed

README.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,34 @@
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 2.0.7
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 **2.0.8**. **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 v6.1.0
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 **6.1.0**, by setting `platform = [email protected]` 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. Copy and 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 v4.4.4 and will work with:
24-
* Arduino IDE with [ESP32 board](https://github.com/espressif/arduino-esp32) at version 2.0.7
32+
* Arduino IDE with [ESP32 board](https://github.com/espressif/arduino-esp32) at version 2.0.8
2533
* PlatformIO with [PlatformIO espressif32 platform](https://github.com/platformio/platform-espressif32) at version v6.1.0
2634

2735
## Limitations
@@ -30,27 +38,29 @@ 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-
| [Matter](https://github.com/project-chip/connectedhomeip) | bc8c9ec |
41-
| [esp-matter](https://github.com/espressif/esp-matter) | f2e77d2 |
48+
| [esp32-arduino-matter-builder](https://github.com/Yacubane/esp32-arduino-matter-builder) | v1.0.0-beta.4 |
49+
| [Matter](https://github.com/project-chip/connectedhomeip) | bd17b9f52f |
50+
| [esp-matter](https://github.com/espressif/esp-matter) | 0b1762e |
4251
| [esp-idf](https://github.com/espressif/esp-idf) | v4.4.4 |
52+
| [arduino-esp32](https://github.com/espressif/arduino-esp32) | 2.0.8 |
4353

4454
## Enabling C++17 on Arduino IDE
4555
1. Find `platform.txt` for ESP32 board. Location of this file is platform depended.
4656

47-
MacOS: `~/Library/Arduino15/packages/esp32/hardware/esp32/2.0.7/platform.txt`
57+
MacOS: `~/Library/Arduino15/packages/esp32/hardware/esp32/2.0.8/platform.txt`
4858

49-
Windows: `C:\Users\<USER>\AppData\Local\Arduino15\packages\esp32\hardware\esp32\2.0.7\platform.txt`
59+
Windows: `C:\Users\<USER>\AppData\Local\Arduino15\packages\esp32\hardware\esp32\2.0.8\platform.txt`
5060

5161
2. Inside `platform.txt` find `ESP32 Support Start` section and it's `compiler.cpp.flags.esp32` key. Change `-std=gnu++11` to `-std=gnu++17`. Do the same thing for `ESP32S3` and `ESP32C3` `Support Start` section if you are using ESP32-S3/ESP32-C3.
5262

5363
3. Restart Arduino IDE.
5464

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

0 commit comments

Comments
 (0)