# esp-bsp **Repository Path**: vt-developer/esp-bsp ## Basic Information - **Project Name**: esp-bsp - **Description**: No description available - **Primary Language**: C - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-06-27 - **Last Updated**: 2025-06-21 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) # ESP-BSP: Espressif's Board Support Packages | [HOW TO USE](docu/how_to_use.md) | [BOARDS](#supported-boards) | [EXAMPLES](#examples) | [CONTRIBUTING](docu/CONTRIBUTING.md) | [LVGL port](components/esp_lvgl_port) | [LCD drivers](docu/LCD.md) | | :---------------------------------------: | :-------------------------: | :-------------------: | :--------------: | :-----------------------------------: | :------------------------: | This repository provides **Board Support Packages (BSPs)** for various Espressif and M5Stack development boards. Written in **C**, each BSP offers a **unified and consistent API** to simplify the initialization and use of common onboard peripherals such as **displays, touch panels, audio codecs, SD cards, and selected sensors.** The goal is to streamline development and reduce hardware-specific boilerplate, enabling faster prototyping and cleaner application code. ## Main Purpose of BSP 1. **Simplify development** on Espressif and M5Stack boards by providing ready-to-use peripheral initialization. 2. **Enable quick project startup** on supported development boards, with an easy path to **migrate to custom hardware**. 3. **Facilitate cross-board development** by offering a **common API**, making it easier to build and maintain projects for multiple boards. ## Supported IDF versions The following table shows the compatibility of this BSP with different ESP-IDF versions: | 4.x | 5.0 | 5.1 | 5.2 | 5.3 | 5.4 | 5.5 | | :-: | :-: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: | | :x: | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | ## Supported Boards | Board name | SoC | Supported Features | Photo | |:----------:|:---:|:-------------------|:-----:| | [ESP-BOX-3](bsp/esp-box-3) | esp32s3 | :musical_note: Audio
:microphone: Audio Microphone (es7210)
:speaker: Audio Speaker (es8311)
:radio_button: Button
:pager: LCD Display (st7789, ili9341)
:video_game: IMU
:floppy_disk: uSD Card
:point_up: Display Touch (tt21100, gt911)
|

| | [ESP32-C3-LCDKit](bsp/esp32_c3_lcdkit) | esp32c3 | :musical_note: Audio
:speaker: Audio Speaker
:pager: LCD Display (gc9a01)
:white_circle: Knob
:bulb: LED
|

| | [ESP32-LyraT](bsp/esp32_lyrat) | esp32 | :musical_note: Audio
:microphone: Audio Microphone (es8388)
:speaker: Audio Speaker (es8388)
:radio_button: Button
:bulb: LED
:floppy_disk: uSD Card
|

| | [ESP32-P4 Function EV Board](bsp/esp32_p4_function_ev_board) | esp32p4 | :musical_note: Audio
:microphone: Audio Microphone (es8311)
:speaker: Audio Speaker (es8311)
:pager: LCD Display (ek79007, ili9881c, lt8912b)
:floppy_disk: uSD Card
:point_up: Display Touch (gt911)
|

| | [ESP32-S2-Kaluga Kit](bsp/esp32_s2_kaluga_kit) | esp32s2 | :musical_note: Audio
:microphone: Audio Microphone (es8311)
:speaker: Audio Speaker (es8311)
:radio_button: Button
:camera: Camera
:pager: LCD Display (st7789)
:bulb: LED
|

| | [ESP32-S3-EYE](bsp/esp32_s3_eye) | esp32s3 | :musical_note: Audio
:microphone: Audio Microphone
:radio_button: Button
:camera: Camera
:pager: LCD Display (st7789)
:video_game: IMU
:floppy_disk: uSD Card
|

| | [ESP32-S3-KORVO-1](bsp/esp32_s3_korvo_1) | esp32s3 | :musical_note: Audio
:microphone: Audio Microphone (es7210)
:speaker: Audio Speaker (es8311)
:radio_button: Button
:bulb: LED
:floppy_disk: uSD Card
|

