yhanchristian/esp-bsp

Board support components for Espressif development boards

ESP-BSP: Espressif's Board Support Packages

Board support packages for development boards using Espressif's SoCs, written in C.

Supported boards

Board name	SoC	Features	Photo
ESP-WROVER-KIT	ESP32	LCD display, uSD card slot
ESP-BOX	ESP32-S3	LCD display with touch, audio codec + power amplifier, accelerometer and gyroscope
ESP32-Azure IoT Kit	ESP32	OLED display, uSD card slot, accelerometer, magnetometer, humidity, pressure, light and temperature sensors
ESP32-S2-Kaluga Kit	ESP32-S2	LCD display, audio codec + power amplifier, smart LED and camera
ESP32-S3-USB-OTG	ESP32-S3	LCD display, uSD card slot, USB-OTG

How to use

Examples

Best way to start with ESP-BSP is trying one of the examples on your board. Every example contains README.md with list of supported boards. Here is a examples' summary:

Example	Supported boards
display	WROVER-KIT
display_audio	Kaluga-kit
mqtt_example	Azure-IoT-kit
rainmaker_example	Azure-IoT-kit
sensors_example	Azure-IoT-kit

In custom project

Packages from this repository are uploaded to Espressif's component service. You can add them to your project via idf.py add-dependancy, e.g.

    idf.py add-dependency esp_wrover_kit==1.0.0

Alternatively, you can create idf_component.yml file manually, such as in this example.

Migration to ESP-IDF version 5.0

esp-idf 5.0 brings a lot of new features, but, as the bump in major version suggests, also lot of breaking changes.

ESP-BSP is kept up-to-date with latest esp-idf version, but some breaking changes in ESP-BSP API are inevitable. Usually, BSPs compatible with IDF v5.0 are version 2. If you want to use BSP with IDF v4.4 you can still use version 1 of the particular BSP.

More information can be found in official migration guide.

Additional information

More information about idf-component-manager can be found in Espressif API guide or PyPi registry.