espressif/esp32_s2_kaluga_kit

# BSP: ESP32-S2-Kaluga-Kit | [HW Reference](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.html) | [HOW TO USE API](#api-reference) | [EXAMPLES](#compatible-bsp-examples) |[![Component Registry](https://components.espressif.com/components/espressif/esp32_s2_kaluga_kit/badge.svg)](https://components.espressif.com/components/espressif/esp32_s2_kaluga_kit) | ![maintenance-status](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg) | | --- | --- | --- | --- | -- | ## Overview <table> <tr><td> The ESP32-S2-Kaluga-1 kit v1.3 is a development kit by Espressif that is mainly created to demonstrate the ESP32-S2’s human-computer interaction functionalities and provide the users with the tools for development of human-computer interaction applications based on the ESP32-S2. **This Board support package consists of:** * Smart RGB LED * LVGL graphics library * ES8311 mono audio codec * Touch pad configuration * Buttons configuration * Camera driver </td><td width="200"> <img src="doc/esp32_s2_kaluga_kit.webp"> </td></tr> </table> ![](doc/esp32-s2-kaluga-1-v1.3-layout-front.png) ## Capabilities and dependencies <div align="center">  | Available | Capability |Controller/Codec| Component |Version| |------------------|------------------------|----------------|----------------------------------------------------------------------------------------------|-------| |:heavy_check_mark:| :pager: DISPLAY | st7789 | idf | >=5.4 | |:heavy_check_mark:|:black_circle: LVGL_PORT| |[espressif/esp_lvgl_port](https://components.espressif.com/components/espressif/esp_lvgl_port)| ^2 | | :x: | :point_up: TOUCH | | | | |:heavy_check_mark:| :radio_button: BUTTONS | | [espressif/button](https://components.espressif.com/components/espressif/button) | ^4 | |:heavy_check_mark:| :musical_note: AUDIO | |[espressif/esp_codec_dev](https://components.espressif.com/components/espressif/esp_codec_dev)| ~1.3.1| |:heavy_check_mark:| :speaker: AUDIO_SPEAKER| es8311 | | | |:heavy_check_mark:| :microphone: AUDIO_MIC | es8311 | | | |:heavy_check_mark:| :bulb: LED | | idf | >=5.4 | | :x: | :floppy_disk: SDCARD | | | | | :x: | :video_game: IMU | | | | |:heavy_check_mark:| :camera: CAMERA | | [espressif/esp32-camera](https://components.espressif.com/components/espressif/esp32-camera) |^2.0.14|  </div> ## Compatible BSP Examples <div align="center">  | Example | Description | Try with ESP Launchpad | | ------- | ----------- | ---------------------- | | [Audio Example](https://github.com/espressif/esp-bsp/tree/master/examples/audio) | Play and record WAV file | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=audio) | | [Display Example](https://github.com/espressif/esp-bsp/tree/master/examples/display) | Show an image on the screen with a simple startup animation (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display) | | [Camera Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_camera) | Stream camera output to display (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_camera) | | [LVGL Benchmark Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_lvgl_benchmark) | Run LVGL benchmark tests | - | | [LVGL Demos Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_lvgl_demos) | Run the LVGL demo player - all LVGL examples are included (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_lvgl_demo) |  </div>