| | [ESP32-S3-Korvo-2](bsp/esp32_s3_korvo_2) | esp32s3 | :musical_note: Audio
:microphone: Audio Microphone (es7210)
:speaker: Audio Speaker (es8311)
:radio_button: Button
:camera: Camera
:pager: LCD Display (ili9341)
:bulb: LED
:floppy_disk: uSD Card
:point_up: Display Touch (tt21100)
|

| | [ESP32-S3-LCD-EV-Board](bsp/esp32_s3_lcd_ev_board) | esp32s3 | :musical_note: Audio
:microphone: Audio Microphone (es7210)
:speaker: Audio Speaker (es8311)
:radio_button: Button
:pager: LCD Display
:point_up: Display Touch
|

| | [ESP32-S3-USB-OTG](bsp/esp32_s3_usb_otg) | esp32s3 | :battery: Battery
:radio_button: Button
:pager: LCD Display (st7789)
:bulb: LED
:floppy_disk: uSD Card
|

| | [Generic BSP](bsp/esp_bsp_generic) | - | :radio_button: Button
:pager: LCD Display (st7789, ili9341, gc9a01)
:bulb: LED
:point_up: Display Touch (tt21100, gt1151, gt911, cst816s, ft5x06)
|

| | [ESP-WROVER-KIT](bsp/esp_wrover_kit) | esp32 | :radio_button: Button
:pager: LCD Display (st7789)
:bulb: LED
:floppy_disk: uSD Card
|

| | [M5Dial](bsp/m5dial) | esp32s3 | :radio_button: Button
:pager: LCD Display (gc9a01)
:white_circle: Knob
:point_up: Display Touch (ft5x06)
|

| | [M5Stack Core](bsp/m5stack_core) | esp32 | :speaker: Audio Speaker
:radio_button: Button
:pager: LCD Display (ili9341)
:floppy_disk: uSD Card
|

| | [M5Stack Core2](bsp/m5stack_core_2) | esp32 | :musical_note: Audio
:speaker: Audio Speaker
:pager: LCD Display (ili9341)
:floppy_disk: uSD Card
:point_up: Display Touch (ft5x06)
|

| | [M5Stack CoreS3](bsp/m5stack_core_s3) | esp32s3 | :musical_note: Audio
:microphone: Audio Microphone (es7210)
:speaker: Audio Speaker (aw88298)
:camera: Camera
:pager: LCD Display (ili9341)
:floppy_disk: uSD Card
:point_up: Display Touch (ft5x06)
|

| ### Deprecated Boards | Board name | SoC | Supported Features | Photo | |:----------:|:---:|:-------------------|:-----:| | [ESP-BOX](bsp/esp-box) | esp32s3 | :musical_note: Audio
:microphone: Audio Microphone (es7210)
:speaker: Audio Speaker (es8311)
:radio_button: Button
:pager: LCD Display (st7789)
:video_game: IMU
:point_up: Display Touch (tt21100)
|

| | [ESP-BOX-Lite](bsp/esp-box-lite) | esp32s3 | :musical_note: Audio
:microphone: Audio Microphone (es7243e)
:speaker: Audio Speaker (es8156)
:radio_button: Button
:pager: LCD Display (st7789)
|

| | [ESP32-Azure IoT Kit](bsp/esp32_azure_iot_kit) | esp32 | :radio_button: Button
:pager: LCD Display (ssd1306)
:video_game: IMU
:bulb: LED
:floppy_disk: uSD Card
:black_circle: SENSOR_HUMIDITY
:black_circle: SENSOR_LIGHT
:black_circle: SENSOR_MAG
:black_circle: SENSOR_PRESSURE
:black_circle: SENSOR_TEMPERATURE
|

