diff options
| author | Patrick | 2023-11-13 22:54:42 +0100 |
|---|---|---|
| committer | Patrick | 2023-11-13 22:54:42 +0100 |
| commit | 948d30fa138bd6c3eef75a234c90fa5843057d4b (patch) | |
| tree | 31e26e98bd152e1d9209afd064e8d2a40ca48e5e | |
| parent | 344ddb2b73ca1f528ad057bcb0ee54862e0018f0 (diff) | |
| download | matrix_esp_thesis-948d30fa138bd6c3eef75a234c90fa5843057d4b.tar.gz matrix_esp_thesis-948d30fa138bd6c3eef75a234c90fa5843057d4b.zip | |
Readme
| -rw-r--r-- | Readme.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -9,6 +9,7 @@ Device verification is also supported. Building requires a C/C++ compiler and make.
To build the dependencies run `make deps`.
+All dependencies are included in this repository.
To build any of the examples run `make out/examples/<example>`.
@@ -21,6 +22,17 @@ To use the library: - Add include path `ext/mjson/src/`
- Add include path `ext/mongoose/`
+To build the example for the ESP32 start an ESP-IDF shell in esp32/esp_project or esp32/esp_project_riscv and run:
+- `idf.py build`
+- `idf.py flash`
+- `idf.py monitor`
+
+To use the library in an ESP-IDF project:
+- Add the matrix and olm components (can be found in `esp32/esp_project/components/`)
+- Add `wifi.c/.h` (can be found in `esp32/esp_project/main/`)
+- Add `SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fpermissive")` to CMakeLists.txt
+- Call `wifi_init("<SSID>", "<PASSWORD>")` before initializing the library
+
## Dependencies
[Mongoose](https://github.com/cesanta/mongoose)
|