|
1 |
| -# ESP32 Arduino Lib Builder [](https://travis-ci.org/espressif/esp32-arduino-lib-builder) |
| 1 | +## Using esp32-arduino-lib-builder to compile custom libraries |
2 | 2 |
|
3 |
| -This repository contains the scripts that produce the libraries included with esp32-arduino. |
| 3 | +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). |
| 4 | +To use it to generate custom libraries, follow these steps: |
| 5 | +1. `git clone https://github.com/espressif/esp32-arduino-lib-builder` |
| 6 | +2. `cd esp32-arduino-lib-builder` |
| 7 | +3. `./tools/update-components.sh` |
| 8 | +4. `./tools/install-esp-idf.sh` (if you already have an $IDF_PATH defined, it will use your local copy of the repository) |
| 9 | +5. `make menuconfig` or directly edit sdkconfig. |
| 10 | +6. `./build.sh` |
4 | 11 |
|
5 |
| -Tested on Ubuntu (32 and 64 bit), Raspberry Pi and MacOS. |
6 |
| - |
7 |
| -### Build on Ubuntu and Raspberry Pi |
8 |
| -```bash |
9 |
| -sudo apt-get install git wget curl libssl-dev libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-click python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache |
10 |
| -sudo pip install --upgrade pip |
11 |
| -git clone https://github.com/espressif/esp32-arduino-lib-builder |
12 |
| -cd esp32-arduino-lib-builder |
13 |
| -./build.sh |
14 |
| -``` |
| 12 | +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). |
| 13 | +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. |
| 14 | +`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. |
0 commit comments