# API Reference <div align="center"> | :1234: [CAPABILITIES](#1234-capabilities) | :floppy_disk: [SD CARD AND SPIFFS](#floppy_disk-sd-card-and-spiffs) | :musical_note: [AUDIO](#musical_note-audio) | :pager: [DISPLAY AND TOUCH](#pager-display-and-touch) | :radio_button: [BUTTONS](#radio_button-buttons) | :bulb: [LEDS](#bulb-leds) | :camera: [CAMERA](#camera-camera) | | :-------------------------: | :-------------------------: | :-------------------------: | :-------------------------: | :-------------------------: | :-------------------------: | :-------------------------: | </div> ## Overview This document provides an overview of the ESP-BSP (Board Support Package) API as implemented by this board. While the ESP-BSP framework defines a unified API shared across multiple boards, this documentation focuses only on the APIs supported by the current board. Any APIs not applicable to this board's hardware are excluded or may not be functional. The goal of this document is to make it easier for developers to understand the available APIs and how to use them consistently across different boards. ## General ### Pinout Each BSP defines a set of macros for default pin assignments used by its hardware peripherals. These macros allow users to configure or reference standard interfaces like I2C, SPI, LCD, audio, or SD cards easily. - I2C: `BSP_I2C_*` - Display: `BSP_LCD_*` - Audio I2S: `BSP_I2S_*` - USB: `BSP_USB_*` - SD Card (MMC): `BSP_SD_*` - SD Card (SPI): `BSP_SD_SPI_*` > [!NOTE] > Not all boards support all interfaces. You should always check if the related capability macro (e.g., BSP_CAPS_SDCARD) is defined. ### I2C Some devices included in BSPs (e.g., sensors, displays, audio codecs) communicate via the I2C interface. In many cases, I2C is initialized automatically as part of the device setup. However, you can manually initialize or deinitialize the I2C peripheral using the following API: ``` /* Initialize the default I2C bus used by the BSP */ bsp_i2c_init(); ... /* Deinitialize the I2C bus */ bsp_i2c_deinit(); ``` If you need direct access to the initialized I2C bus (e.g., to communicate with an external peripheral not handled by the BSP), you can retrieve the I2C bus handle: ``` i2c_master_bus_handle_t i2c = bsp_i2c_get_handle(); ``` > [!NOTE] > The BSP ensures that I2C initialization is performed only once, even if called multiple times. This helps avoid conflicts when multiple components rely on the same I2C bus. ### ADC Some devices included in BSPs (such as buttons, battery monitoring, etc.) use the ADC peripheral. In most cases, the ADC is automatically initialized as part of the specific device setup. However, you can manually initialize the ADC using the following API: ``` /* Initialize the ADC peripheral */ bsp_adc_initialize(); ``` If you need direct access to the ADC instance (e.g., for custom measurements), you can retrieve the handle: ``` adc_oneshot_unit_handle_t adc = bsp_adc_get_handle(); ``` > [!NOTE] > The BSP ensures the ADC is initialized only once, even if `bsp_adc_initialize()` is called multiple times. ### Features Some boards support enabling or disabling specific hardware features (such as LCD, SD card, camera, etc.) to reduce power consumption or manage shared resources. The BSP provides a unified API to control these features: ``` /* Enable the LCD feature */ bsp_feature_enable(BSP_FEATURE_LCD, true); /* Disable the speaker to reduce power usage */ bsp_feature_enable(BSP_FEATURE_SPEAKER, false); ``` Supported feature flags (may vary depending on the board): - `BSP_FEATURE_LCD` - Display module - `BSP_FEATURE_TOUCH` - Touch controller - `BSP_FEATURE_SD` - SD card interface - `BSP_FEATURE_SPEAKER`- Audio speaker - `BSP_FEATURE_BATTERY` - Battery monitoring - `BSP_FEATURE_VIBRATION` - Vibration motor > [!NOTE] > Not all BSPs support feature toggling, and some features may not be available or controllable via this API. Always check the BSP header or documentation for supported features. > [!TIP] > Disabling unused features can help reduce power consumption, especially in battery-powered applications. ## Identification Each BSP defines an identifier macro in the form of `BSP_BOARD_*`. ### Board Name API Reference ## Macros | Type | Name | | ---: | :--- | | define | [**BSP\_BOARD\_ESP32\_S2\_KALUGA\_KIT**](#define-bsp_board_esp32_s2_kaluga_kit) | ## :1234: Capabilities Each BSP defines a set of capability macros that indicate which features are supported. The list may look like this. You can use these macros to conditionally compile code depending on feature availability. ### Capabilities API Reference ## Macros | Type | Name | | ---: | :--- | | define | [**BSP\_CAPS\_AUDIO**](#define-bsp_caps_audio) 1 | | define | [**BSP\_CAPS\_AUDIO\_MIC**](#define-bsp_caps_audio_mic) 1 | | define | [**BSP\_CAPS\_AUDIO\_SPEAKER**](#define-bsp_caps_audio_speaker) 1 | | define | [**BSP\_CAPS\_BUTTONS**](#define-bsp_caps_buttons) 1 | | define | [**BSP\_CAPS\_CAMERA**](#define-bsp_caps_camera) 1 | | define | [**BSP\_CAPS\_DISPLAY**](#define-bsp_caps_display) 1 | | define | [**BSP\_CAPS\_IMU**](#define-bsp_caps_imu) 0 | | define | [**BSP\_CAPS\_LED**](#define-bsp_caps_led) 1 | | define | [**BSP\_CAPS\_SDCARD**](#define-bsp_caps_sdcard) 0 | | define | [**BSP\_CAPS\_TOUCH**](#define-bsp_caps_touch) 0 | ### ADC API Reference ## Functions | Type | Name | | ---: | :--- | | adc\_oneshot\_unit\_handle\_t | [**bsp\_adc\_get\_handle**](#function-bsp_adc_get_handle) (void) _Get ADC handle._ | | esp\_err\_t | [**bsp\_adc\_initialize**](#function-bsp_adc_initialize) (void) _Initialize ADC._ | ## Macros | Type | Name | | ---: | :--- | | define | [**BSP\_ADC\_UNIT**](#define-bsp_adc_unit) ADC\_UNIT\_1 | ## Functions Documentation ### function `bsp_adc_get_handle` _Get ADC handle._ ```c adc_oneshot_unit_handle_t bsp_adc_get_handle ( void ) ``` **Note:** This function is available only in IDF5 and higher **Returns:** ADC handle ### function `bsp_adc_initialize` _Initialize ADC._ ```c esp_err_t bsp_adc_initialize ( void ) ``` The ADC can be initialized inside BSP, when needed. ### I2C API Reference ## Functions | Type | Name | | ---: | :--- | | esp\_err\_t | [**bsp\_i2c\_deinit**](#function-bsp_i2c_deinit) (void) _Deinit I2C driver and free its resources._ | | i2c\_master\_bus\_handle\_t | [**bsp\_i2c\_get\_handle**](#function-bsp_i2c_get_handle) (void) _Get I2C driver handle._ | | esp\_err\_t | [**bsp\_i2c\_init**](#function-bsp_i2c_init) (void) _Init I2C driver._ | ## Macros | Type | Name | | ---: | :--- | | define | [**BSP\_I2C\_NUM**](#define-bsp_i2c_num) CONFIG\_BSP\_I2C\_NUM | | define | [**BSP\_I2C\_SCL**](#define-bsp_i2c_scl) (GPIO\_NUM\_7) | | define | [**BSP\_I2C\_SDA**](#define-bsp_i2c_sda) (GPIO\_NUM\_8) | ## Functions Documentation ### function `bsp_i2c_deinit` _Deinit I2C driver and free its resources._ ```c esp_err_t bsp_i2c_deinit ( void ) ``` **Returns:** * ESP\_OK On success * ESP\_ERR\_INVALID\_ARG I2C parameter error ### function `bsp_i2c_get_handle` _Get I2C driver handle._ ```c i2c_master_bus_handle_t bsp_i2c_get_handle ( void ) ``` **Returns:** * I2C handle ### function `bsp_i2c_init` _Init I2C driver._ ```c esp_err_t bsp_i2c_init ( void ) ``` **Returns:** * ESP\_OK On success * ESP\_ERR\_INVALID\_ARG I2C parameter error * ESP\_FAIL I2C driver installation error ## :floppy_disk: SD Card and SPIFFS ### SPIFFS Initialization / Deinitialization Each BSP provides a simple API for mounting and unmounting the SPI Flash File System (SPIFFS). ``` /* Mount SPIFFS to the virtual file system */ bsp_spiffs_mount(); /* ... perform file operations ... */ /* Unmount SPIFFS from the virtual file system */ bsp_spiffs_unmount(); ``` ### SD Card Initialization / Deinitialization The BSP offers a flexible API for working with SD cards. In addition to the default mount and unmount functions, you can also use a configuration structure or access preconfigured `host` and `slot` structures. Mount with Default Configuration ``` /* Mount microSD card to the virtual file system */ bsp_sdcard_mount(); /* ... perform file operations ... */ /* Unmount microSD card */ bsp_sdcard_unmount(); ``` Mount with Custom Configuration Some BSPs allow selecting between SDMMC and SPI interfaces for the SD card. Use the appropriate API function based on your hardware: ``` bsp_sdcard_cfg_t cfg = {0}; /* Mount SD card using SDMMC interface */ bsp_sdcard_sdmmc_mount(&cfg); ``` or ``` bsp_sdcard_cfg_t cfg = {0}; /* Mount SD card using SPI interface */ bsp_sdcard_sdspi_mount(&cfg) ``` > [!NOTE] > Not all BSPs support both SDMMC and SPI modes. Check the board documentation to see which interfaces are available. > If an unsupported interface is used, the API will return `ESP_ERR_NOT_SUPPORTED` error. ### After Mounting Once the SD card or SPIFFS is mounted, you can use standard file I/O functions (`fopen`, `fread`, `fwrite`, `fclose`, etc.) provided by ESP-IDF's VFS (Virtual File System). To print basic SD card information (after mounting), you can use: ``` sdmmc_card_t *sdcard = bsp_sdcard_get_handle(); sdmmc_card_print_info(stdout, sdcard); ``` > [!TIP] > The bsp_sdcard_get_handle() function returns a pointer to the sdmmc_card_t structure, which contains detailed information about the connected SD card. ### SD Card and SPIFFS API Reference ## Functions | Type | Name | | ---: | :--- | | esp\_err\_t | [**bsp\_spiffs\_mount**](#function-bsp_spiffs_mount) (void) _Mount SPIFFS to virtual file system._ | | esp\_err\_t | [**bsp\_spiffs\_unmount**](#function-bsp_spiffs_unmount) (void) _Unmount SPIFFS from virtual file system._ | ## Macros | Type | Name | | ---: | :--- | | define | [**BSP\_SPIFFS\_MOUNT\_POINT**](#define-bsp_spiffs_mount_point) CONFIG\_BSP\_SPIFFS\_MOUNT\_POINT | ## Functions Documentation ### function `bsp_spiffs_mount` _Mount SPIFFS to virtual file system._ ```c esp_err_t bsp_spiffs_mount ( void ) ``` **Returns:** * ESP\_OK on success * ESP\_ERR\_INVALID\_STATE if esp\_vfs\_spiffs\_register was already called * ESP\_ERR\_NO\_MEM if memory can not be allocated * ESP\_FAIL if partition can not be mounted * other error codes ### function `bsp_spiffs_unmount` _Unmount SPIFFS from virtual file system._ ```c esp_err_t bsp_spiffs_unmount ( void ) ``` **Returns:** * ESP\_OK on success * ESP\_ERR\_NOT\_FOUND if the partition table does not contain SPIFFS partition with given label * ESP\_ERR\_INVALID\_STATE if esp\_vfs\_spiffs\_unregister was already called * ESP\_ERR\_NO\_MEM if memory can not be allocated * ESP\_FAIL if partition can not be mounted * other error codes ## :musical_note: Audio ### Initialization Before using speaker or microphone features, the audio codec must be initialized. ``` /* Initialize the speaker codec */ esp_codec_dev_handle_t spk_codec_dev = bsp_audio_codec_speaker_init(); /* Initialize the microphone codec */ esp_codec_dev_handle_t mic_codec_dev = bsp_audio_codec_microphone_init(); ``` After initialization, the [esp_codec_dev](https://components.espressif.com/components/espressif/esp_codec_dev) API can be used to control playback and recording. > [!NOTE] > Some BSPs may only support playback (speaker) or only input (microphone). Use the capability macros (`BSP_CAPS_AUDIO`, `BSP_CAPS_AUDIO_SPEAKER`, `BSP_CAPS_AUDIO_MIC`) to check supported features. ### Example of audio usage #### Speaker Below is an example of audio playback using the speaker (source data not included): ``` /* Set volume to 50% */ esp_codec_dev_set_out_vol(spk_codec_dev, 50); /* Define audio format */ esp_codec_dev_sample_info_t fs = { .sample_rate = wav_header.sample_rate, .channel = wav_header.num_channels, .bits_per_sample = wav_header.bits_per_sample, }; /* Open speaker stream */ esp_codec_dev_open(spk_codec_dev, &fs); ... /* Play audio data */ esp_codec_dev_write(spk_codec_dev, wav_bytes, wav_bytes_len); ... /* Close stream when done */ esp_codec_dev_close(spk_codec_dev); ``` > [!TIP] > Audio data must be in raw PCM format. Use a decoder if playing compressed formats (e.g., WAV, MP3). #### Microphone Below is an example of recording audio using the microphone (destination buffer not included): ``` /* Set input gain (optional) */ esp_codec_dev_set_in_gain(mic_codec_dev, 42.0); /* Define audio format */ esp_codec_dev_sample_info_t fs = { .sample_rate = 16000, .channel = 1, .bits_per_sample = 16, }; /* Open microphone stream */ esp_codec_dev_open(mic_codec_dev, &fs); /* Read recorded data */ esp_codec_dev_read(mic_codec_dev, recording_buffer, BUFFER_SIZE) ... /* Close stream when done */ esp_codec_dev_close(mic_codec_dev); ``` ### Audio API Reference ## Functions | Type | Name | | ---: | :--- | | esp\_codec\_dev\_handle\_t | [**bsp\_audio\_codec\_microphone\_init**](#function-bsp_audio_codec_microphone_init) (void) _Initialize microphone codec device._ | | esp\_codec\_dev\_handle\_t | [**bsp\_audio\_codec\_speaker\_init**](#function-bsp_audio_codec_speaker_init) (void) _Initialize speaker codec device._ | | const audio\_codec\_data\_if\_t \* | [**bsp\_audio\_get\_codec\_itf**](#function-bsp_audio_get_codec_itf) (void) _Get codec I2S interface (initialized in bsp\_audio\_init)_ | | esp\_err\_t | [**bsp\_audio\_init**](#function-bsp_audio_init) (const i2s\_std\_config\_t \*i2s\_config) _Init audio._ | ## Macros | Type | Name | | ---: | :--- | | define | [**BSP\_I2S\_DOUT**](#define-bsp_i2s_dout) (GPIO\_NUM\_12) | | define | [**BSP\_I2S\_DSIN**](#define-bsp_i2s_dsin) (GPIO\_NUM\_34) | | define | [**BSP\_I2S\_LCLK**](#define-bsp_i2s_lclk) (GPIO\_NUM\_17) | | define | [**BSP\_I2S\_MCLK**](#define-bsp_i2s_mclk) (GPIO\_NUM\_35) | | define | [**BSP\_I2S\_SCLK**](#define-bsp_i2s_sclk) (GPIO\_NUM\_18) | | define | [**BSP\_POWER\_AMP\_IO**](#define-bsp_power_amp_io) (GPIO\_NUM\_10) | ## Functions Documentation ### function `bsp_audio_codec_microphone_init` _Initialize microphone codec device._ ```c esp_codec_dev_handle_t bsp_audio_codec_microphone_init ( void ) ``` **Returns:** Pointer to codec device handle or NULL when error occurred ### function `bsp_audio_codec_speaker_init` _Initialize speaker codec device._ ```c esp_codec_dev_handle_t bsp_audio_codec_speaker_init ( void ) ``` **Returns:** Pointer to codec device handle or NULL when error occurred ### function `bsp_audio_get_codec_itf` _Get codec I2S interface (initialized in bsp\_audio\_init)_ ```c const audio_codec_data_if_t * bsp_audio_get_codec_itf ( void ) ``` **Returns:** * Pointer to codec I2S interface handle or NULL when error occurred ### function `bsp_audio_init` _Init audio._ ```c esp_err_t bsp_audio_init ( const i2s_std_config_t *i2s_config ) ``` **Note:** There is no deinit audio function. Users can free audio resources by calling i2s\_del\_channel() **Warning:** The type of i2s\_config param is depending on IDF version. **Parameters:** * `i2s_config` I2S configuration. Pass NULL to use default values (Mono, duplex, 16bit, 22050 Hz) **Returns:** * ESP\_OK On success * ESP\_ERR\_NOT\_SUPPORTED The communication mode is not supported on the current chip * ESP\_ERR\_INVALID\_ARG NULL pointer or invalid configuration * ESP\_ERR\_NOT\_FOUND No available I2S channel found * ESP\_ERR\_NO\_MEM No memory for storing the channel information * ESP\_ERR\_INVALID\_STATE This channel has not initialized or already started ## :pager: Display and Touch ### Initialization ESP-BSP provides two ways to initialize the **display**, **touch** and **LVGL**. Simple method: ``` /* Initialize display, touch, and LVGL */ lv_display_t display = bsp_display_start(); ``` Configurable method: ``` bsp_display_cfg_t cfg = { .lvgl_port_cfg = ESP_LVGL_PORT_INIT_CONFIG(), /* See LVGL Port for more info */ .buffer_size = BSP_LCD_V_RES * BSP_LCD_H_RES, /* Screen buffer size in pixels */ .double_buffer = true, /* Allocate two buffers if true */ .flags = { .buff_dma = true, /* Use DMA-capable LVGL buffer */ .buff_spiram = false, /* Allocate buffer in PSRAM if true */ } }; cfg.lvgl_port_cfg.task_stack = 10000; /* Example: change LVGL task stack size */ /* Initialize display, touch, and LVGL */ lv_display_t display = bsp_display_start_with_config(&cfg); ``` After initialization, you can use the [LVGL](https://docs.lvgl.io/master/) API or [LVGL Port](../components/esp_lvgl_port/README.md) API. ### Initialization without LVGL - NoGLIB BSP To initialize the LCD without LVGL, use: ``` esp_lcd_panel_handle_t panel_handle; esp_lcd_panel_io_handle_t io_handle; const bsp_display_config_t bsp_disp_cfg = { .max_transfer_sz = (BSP_LCD_H_RES * 100) * sizeof(uint16_t), }; BSP_ERROR_CHECK_RETURN_NULL(bsp_display_new(&bsp_disp_cfg, &panel_handle, &io_handle)); ``` To initialize the LCD touch without LVGL, use: ``` esp_lcd_touch_handle_t tp; bsp_touch_new(NULL, &tp); ``` After initialization, you can use the [ESP-LCD](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/lcd/index.html) API and [ESP-LCD Touch](../components/lcd_touch/README.md) API. ### Set Brightness ``` /* Set display brightness to 100% */ bsp_display_backlight_on(); /* Set display brightness to 0% */ bsp_display_backlight_off(); /* Set display brightness to 50% */ bsp_display_brightness_set(50); ``` > [!NOTE] > Some boards do not support changing brightness. They return an `ESP_ERR_NOT_SUPPORTED` error. ### LVGL API Usage (only when initialized with LVGL) All LVGL calls must be protected using lock/unlock: ``` /* Wait until other tasks finish screen operations */ bsp_display_lock(0); ... lv_obj_t * screen = lv_disp_get_scr_act(disp_handle); lv_obj_t * obj = lv_label_create(screen); ... /* Unlock after screen operations are done */ bsp_display_unlock(); ``` ### Screen rotation (only when initialized with LVGL) ``` bsp_display_lock(0); /* Rotate display to 90 */ bsp_display_rotate(display, LV_DISPLAY_ROTATION_90); bsp_display_unlock(); ``` > [!NOTE] > Some LCDs do not support hardware rotation and instead use software rotation, which consumes more memory. ### Available constants Constants like screen resolution, pin configuration, and other options are defined in the BSP header files (`{bsp_name}.h`, `display.h`, `touch.h`). Below are some of the most relevant predefined constants: - `BSP_LCD_H_RES` - Horizontal resolution in pixels - `BSP_LCD_V_RES` - Vertical resolution in pixels - `BSP_LCD_SPI_NUM` - SPI bus used by the LCD (if applicable) ### Display and Touch API Reference ## Structures and Types | Type | Name | | ---: | :--- | | struct | [**bsp\_display\_cfg\_t**](#struct-bsp_display_cfg_t) _BSP display configuration structure._ | | struct | [**bsp\_display\_config\_t**](#struct-bsp_display_config_t) _BSP display configuration structure._ | ## Functions | Type | Name | | ---: | :--- | | esp\_err\_t | [**bsp\_display\_backlight\_off**](#function-bsp_display_backlight_off) (void) | | esp\_err\_t | [**bsp\_display\_backlight\_on**](#function-bsp_display_backlight_on) (void) | | esp\_err\_t | [**bsp\_display\_brightness\_init**](#function-bsp_display_brightness_init) (void) | | esp\_err\_t | [**bsp\_display\_brightness\_set**](#function-bsp_display_brightness_set) (int brightness\_percent) | | lv\_indev\_t \* | [**bsp\_display\_get\_input\_dev**](#function-bsp_display_get_input_dev) (void) _Get pointer to input device (touch, buttons, ...)_ | | bool | [**bsp\_display\_lock**](#function-bsp_display_lock) (uint32\_t timeout\_ms) _Take LVGL mutex._ | | esp\_err\_t | [**bsp\_display\_new**](#function-bsp_display_new) (const [**bsp\_display\_config\_t**](#struct-bsp_display_config_t) \*config, esp\_lcd\_panel\_handle\_t \*ret\_panel, esp\_lcd\_panel\_io\_handle\_t \*ret\_io) _Create new display panel._ | | void | [**bsp\_display\_rotate**](#function-bsp_display_rotate) (lv\_display\_t \*disp, lv\_disp\_rotation\_t rotation) _Rotate screen._ | | lv\_display\_t \* | [**bsp\_display\_start**](#function-bsp_display_start) (void) _Initialize display and graphics library._ | | lv\_display\_t \* | [**bsp\_display\_start\_with\_config**](#function-bsp_display_start_with_config) (const [**bsp\_display\_cfg\_t**](#struct-bsp_display_cfg_t) \*cfg) _Initialize display._ | | void | [**bsp\_display\_unlock**](#function-bsp_display_unlock) (void) _Give LVGL mutex._ | ## Macros | Type | Name | | ---: | :--- | | define | [**BSP\_LCD\_BIGENDIAN**](#define-bsp_lcd_bigendian) (1) | | define | [**BSP\_LCD\_BITS\_PER\_PIXEL**](#define-bsp_lcd_bits_per_pixel) (16) | | define | [**BSP\_LCD\_COLOR\_FORMAT**](#define-bsp_lcd_color_format) (ESP\_LCD\_COLOR\_FORMAT\_RGB565) | | define | [**BSP\_LCD\_COLOR\_SPACE**](#define-bsp_lcd_color_space) (ESP\_LCD\_COLOR\_SPACE\_RGB) | | define | [**BSP\_LCD\_DC**](#define-bsp_lcd_dc) (GPIO\_NUM\_13) | | define | [**BSP\_LCD\_DRAW\_BUFF\_DOUBLE**](#define-bsp_lcd_draw_buff_double) (0) | | define | [**BSP\_LCD\_DRAW\_BUFF\_SIZE**](#define-bsp_lcd_draw_buff_size) (BSP\_LCD\_H\_RES \* 20) | | define | [**BSP\_LCD\_H\_RES**](#define-bsp_lcd_h_res) (320) | | define | [**BSP\_LCD\_PIXEL\_CLOCK\_HZ**](#define-bsp_lcd_pixel_clock_hz) (40 \* 1000 \* 1000) | | define | [**BSP\_LCD\_RST**](#define-bsp_lcd_rst) (GPIO\_NUM\_16) | | define | [**BSP\_LCD\_SPI\_CLK**](#define-bsp_lcd_spi_clk) (GPIO\_NUM\_15) | | define | [**BSP\_LCD\_SPI\_CS**](#define-bsp_lcd_spi_cs) (GPIO\_NUM\_11) | | define | [**BSP\_LCD\_SPI\_MOSI**](#define-bsp_lcd_spi_mosi) (GPIO\_NUM\_9) | | define | [**BSP\_LCD\_SPI\_NUM**](#define-bsp_lcd_spi_num) (SPI3\_HOST) | | define | [**BSP\_LCD\_V\_RES**](#define-bsp_lcd_v_res) (240) | | define | [**ESP\_LCD\_COLOR\_FORMAT\_RGB565**](#define-esp_lcd_color_format_rgb565) (1) | | define | [**ESP\_LCD\_COLOR\_FORMAT\_RGB888**](#define-esp_lcd_color_format_rgb888) (2) | ## Structures and Types Documentation ### struct `bsp_display_cfg_t` _BSP display configuration structure._ Variables: - unsigned int buff_dma Allocated LVGL buffer will be DMA capable - unsigned int buff_spiram Allocated LVGL buffer will be in PSRAM - uint32\_t buffer_size Size of the buffer for the screen in pixels - bool double_buffer True, if should be allocated two buffers - struct [**bsp\_display\_cfg\_t**](#struct-bsp_display_cfg_t) flags - lvgl\_port\_cfg\_t lvgl_port_cfg LVGL port configuration ### struct `bsp_display_config_t` _BSP display configuration structure._ Variables: - int max_transfer_sz Maximum transfer size, in bytes. ## Functions Documentation ### function `bsp_display_backlight_off` ```c esp_err_t bsp_display_backlight_off ( void ) ``` ### function `bsp_display_backlight_on` ```c esp_err_t bsp_display_backlight_on ( void ) ``` ### function `bsp_display_brightness_init` ```c esp_err_t bsp_display_brightness_init ( void ) ``` ### function `bsp_display_brightness_set` ```c esp_err_t bsp_display_brightness_set ( int brightness_percent ) ``` ### function `bsp_display_get_input_dev` _Get pointer to input device (touch, buttons, ...)_ ```c lv_indev_t * bsp_display_get_input_dev ( void ) ``` **Note:** The LVGL input device is initialized in [**bsp\_display\_start()**](#function-bsp_display_start) function. **Returns:** Pointer to LVGL input device or NULL when not initialized ### function `bsp_display_lock` _Take LVGL mutex._ ```c bool bsp_display_lock ( uint32_t timeout_ms ) ``` **Parameters:** * `timeout_ms` Timeout in [ms]. 0 will block indefinitely. **Returns:** true Mutex was taken **Returns:** false Mutex was NOT taken ### function `bsp_display_new` _Create new display panel._ ```c esp_err_t bsp_display_new ( const bsp_display_config_t *config, esp_lcd_panel_handle_t *ret_panel, esp_lcd_panel_io_handle_t *ret_io ) ``` For maximum flexibility, this function performs only reset and initialization of the display. You must turn on the display explicitly by calling esp\_lcd\_panel\_disp\_on\_off(). The display's backlight is not turned on either. You can use bsp\_display\_backlight\_on/off(), bsp\_display\_brightness\_set() (on supported boards) or implement your own backlight control. If you want to free resources allocated by this function, you can use esp\_lcd API, ie.: ````cpp esp_lcd_panel_del(panel); esp_lcd_panel_io_del(io); spi_bus_free(spi_num_from_configuration); ```` **Parameters:** * `config` display configuration * `ret_panel` esp\_lcd panel handle * `ret_io` esp\_lcd IO handle **Returns:** * ESP\_OK On success * Else esp\_lcd failure ### function `bsp_display_rotate` _Rotate screen._ ```c void bsp_display_rotate ( lv_display_t *disp, lv_disp_rotation_t rotation ) ``` Display must be already initialized by calling [**bsp\_display\_start()**](#function-bsp_display_start) **Parameters:** * `disp` Pointer to LVGL display * `rotation` Angle of the display rotation ### function `bsp_display_start` _Initialize display and graphics library._ ```c lv_display_t * bsp_display_start ( void ) ``` This function initializes SPI, display controller and starts LVGL handling task. **Returns:** Pointer to LVGL display or NULL when error occurred ### function `bsp_display_start_with_config` _Initialize display._ ```c lv_display_t * bsp_display_start_with_config ( const bsp_display_cfg_t *cfg ) ``` This function initializes SPI, display controller and starts LVGL handling task. **Parameters:** * `cfg` Display configuration **Returns:** Pointer to LVGL display or NULL when error occurred ### function `bsp_display_unlock` _Give LVGL mutex._ ```c void bsp_display_unlock ( void ) ``` ## :radio_button: Buttons Most boards include one or more user buttons. The BSP provides a simple API to initialize and use them. Internally, it utilizes the [button](https://components.espressif.com/components/espressif/button/) component for event handling and debouncing. ``` /* Initialize all available buttons */ button_handle_t btns[BSP_BUTTON_NUM] = {NULL}; bsp_iot_button_create(btns, NULL, BSP_BUTTON_NUM); /* Register a callback for button press */ for (int i = 0; i < BSP_BUTTON_NUM; i++) { iot_button_register_cb(btns[i], BUTTON_PRESS_DOWN, NULL, btn_handler, (void *) i); } /* Called on button press */ static void btn_handler(void *button_handle, void *usr_data) { int button_index = (int)usr_data; ESP_LOGI(TAG, "Button %d pressed", button_index); } ``` **Notes:** - `BSP_BUTTON_NUM` defines the number of available buttons on the board - Instead of relying on a numeric index, you can use the `bsp_button_t` structure defined in the BSP header to reference buttons by name (e.g., BSP_BUTTON_MUTE, BSP_BUTTON_MAIN, BSP_BUTTON_BOOT, etc.) - The callback can be registered for different button events, such as `BUTTON_PRESS_DOWN`, `BUTTON_PRESS_UP`, or `BUTTON_LONG_PRESS_START`, `BUTTON_DOUBLE_CLICK`, ... - Button features (e.g. long-press support, active level) are configured automatically by the BSP. ### Buttons API Reference ## Structures and Types | Type | Name | | ---: | :--- | | enum | [**bsp\_button\_t**](#enum-bsp_button_t) | | enum | [**bsp\_touchpad\_button\_t**](#enum-bsp_touchpad_button_t) | ## Functions | Type | Name | | ---: | :--- | | esp\_err\_t | [**bsp\_iot\_button\_create**](#function-bsp_iot_button_create) (button\_handle\_t btn\_array, int \*btn\_cnt, int btn\_array\_size) _Initialize all buttons._ | | esp\_err\_t | [**bsp\_touchpad\_calibrate**](#function-bsp_touchpad_calibrate) (bsp\_touchpad\_button\_t tch\_pad, float tch\_threshold) _Calibrate touch threshold._ | | esp\_err\_t | [**bsp\_touchpad\_deinit**](#function-bsp_touchpad_deinit) (void) _Deinit buttons on Touchpad board._ | | esp\_err\_t | [**bsp\_touchpad\_init**](#function-bsp_touchpad_init) (intr\_handler\_t fn) _Init buttons on Touchpad board._ | ## Macros | Type | Name | | ---: | :--- | | define | [**BSP\_BUTTONS\_IO**](#define-bsp_buttons_io) (GPIO\_NUM\_6) | | define | [**BSP\_TOUCH\_BUTTON\_GUARD**](#define-bsp_touch_button_guard) (GPIO\_NUM\_4) | | define | [**BSP\_TOUCH\_BUTTON\_NETWORK**](#define-bsp_touch_button_network) (GPIO\_NUM\_11) | | define | [**BSP\_TOUCH\_BUTTON\_PHOTO**](#define-bsp_touch_button_photo) (GPIO\_NUM\_6) | | define | [**BSP\_TOUCH\_BUTTON\_PLAY**](#define-bsp_touch_button_play) (GPIO\_NUM\_2) | | define | [**BSP\_TOUCH\_BUTTON\_RECORD**](#define-bsp_touch_button_record) (GPIO\_NUM\_5) | | define | [**BSP\_TOUCH\_BUTTON\_VOLDOWN**](#define-bsp_touch_button_voldown) (GPIO\_NUM\_3) | | define | [**BSP\_TOUCH\_BUTTON\_VOLUP**](#define-bsp_touch_button_volup) (GPIO\_NUM\_1) | | define | [**BSP\_TOUCH\_SHELED\_ELECT**](#define-bsp_touch_sheled_elect) (GPIO\_NUM\_14) | ## Structures and Types Documentation ### enum `bsp_button_t` ```c enum bsp_button_t { BSP_BUTTON_REC = 0, BSP_BUTTON_MODE, BSP_BUTTON_PLAY, BSP_BUTTON_SET, BSP_BUTTON_VOLDOWN, BSP_BUTTON_VOLUP, BSP_BUTTON_NUM }; ``` ### enum `bsp_touchpad_button_t` ```c enum bsp_touchpad_button_t { TOUCH_BUTTON_PLAY = TOUCH_PAD_NUM2, TOUCH_BUTTON_PHOTO = TOUCH_PAD_NUM6, TOUCH_BUTTON_NETWORK = TOUCH_PAD_NUM11, TOUCH_BUTTON_RECORD = TOUCH_PAD_NUM5, TOUCH_BUTTON_VOLUP = TOUCH_PAD_NUM1, TOUCH_BUTTON_VOLDOWN = TOUCH_PAD_NUM3, TOUCH_BUTTON_GUARD = TOUCH_PAD_NUM4, TOUCH_SHELED_ELECT = TOUCH_PAD_NUM14, TOUCH_BUTTON_NUM = 7 }; ``` ## Functions Documentation ### function `bsp_iot_button_create` _Initialize all buttons._ ```c esp_err_t bsp_iot_button_create ( button_handle_t btn_array, int *btn_cnt, int btn_array_size ) ``` Returned button handlers must be used with espressif/button component API **Note:** For LCD panel button which is defined as BSP\_BUTTON\_MAIN, bsp\_display\_start should be called before call this function. **Parameters:** * `btn_array` Output button array * `btn_cnt` Number of button handlers saved to btn\_array, can be NULL * `btn_array_size` Size of output button array. Must be at least BSP\_BUTTON\_NUM **Returns:** * ESP\_OK All buttons initialized * ESP\_ERR\_INVALID\_ARG btn\_array is too small or NULL * ESP\_FAIL Underlaying iot\_button\_create failed ### function `bsp_touchpad_calibrate` _Calibrate touch threshold._ ```c esp_err_t bsp_touchpad_calibrate ( bsp_touchpad_button_t tch_pad, float tch_threshold ) ``` **Parameters:** * `tch_pad` Touch pad from bsp\_touchpad\_button\_t enum. * `tch_threshold` Interrupt threshold ratio. Min.: 0, max.: 1. **Returns:** * ESP\_OK On success * ESP\_ERR\_INVALID\_ARG NULL pointer or invalid configuration ### function `bsp_touchpad_deinit` _Deinit buttons on Touchpad board._ ```c esp_err_t bsp_touchpad_deinit ( void ) ``` ### function `bsp_touchpad_init` _Init buttons on Touchpad board._ ```c esp_err_t bsp_touchpad_init ( intr_handler_t fn ) ``` **Attention:** This function initializes all touchpad buttons, including 'Photo' and 'Network' buttons, which have conflicts with Audio board buttons and LCD respectively. **Parameters:** * `fn` Interrupt callback for touchpad peripheral. **Returns:** * ESP\_OK On success * ESP\_ERR\_INVALID\_ARG NULL pointer or invalid configuration * ESP\_FAIL Touch pad not initialized * ESP\_ERR\_NO\_MEM No memory ## :bulb: LEDs LEDs are handled similarly to buttons in BSP. The BSP uses the [led_indicator](https://components.espressif.com/components/espressif/led_indicator) component, which provides simple control over LED states and built-in effects such as blinking, breathing, and more. It also supports addressable RGB LEDs. ``` /* Initialize all LEDs */ bsp_led_indicator_create(leds, NULL, BSP_LED_NUM); /* Set color of the first LED (for addressable RGB LEDs only) */ led_indicator_set_rgb(leds[0], SET_IRGB(0, 0x00, 0x64, 0x64)); /* Start a predefined LED effect: - BSP_LED_ON - BSP_LED_OFF - BSP_LED_BLINK_FAST - BSP_LED_BLINK_SLOW - BSP_LED_BREATHE_FAST - BSP_LED_BREATHE_SLOW */ led_indicator_start(leds[0], BSP_LED_BREATHE_SLOW); ``` **Notes:** - `BSP_LED_NUM` defines the total number of available LEDs on the board - LEDs are automatically configured by the BSP (no need to set GPIO or direction manually) ### Leds API Reference ## Macros | Type | Name | | ---: | :--- | | define | [**BSP\_LEDSTRIP\_IO**](#define-bsp_ledstrip_io) (GPIO\_NUM\_45) | ## :camera: Camera There is no dedicated BSP API for camera functionality. Instead, the BSP provides default configuration macros: - `BSP_CAMERA_DEFAULT_CONFIG` - `BSP_CAMERA_VFLIP` - `BSP_CAMERA_HMIRROR` These macros are designed for use with the [esp32-camera](https://components.espressif.com/components/espressif/esp32-camera) component. > [!NOTE] > Don't forget to initialize I2C (`bsp_i2c_init()`) before using the camera, as some camera modules require I2C for configuration. ### Example Usage ``` /* Initialize I2C bus (required by camera module) */ bsp_i2c_init(); /* Initialize the camera using BSP default config */ const camera_config_t camera_config = BSP_CAMERA_DEFAULT_CONFIG; esp_camera_init(&camera_config); /* Optional: Set camera orientation */ sensor_t *s = esp_camera_sensor_get(); s->set_vflip(s, BSP_CAMERA_VFLIP); // Vertical flip s->set_hmirror(s, BSP_CAMERA_HMIRROR); // Horizontal mirror ... /* Capture a frame */ camera_fb_t * pic = esp_camera_fb_get(); if (pic) { /* Access raw image data in pic->buf with size pic->len */ process_image(pic->buf, pic->len); // Replace with your function esp_camera_fb_return(pic); } ``` ### Camera API Reference ## Macros | Type | Name | | ---: | :--- | | define | [**BSP\_CAMERA\_D0**](#define-bsp_camera_d0) (GPIO\_NUM\_36) | | define | [**BSP\_CAMERA\_D1**](#define-bsp_camera_d1) (GPIO\_NUM\_37) | | define | [**BSP\_CAMERA\_D2**](#define-bsp_camera_d2) (GPIO\_NUM\_41) | | define | [**BSP\_CAMERA\_D3**](#define-bsp_camera_d3) (GPIO\_NUM\_42) | | define | [**BSP\_CAMERA\_D4**](#define-bsp_camera_d4) (GPIO\_NUM\_39) | | define | [**BSP\_CAMERA\_D5**](#define-bsp_camera_d5) (GPIO\_NUM\_40) | | define | [**BSP\_CAMERA\_D6**](#define-bsp_camera_d6) (GPIO\_NUM\_21) | | define | [**BSP\_CAMERA\_D7**](#define-bsp_camera_d7) (GPIO\_NUM\_38) | | define | [**BSP\_CAMERA\_DEFAULT\_CONFIG**](#define-bsp_camera_default_config) _Kaluga camera default configuration._ | | define | [**BSP\_CAMERA\_HMIRROR**](#define-bsp_camera_hmirror) 0 | | define | [**BSP\_CAMERA\_HSYNC**](#define-bsp_camera_hsync) (GPIO\_NUM\_3) | | define | [**BSP\_CAMERA\_PCLK**](#define-bsp_camera_pclk) (GPIO\_NUM\_33) | | define | [**BSP\_CAMERA\_VFLIP**](#define-bsp_camera_vflip) 1 | | define | [**BSP\_CAMERA\_VSYNC**](#define-bsp_camera_vsync) (GPIO\_NUM\_2) | | define | [**BSP\_CAMERA\_XCLK**](#define-bsp_camera_xclk) (GPIO\_NUM\_1) |

readme

api

Links

Target

License: Apache-2.0

Tags

Stats

Badge