| ## Examples The best way to start with **ESP-BSP** is by trying one of the available [examples](examples) on your board. Each example includes a `README.md` file listing supported boards and usage instructions. Here is a summary of the available examples: | Example | Description | Supported Boards | Try with ESP Launchpad | | ------- | ----------- | ---------------- | ---------------------- | | [Audio Example](examples/audio) | Play and record WAV file |

4 boards

[esp32_lyrat](bsp/esp32_lyrat)
[esp32_s2_kaluga_kit](bsp/esp32_s2_kaluga_kit)
[esp32_s3_korvo_1](bsp/esp32_s3_korvo_1)
[esp32_s3_korvo_2](bsp/esp32_s3_korvo_2)

| [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=audio) | | [Display Example](examples/display) | Show an image on the screen with a simple startup animation (LVGL) |

16 boards

[esp-box](bsp/esp-box)
[esp-box-3](bsp/esp-box-3)
[esp-box-lite](bsp/esp-box-lite)
[esp32_c3_lcdkit](bsp/esp32_c3_lcdkit)
[esp32_p4_function_ev_board](bsp/esp32_p4_function_ev_board)
[esp32_s2_kaluga_kit](bsp/esp32_s2_kaluga_kit)
[esp32_s3_eye](bsp/esp32_s3_eye)
[esp32_s3_korvo_2](bsp/esp32_s3_korvo_2)
[esp32_s3_lcd_ev_board](bsp/esp32_s3_lcd_ev_board)
[esp32_s3_usb_otg](bsp/esp32_s3_usb_otg)
[esp_wrover_kit](bsp/esp_wrover_kit)
[m5_atom_s3](bsp/m5_atom_s3)
[m5dial](bsp/m5dial)
[m5stack_core](bsp/m5stack_core)
[m5stack_core_2](bsp/m5stack_core_2)
[m5stack_core_s3](bsp/m5stack_core_s3)

| [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display) | | [Display, Audio and Photo Example](examples/display_audio_photo) | Complex demo: browse files from filesystem and play/display JPEG, WAV, or TXT files (LVGL) |

7 boards

[esp-box](bsp/esp-box)
[esp-box-3](bsp/esp-box-3)
[esp-box-lite](bsp/esp-box-lite)
[esp32_s3_korvo_2](bsp/esp32_s3_korvo_2)
[esp32_s3_lcd_ev_board](bsp/esp32_s3_lcd_ev_board)
[m5stack_core_2](bsp/m5stack_core_2)
[m5stack_core_s3](bsp/m5stack_core_s3)

| [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_audio_photo) | | [Camera Example](examples/display_camera) | Stream camera output to display (LVGL) |

4 boards

[esp32_s2_kaluga_kit](bsp/esp32_s2_kaluga_kit)
[esp32_s3_eye](bsp/esp32_s3_eye)
[esp32_s3_korvo_2](bsp/esp32_s3_korvo_2)
[m5stack_core_s3](bsp/m5stack_core_s3)

| [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_camera) | | [LVGL Benchmark Example](examples/display_lvgl_benchmark) | Run LVGL benchmark tests |

10 boards

[esp-box](bsp/esp-box)
[esp-box-3](bsp/esp-box-3)
[esp-box-lite](bsp/esp-box-lite)
[esp32_p4_function_ev_board](bsp/esp32_p4_function_ev_board)
[esp32_s2_kaluga_kit](bsp/esp32_s2_kaluga_kit)
[esp32_s3_eye](bsp/esp32_s3_eye)
[esp32_s3_korvo_2](bsp/esp32_s3_korvo_2)
[esp32_s3_lcd_ev_board](bsp/esp32_s3_lcd_ev_board)
[m5dial](bsp/m5dial)
[m5stack_core_s3](bsp/m5stack_core_s3)

10 boards

| [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_lvgl_demo) | | [Display Rotation Example](examples/display_rotation) | Rotate screen using buttons or an accelerometer (`BSP_CAPS_IMU`, if available) |

