Espressif IoT Library. IoT Device Drivers, Documentations And Solutions.
APACHE-2.0 License
ESP-IoT-Solution contains device drivers and code frameworks for the development of IoT systems, providing extra components that enhance the capabilities of ESP-IDF and greatly simplify the development process.
ESP-IoT-Solution contains the following contents:
You can choose any of the ESP series development boards to use ESP-IoT-Solution or choose one of the boards supported in boards component for a quick start.
Powered by 40nm technology, ESP series SoC provides a robust, highly integrated platform, which helps meet the continuous demands for efficient power usage, compact design, security, high performance, and reliability.
ESP-IoT-Solution is developed based on ESP-IDF functions and tools, so ESP-IDF development environment must be set up first, you can refer Setting up Development Environment for the detailed steps.
Please note that different versions of ESP-IoT-Solution may depend on different versions of ESP-IDF, please refer to the below table to select the correct version:
ESP-IoT-Solution | Dependent ESP-IDF | Major Change | User Guide | Support State |
---|---|---|---|---|
master | >= v4.4 | support component manager and new chips | Docs online | active, new feature develop |
release/v1.1 | v4.0.1 | IDF version update, remove no longer supported code | v1.1 Overview | archived |
release/v1.0 | v3.2.2 | legacy version | v1.0 Overview | archived |
Since the
master
branch uses theESP Component Manager
to manager components, each of them is a separate package, and each package may support a different version of the ESP-IDF, which will be declared in the component'sidf_component.yml
file
If you just want to use the components in ESP-IoT-Solution, we recommend you use it from the ESP Component Registry.
The registered components in ESP-IoT-Solution are listed below:
You can directly add the components from the Component Registry to your project by using the idf.py add-dependency
command under your project's root directory. eg run idf.py add-dependency "espressif/usb_stream"
to add the usb_stream
, the component will be downloaded automatically during the CMake
step.
Please refer to IDF Component Manager for details.
If you want to Contribute to the components in ESP-IoT-Solution or want to start from the examples in ESP-IoT-Solution, you can get the ESP-IoT-Solution repository by following the steps:
If select the master
version, open the terminal, and run the following command:
git clone --recursive https://github.com/espressif/esp-iot-solution
If select the release/v1.1
version, open the terminal, and run the following command:
git clone -b release/v1.1 --recursive https://github.com/espressif/esp-iot-solution
We highly recommend you Build Your First Project to get familiar with ESP-IDF and make sure the environment is set up correctly.
There is no difference between building and flashing the examples in ESP-IoT-Solution and in ESP-IDF. In most cases, you can build and flash the examples in ESP-IoT-Solution by following the steps:
cd examples/usb/host/usb_audio_player
.idf.py set-target TARGET
to set the target chip. eg idf.py set-target esp32s3
to set the target chip to ESP32-S3.idf.py build
to build the example.idf.py -p PORT flash monitor
to flash the example, and view the serial output. eg idf.py -p /dev/ttyUSB0 flash monitor
to flash the example and view the serial output on /dev/ttyUSB0
.Some examples may need extra steps to setup the ESP-IoT-Solution environment, you can run
export IOT_SOLUTION_PATH=~/esp/esp-iot-solution
in Linux/MacOS orset IOT_SOLUTION_PATH=C:\esp\esp-iot-solution
in Windows to setup the environment.