base on Espressif IoT Library. IoT Device Drivers, Documentations and Solutions. [](https://docs.espressif.com/projects/esp-iot-solution/en) <a href="https://espressif.github.io/esp-launchpad/?flashConfigURL=https://dl.espressif.com/AE/esp-iot-solution/config.toml"> <img alt="Try it with ESP Launchpad" src="https://espressif.github.io/esp-launchpad/assets/try_with_launchpad.png" width="200" height="56"> </a> ## Espressif IoT Solution Overview * [中文版](./README_CN.md) 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: * Device drivers for sensors, display, audio, input, actuators, etc. * Framework and documentation for Low power, security, storage, etc. * Guide for espressif open source solutions from practical application point. ## Documentation Center - 中文：https://docs.espressif.com/projects/esp-iot-solution/zh_CN - English:https://docs.espressif.com/projects/esp-iot-solution/en ## Quick Reference ### Development Board 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](./examples/common_components/boards) 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. ### Setup Environment #### Setup ESP-IDF Environment 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](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#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 | >= v5.3 | New Chips Support | [Docs online](https://docs.espressif.com/projects/esp-iot-solution/) | New features | | release/v2.0 | <= v5.3, >= v4.4 | Support component manager | [Docs online](https://docs.espressif.com/projects/esp-iot-solution/en/release-v2.0/index.html) | Bugfix only，until v5.3 EOL | | release/v1.1 | v4.0.1 | IDF version update, remove no longer supported code | [v1.1 Overview](https://github.com/espressif/esp-iot-solution/tree/release/v1.1#esp32-iot-solution-overview) | archived | | release/v1.0 | v3.2.2 | legacy version | [v1.0 Overview](https://github.com/espressif/esp-iot-solution/tree/release/v1.0#esp32-iot-solution-overview) | archived | > Since the `master` branch uses the `ESP 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's `idf_component.yml` file #### Get Components from ESP Component Registry If you just want to use the components in ESP-IoT-Solution, we recommend you use it from the [ESP Component Registry](https://components.espressif.com/). The registered components in ESP-IoT-Solution are listed below: <center> | Component | Version | | --- | --- | | [aht20](https://components.espressif.com/components/espressif/aht20) | [](https://components.espressif.com/components/espressif/aht20) | | [apds9960](https://components.espressif.com/components/espressif/apds9960) | [](https://components.espressif.com/components/espressif/apds9960) | | [at581x](https://components.espressif.com/components/espressif/at581x) | [](https://components.espressif.com/components/espressif/at581x) | | [avi_player](https://components.espressif.com/components/espressif/avi_player) | [](https://components.espressif.com/components/espressif/avi_player) | | [ble_anp](https://components.espressif.com/components/espressif/ble_anp) | [](https://components.espressif.com/components/espressif/ble_anp) | | [ble_conn_mgr](https://components.espressif.com/components/espressif/ble_conn_mgr) | [](https://components.espressif.com/components/espressif/ble_conn_mgr) | | [ble_hci](https://components.espressif.com/components/espressif/ble_hci) | [](https://components.espressif.com/components/espressif/ble_hci) | | [ble_hrp](https://components.espressif.com/components/espressif/ble_hrp) | [](https://components.espressif.com/components/espressif/ble_hrp) | | [ble_htp](https://components.espressif.com/components/espressif/ble_htp) | [](https://components.espressif.com/components/espressif/ble_htp) | | [ble_ota](https://components.espressif.com/components/espressif/ble_ota) | [](https://components.espressif.com/components/espressif/ble_ota) | | [ble_services](https://components.espressif.com/components/espressif/ble_services) | [](https://components.espressif.com/components/espressif/ble_services) | | [bme280](https://components.espressif.com/components/espressif/bme280) | [](https://components.espressif.com/components/espressif/bme280) | | [bootloader_support_plus](https://components.espressif.com/components/espressif/bootloader_support_plus) | [](https://components.espressif.com/components/espressif/bootloader_support_plus) | | [button](https://components.espressif.com/components/espressif/button) | [](https://components.espressif.com/components/espressif/button) | | [cmake_utilities](https://components.espressif.com/components/espressif/cmake_utilities) | [](https://components.espressif.com/components/espressif/cmake_utilities) | | [drv10987](https://components.espressif.com/components/espressif/drv10987) | [](https://components.espressif.com/components/espressif/drv10987) | | [elf_loader](https://components.espressif.com/components/espressif/elf_loader) | [](https://components.espressif.com/components/espressif/elf_loader) | | [esp_lcd_axs15231b](https://components.espressif.com/components/espressif/esp_lcd_axs15231b) | [](https://components.espressif.com/components/espressif/esp_lcd_axs15231b) | | [esp_lcd_ek79007](https://components.espressif.com/components/espressif/esp_lcd_ek79007) | [](https://components.espressif.com/components/espressif/esp_lcd_ek79007) | | [esp_lcd_gc9b71](https://components.espressif.com/components/espressif/esp_lcd_gc9b71) | [](https://components.espressif.com/components/espressif/esp_lcd_gc9b71) | | [esp_lcd_hx8399](https://components.espressif.com/components/espressif/esp_lcd_hx8399) | [](https://components.espressif.com/components/espressif/esp_lcd_hx8399) | | [esp_lcd_jd9165](https://components.espressif.com/components/espressif/esp_lcd_jd9165) | [](https://components.espressif.com/components/espressif/esp_lcd_jd9165) | | [esp_lcd_jd9365](https://components.espressif.com/components/espressif/esp_lcd_jd9365) | [](https://components.espressif.com/components/espressif/esp_lcd_jd9365) | | [esp_lcd_nv3022b](https://components.espressif.com/components/espressif/esp_lcd_nv3022b) | [](https://components.espressif.com/components/espressif/esp_lcd_nv3022b) | | [esp_lcd_panel_io_additions](https://components.espressif.com/components/espressif/esp_lcd_panel_io_additions) | [](https://components.espressif.com/components/espressif/esp_lcd_panel_io_additions) | | [esp_lcd_sh8601](https://components.espressif.com/components/espressif/esp_lcd_sh8601) | [](https://components.espressif.com/components/espressif/esp_lcd_sh8601) | | [esp_lcd_spd2010](https://components.espressif.com/components/espressif/esp_lcd_spd2010) | [](https://components.espressif.com/components/espressif/esp_lcd_spd2010) | | [esp_lcd_st7701](https://components.espressif.com/components/espressif/esp_lcd_st7701) | [](https://components.espressif.com/components/espressif/esp_lcd_st7701) | | [esp_lcd_st7703](https://components.espressif.com/components/espressif/esp_lcd_st7703) | [](https://components.espressif.com/components/espressif/esp_lcd_st7703) | | [esp_lcd_st77903_qspi](https://components.espressif.com/components/espressif/esp_lcd_st77903_qspi) | [](https://components.espressif.com/components/espressif/esp_lcd_st77903_qspi) | | [esp_lcd_st77903_rgb](https://components.espressif.com/components/espressif/esp_lcd_st77903_rgb) | [](https://components.espressif.com/components/espressif/esp_lcd_st77903_rgb) | | [esp_lcd_st77916](https://components.espressif.com/components/espressif/esp_lcd_st77916) | [](https://components.espressif.com/components/espressif/esp_lcd_st77916) | | [esp_lcd_st77922](https://components.espressif.com/components/espressif/esp_lcd_st77922) | [](https://components.espressif.com/components/espressif/esp_lcd_st77922) | | [esp_lcd_touch_spd2010](https://components.espressif.com/components/espressif/esp_lcd_touch_spd2010) | [](https://components.espressif.com/components/espressif/esp_lcd_touch_spd2010) | | [esp_lcd_touch_st7123](https://components.espressif.com/components/espressif/esp_lcd_touch_st7123) | [](https://components.espressif.com/components/espressif/esp_lcd_touch_st7123) | | [esp_lcd_usb_display](https://components.espressif.com/components/espressif/esp_lcd_usb_display) | [](https://components.espressif.com/components/espressif/esp_lcd_usb_display) | | [esp_lv_decoder](https://components.espressif.com/components/espressif/esp_lv_decoder) | [](https://components.espressif.com/components/espressif/esp_lv_decoder) | | [esp_lv_fs](https://components.espressif.com/components/espressif/esp_lv_fs) | [](https://components.espressif.com/components/espressif/esp_lv_fs) | | [esp_mmap_assets](https://components.espressif.com/components/espressif/esp_mmap_assets) | [](https://components.espressif.com/components/espressif/esp_mmap_assets) | | [esp_msc_ota](https://components.espressif.com/components/espressif/esp_msc_ota) | [](https://components.espressif.com/components/espressif/esp_msc_ota) | | [esp_sensorless_bldc_control](https://components.espressif.com/components/espressif/esp_sensorless_bldc_control) | [](https://components.espressif.com/components/espressif/esp_sensorless_bldc_control) | | [esp_simplefoc](https://components.espressif.com/components/espressif/esp_simplefoc) | [](https://components.espressif.com/components/espressif/esp_simplefoc) | | [esp_tinyuf2](https://components.espressif.com/components/espressif/esp_tinyuf2) | [](https://components.espressif.com/components/espressif/esp_tinyuf2) | | [extended_vfs](https://components.espressif.com/components/espressif/extended_vfs) | [](https://components.espressif.com/components/espressif/extended_vfs) | | [gprof](https://components.espressif.com/components/espressif/gprof) | [](https://components.espressif.com/components/espressif/gprof) | | [hdc2010](https://components.espressif.com/components/espressif/hdc2010) | [](https://components.espressif.com/components/espressif/hdc2010) | | [i2c_bus](https://components.espressif.com/components/espressif/i2c_bus) | [](https://components.espressif.com/components/espressif/i2c_bus) | | [ina236](https://components.espressif.com/components/espressif/ina236) | [](https://components.espressif.com/components/espressif/ina236) | | [iot_usbh](https://components.espressif.com/components/espressif/iot_usbh) | [](https://components.espressif.com/components/espressif/iot_usbh) | | [iot_usbh_cdc](https://components.espressif.com/components/espressif/iot_usbh_cdc) | [](https://components.espressif.com/components/espressif/iot_usbh_cdc) | | [iot_usbh_modem](https://components.espressif.com/components/espressif/iot_usbh_modem) | [](https://components.espressif.com/components/espressif/iot_usbh_modem) | | [ir_learn](https://components.espressif.com/components/espressif/ir_learn) | [](https://components.espressif.com/components/espressif/ir_learn) | | [keyboard_button](https://components.espressif.com/components/espressif/keyboard_button) | [](https://components.espressif.com/components/espressif/keyboard_button) | | [knob](https://components.espressif.com/components/espressif/knob) | [](https://components.espressif.com/components/espressif/knob) | | [led_indicator](https://components.espressif.com/components/espressif/led_indicator) | [](https://components.espressif.com/components/espressif/led_indicator) | | [lightbulb_driver](https://components.espressif.com/components/espressif/lightbulb_driver) | [](https://components.espressif.com/components/espressif/lightbulb_driver) | | [lis2dh12](https://components.espressif.com/components/espressif/lis2dh12) | [](https://components.espressif.com/components/espressif/lis2dh12) | | [mvh3004d](https://components.espressif.com/components/espressif/mvh3004d) | [](https://components.espressif.com/components/espressif/mvh3004d) | | [ntc_driver](https://components.espressif.com/components/espressif/ntc_driver) | [](https://components.espressif.com/components/espressif/ntc_driver) | | [openai](https://components.espressif.com/components/espressif/openai) | [](https://components.espressif.com/components/espressif/openai) | | [power_measure](https://components.espressif.com/components/espressif/power_measure) | [](https://components.espressif.com/components/espressif/power_measure) | | [pwm_audio](https://components.espressif.com/components/espressif/pwm_audio) | [](https://components.espressif.com/components/espressif/pwm_audio) | | [servo](https://components.espressif.com/components/espressif/servo) | [](https://components.espressif.com/components/espressif/servo) | | [sht3x](https://components.espressif.com/components/espressif/sht3x) | [](https://components.espressif.com/components/espressif/sht3x) | | [spi_bus](https://components.espressif.com/components/espressif/spi_bus) | [](https://components.espressif.com/components/espressif/spi_bus) | | [touch_proximity_sensor](https://components.espressif.com/components/espressif/touch_proximity_sensor) | [](https://components.espressif.com/components/espressif/touch_proximity_sensor) | | [usb_device_uac](https://components.espressif.com/components/espressif/usb_device_uac) | [](https://components.espressif.com/components/espressif/usb_device_uac) | | [usb_device_uvc](https://components.espressif.com/components/espressif/usb_device_uvc) | [](https://components.espressif.com/components/espressif/usb_device_uvc) | | [usb_stream](https://components.espressif.com/components/espressif/usb_stream) | [](https://components.espressif.com/components/espressif/usb_stream) | | [veml6040](https://components.espressif.com/components/espressif/veml6040) | [](https://components.espressif.com/components/espressif/veml6040) | | [veml6075](https://components.espressif.com/components/espressif/veml6075) | [](https://components.espressif.com/components/espressif/veml6075) | | [xz](https://components.espressif.com/components/espressif/xz) | [](https://components.espressif.com/components/espressif/xz) | | [zero_detection](https://components.espressif.com/components/espressif/zero_detection) | [](https://components.espressif.com/components/espressif/zero_detection) | </center> 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](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html) for details. #### Get ESP-IoT-Solution Repository If you want to [Contribute](https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/contribute/index.html) 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/v2.0` version, open the terminal, and run the following command: ``` git clone -b release/v2.0 --recursive https://github.com/espressif/esp-iot-solution ``` #### Build and Flash Examples **We highly recommend** you [Build Your First Project](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#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: 1. Change the current directory to the example directory, eg `cd examples/usb/host/usb_audio_player`. 2. Run `idf.py set-target TARGET` to set the target chip. eg `idf.py set-target esp32s3` to set the target chip to ESP32-S3. 3. Run `idf.py build` to build the example. 4. Run `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 or `set IOT_SOLUTION_PATH=C:\esp\esp-iot-solution` in Windows to setup the environment. ### Resources - Documentation for the latest version: https://docs.espressif.com/projects/esp-iot-solution/ . This documentation is built from the [docs directory](./docs) of this repository. - ESP-IDF Programming Guide: https://docs.espressif.com/projects/esp-idf/zh_CN . Please refer to the version ESP-IoT-Solution depends on. - The [IDF Component Registry](https://components.espressif.com/) is where you can find the components in ESP-IoT-Solution and other registered components. - The [esp32.com forum](https://www.esp32.com/) is a place to ask questions and find community resources. - [Check the Issues section on GitHub](https://github.com/espressif/esp-iot-solution/issues) if you find a bug or have a feature request. Please check existing Issues before opening a new one. - If you're interested in contributing to ESP-IDF, please check the [Contributions Guide](./CONTRIBUTING.rst). ", Assign "at most 3 tags" to the expected json: {"id":"11634","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"