From beae607419351f0485a3cfa1514035e19096e2d8 Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Sun, 27 Oct 2019 10:16:36 -0600 Subject: [PATCH 1/2] Docs for lib builder --- docs/esp-idf_component.md | 4 ++++ docs/lib_builder.md | 14 ++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 docs/lib_builder.md diff --git a/docs/esp-idf_component.md b/docs/esp-idf_component.md index e58c157328d..4e29b1acb2a 100644 --- a/docs/esp-idf_component.md +++ b/docs/esp-idf_component.md @@ -1,6 +1,10 @@ To use as a component of ESP-IDF ================================================= +## esp32-arduino-lib-builder + +For a simplified method, see [lib-builder](lib_builder.md) + ## Installation - Download and install [esp-idf](https://github.com/espressif/esp-idf) diff --git a/docs/lib_builder.md b/docs/lib_builder.md new file mode 100644 index 00000000000..4f637bb91fb --- /dev/null +++ b/docs/lib_builder.md @@ -0,0 +1,14 @@ +## Using esp32-arduino-lib-builder to compile custom libraries + +Espressif has provided a [tool](https://github.com/espressif/esp32-arduino-lib-builder) to simplify building your own compiled libraries for use in Arduino IDE (or your favorite IDE). +To use it to generate custom libraries, follow these steps: +1. `git clone https://github.com/espressif/esp32-arduino-lib-builder` +2. `cd esp32-arduino-lib-builder` +3. `./tools/update-components.sh` +4. `./tools/install-esp-idf.sh` (if you already have an $IDF_PATH defined, it will use your local copy of the repository) +5. Edit sdkconfig as needed, or run make menuconfig. +6. `./build.sh` + +The script automates the process or building [arduino as an ESP-IDF component](https://github.com/espressif/arduino-esp32/blob/master/docs/esp-idf_component.md). +Once it is complete, you can cherry pick the needed libraries from `out/tools/sdk/lib`, or run `tools/copy-to-arduino.sh` to copy the entire built system. +`tools/config.sh` contains a number of variables that control the process, particularly the $IDF_BRANCH variable. You can adjust this to try building against newer versions, but there are absolutely no guarantees than any components will work or even succesfully compile against a newer IDF. From 680bb2bfc28bd107b41316dffdbdc43df68da1df Mon Sep 17 00:00:00 2001 From: Larry Bernstone Date: Sun, 27 Oct 2019 15:27:25 -0600 Subject: [PATCH 2/2] Typos and such --- docs/lib_builder.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/lib_builder.md b/docs/lib_builder.md index 4f637bb91fb..66cca92206a 100644 --- a/docs/lib_builder.md +++ b/docs/lib_builder.md @@ -6,9 +6,9 @@ To use it to generate custom libraries, follow these steps: 2. `cd esp32-arduino-lib-builder` 3. `./tools/update-components.sh` 4. `./tools/install-esp-idf.sh` (if you already have an $IDF_PATH defined, it will use your local copy of the repository) -5. Edit sdkconfig as needed, or run make menuconfig. +5. `make menuconfig` or directly edit sdkconfig. 6. `./build.sh` -The script automates the process or building [arduino as an ESP-IDF component](https://github.com/espressif/arduino-esp32/blob/master/docs/esp-idf_component.md). +The script automates the process of building [arduino as an ESP-IDF component](https://github.com/espressif/arduino-esp32/blob/master/docs/esp-idf_component.md). Once it is complete, you can cherry pick the needed libraries from `out/tools/sdk/lib`, or run `tools/copy-to-arduino.sh` to copy the entire built system. -`tools/config.sh` contains a number of variables that control the process, particularly the $IDF_BRANCH variable. You can adjust this to try building against newer versions, but there are absolutely no guarantees than any components will work or even succesfully compile against a newer IDF. +`tools/config.sh` contains a number of variables that control the process, particularly the $IDF_BRANCH variable. You can adjust this to try building against newer versions, but there are absolutely no guarantees that any components will work or even successfully compile against a newer IDF.