9 boards

[esp-box](bsp/esp-box)
[esp-box-3](bsp/esp-box-3)
[esp-box-lite](bsp/esp-box-lite)
[esp32_p4_function_ev_board](bsp/esp32_p4_function_ev_board)
[esp32_s3_korvo_2](bsp/esp32_s3_korvo_2)
[esp32_s3_lcd_ev_board](bsp/esp32_s3_lcd_ev_board)
[m5dial](bsp/m5dial)
[m5stack_core](bsp/m5stack_core)
[m5stack_core_s3](bsp/m5stack_core_s3)

| [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_rotation) | | [Sensors Example](examples/display_sensors) | Display sensor data on a monochrome screen (LVGL) |

1 board

[esp32_azure_iot_kit](bsp/esp32_azure_iot_kit)

| [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_sensors) | | [USB HID Example](examples/display_usb_hid) | USB HID demo (keyboard, mouse, or gamepad visualization using LVGL) |

2 boards

[esp32_p4_function_ev_board](bsp/esp32_p4_function_ev_board)
[esp32_s3_usb_otg](bsp/esp32_s3_usb_otg)

| - | | [Generic Button and LED Example](examples/generic_button_led) | Minimal example using the Generic BSP: button and LED control |

2 boards

[esp_bsp_devkit](bsp/esp_bsp_devkit)
[esp_bsp_generic](bsp/esp_bsp_generic)

1 board

[esp32_azure_iot_kit](bsp/esp32_azure_iot_kit)

| - | ### BSP headers and options * `bsp/name-of-the-bsp.h`: Main include file of the BSP with public API * `bsp/esp-bsp.h`: Convenience include file with the same name for all BPSs * `bsp/display.h` and `bsp/touch.h`: Only for BSPs with LCD or touch controller. Contain low level initialization functions for usage without LVGL graphical library * By default, BSPs with display are shipped with LVGL, if you are interested in BSP without LVGL you can use BSP versions with `noglib` suffix (eg. `esp32_s3_eye_noglib`). > **_NOTE:_** There can be only one BSP in a single esp-idf project. ### In a custom project Packages from this repository are uploaded to the [IDF component registry](https://components.espressif.com/). You can add them to your project via `idf.py add-dependency`, e.g. ``` idf.py add-dependency esp_wrover_kit==1.0.0 ``` ### Recommendation for custom projects When you want to use a BSP in a real project, it is highly recommended to disable configuration option `CONFIG_BSP_ERROR_CHECK` in menuconfig. You should check all returned error codes from all BSP functions you call. Otherwise, if the option `CONFIG_BSP_ERROR_CHECK` is enabled, any error encountered in a BSP will abort the program. ### Compiling project for multiple BSPs > :warning: **Experimental feature**: This feature is under development! A single project can be run on multiple different development boards, if the boards contain the features required by the project (such as audio, display, camera...). For this purpose, `idf.py` is extended by [examples/bsp_ext.py](examples/bsp_ext.py) which allows you to build an example for your specific BSP. Example command for [display](examples/display) e.g.: ``` idf.py -D SDKCONFIG_DEFAULTS=sdkconfig.bsp.esp_wrover_kit build ``` In case you want to build locally for multiple boards at the same time, it is useful to have separate build directories for each BSP configuration. In order to achieve this, you can extend the above command like this: ``` idf.py -B build/wrover_kit -D SDKCONFIG_DEFAULTS=sdkconfig.bsp.esp_wrover_kit build ``` > Note: This feature is not yet integrated to idf.py by default. If you want to use it, you must set your environmental variable `IDF_EXTRA_ACTIONS_PATH` to path to `esp-bsp/examples/bsp_ext.py`. ## Copyrights and License All original source code in this repository is Copyright (c) Espressif Systems (Shanghai) Co. Ltd., and is licensed under the Apache 2.0 license.