espressif/m5stack_core_2

# BSP: M5Stack Core2 | [HW Reference](https://docs.m5stack.com/en/core/Core2) | [HOW TO USE API](API.md) | [EXAMPLES](#compatible-bsp-examples) | [![Component Registry](https://components.espressif.com/components/espressif/m5stack_core_2/badge.svg)](https://components.espressif.com/components/espressif/m5stack_core_2) | ![maintenance-status](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg) | | --- | --- | --- | --- | -- | > [!WARNING] > The SD card is not working simultaneously with the LCD screen. We are working on a fix. ## Overview <table> <tr><td> M5Core2 is the second generation core device in the M5Stack development kit series, which further enhances the functions of the original generation of cores. It is a powerful and user-friendly development board with the following features: - **MCU**: Equipped with an ESP32-D0WDQ6-V3, featuring dual core Xtensa® 32-bit 240Mhz LX6 processors that can be controlled separately. - **Memory**: Onboard 16MB Flash and 8MB PSRAM. - **Interface**: USB TYPE-C interface for charging, program downloading, and serial communication. - **Display**: 2.0-inch integrated capacitive touch screen with three programmable capacitive buttons on the front. - **Power Management:** Managed by an AXP192 power management chip (upgraded to AXP2101 in Core2 V1.1), which effectively controls power consumption. It includes a built-in green LED power indicator for battery level notification. The battery capacity is 390mAh, providing longer power duration than the previous model. - For Core2 V1.0: Configure `CONFIG_BSP_PMU_AXP192` - For Core2 V1.1: Configure `CONFIG_BSP_PMU_AXP2101` - **Audio**: I2S digital audio interface power amplifier chip to prevent signal distortion, along with a built-in speaker. - **Expansion**: Retains a TF-card (microSD) slot, and an expansion board on the back with a 6-axis IMU sensor and a microphone. - **RTC Module**: Built-in RTC module for accurate timing, with a dedicated battery for RTC power supply in Core2 V1.1. Additional Features: Built-in vibration motor for haptic feedback, independent power, and reset buttons on the left side and bottom of the base. </td><td width="200" valign="top"> <img src="doc/m5stack_core_2.webp"> </td></tr> </table> <img src="https://static-cdn.m5stack.com/resource/docs/products/core/core2/core2_01.webp" alt="basic" width="350" height="350"><img src="https://static-cdn.m5stack.com/resource/docs/products/core/Core2%20v1.1/img-1a949091-da2c-4fbb-bf4f-bce108cb43ec.webp" alt="gray" width="350" height="350"> #### Core2 V1.1 Enhancements Core2 V1.1 is an iterative version of Core2 with the following upgrades and additional features: - **Power Management**: Uses the AXP2101 power management chip for enhanced power control. - **Indicators**: Built-in blue power indicator light for specific functions or status indications. - RTC Battery: Dedicated battery for RTC power supply for accurate timing. - **User Interaction**: Enhanced touch screen experience with programmable virtual buttons for diverse human-machine interaction. ## Capabilities and dependencies <div align="center">  | Available | Capability |Controller/Codec| Component | Version | |------------------|------------------------|----------------|------------------------------------------------------------------------------------------------------------|------------| |:heavy_check_mark:| :pager: DISPLAY | ili9341 | [espressif/esp_lcd_ili9341](https://components.espressif.com/components/espressif/esp_lcd_ili9341) idf |^1 >=5.0| |:heavy_check_mark:|:black_circle: LVGL_PORT| | [espressif/esp_lvgl_port](https://components.espressif.com/components/espressif/esp_lvgl_port) | ^2 | |:heavy_check_mark:| :point_up: TOUCH | ft5x06 |[espressif/esp_lcd_touch_ft5x06](https://components.espressif.com/components/espressif/esp_lcd_touch_ft5x06)| ^1 | | :x: | :radio_button: BUTTONS | | | | |:heavy_check_mark:| :musical_note: AUDIO | | [espressif/esp_codec_dev](https://components.espressif.com/components/espressif/esp_codec_dev) | ~1.1 | |:heavy_check_mark:| :speaker: AUDIO_SPEAKER| | | | | :x: | :microphone: AUDIO_MIC | | | | |:heavy_check_mark:| :floppy_disk: SDCARD | | idf | >=5.0 | | :x: | :video_game: IMU | | | |  </div> ## Compatible BSP Examples <div align="center">  | Example | Description | Try with ESP Launchpad | | ------- | ----------- | ---------------------- | | [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) | | [Display, Audio and Photo Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_audio_photo) | Complex demo: browse files from filesystem and play/display JPEG, WAV, or TXT files (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_audio_photo) |  </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) | | :-------------------------: | :-------------------------: | :-------------------------: | :-------------------------: | </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\_M5STACK\_CORE\_2**](#define-bsp_board_m5stack_core_2) | ## :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) 0 | | define | [**BSP\_CAPS\_AUDIO\_SPEAKER**](#define-bsp_caps_audio_speaker) 1 | | define | [**BSP\_CAPS\_BUTTONS**](#define-bsp_caps_buttons) 0 | | define | [**BSP\_CAPS\_DISPLAY**](#define-bsp_caps_display) 1 | | define | [**BSP\_CAPS\_IMU**](#define-bsp_caps_imu) 0 | | define | [**BSP\_CAPS\_SDCARD**](#define-bsp_caps_sdcard) 1 | | define | [**BSP\_CAPS\_TOUCH**](#define-bsp_caps_touch) 1 | ### I2C API Reference ## Functions | Type | Name | | ---: | :--- | | esp\_err\_t | [**bsp\_i2c\_deinit**](#function-bsp_i2c_deinit) (void) _Deinit I2C driver and free its resources._ | | 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\_22) | | define | [**BSP\_I2C\_SDA**](#define-bsp_i2c_sda) (GPIO\_NUM\_21) | ## 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_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 ## Structures and Types | Type | Name | | ---: | :--- | | struct | [**bsp\_sdcard\_cfg\_t**](#struct-bsp_sdcard_cfg_t) _BSP SD card configuration structure._ | ## Functions | Type | Name | | ---: | :--- | | sdmmc\_card\_t \* | [**bsp\_sdcard\_get\_handle**](#function-bsp_sdcard_get_handle) (void) _Get SD card handle._ | | void | [**bsp\_sdcard\_get\_sdmmc\_host**](#function-bsp_sdcard_get_sdmmc_host) (const int slot, sdmmc\_host\_t \*config) _Get SD card MMC host config._ | | void | [**bsp\_sdcard\_get\_sdspi\_host**](#function-bsp_sdcard_get_sdspi_host) (const int slot, sdmmc\_host\_t \*config) _Get SD card SPI host config._ | | esp\_err\_t | [**bsp\_sdcard\_mount**](#function-bsp_sdcard_mount) (void) _Mount microSD card to virtual file system._ | | void | [**bsp\_sdcard\_sdmmc\_get\_slot**](#function-bsp_sdcard_sdmmc_get_slot) (const int slot, sdmmc\_slot\_config\_t \*config) _Get SD card MMC slot config._ | | esp\_err\_t | [**bsp\_sdcard\_sdmmc\_mount**](#function-bsp_sdcard_sdmmc_mount) ([**bsp\_sdcard\_cfg\_t**](#struct-bsp_sdcard_cfg_t) \*cfg) _Mount microSD card to virtual file system (MMC mode)_ | | void | [**bsp\_sdcard\_sdspi\_get\_slot**](#function-bsp_sdcard_sdspi_get_slot) (const spi\_host\_device\_t spi\_host, sdspi\_device\_config\_t \*config) _Get SD card SPI slot config._ | | esp\_err\_t | [**bsp\_sdcard\_sdspi\_mount**](#function-bsp_sdcard_sdspi_mount) ([**bsp\_sdcard\_cfg\_t**](#struct-bsp_sdcard_cfg_t) \*cfg) _Mount microSD card to virtual file system (SPI mode)_ | | esp\_err\_t | [**bsp\_sdcard\_unmount**](#function-bsp_sdcard_unmount) (void) _Unmount micorSD card from virtual file system._ | | 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\_SDSPI\_HOST**](#define-bsp_sdspi_host) (SPI2\_HOST) | | define | [**BSP\_SD\_MOUNT\_POINT**](#define-bsp_sd_mount_point) CONFIG\_BSP\_SD\_MOUNT\_POINT | | define | [**BSP\_SD\_SPI\_CS**](#define-bsp_sd_spi_cs) (GPIO\_NUM\_4) | | define | [**BSP\_SD\_SPI\_MISO**](#define-bsp_sd_spi_miso) (GPIO\_NUM\_38) | | define | [**BSP\_SD\_SPI\_MOSI**](#define-bsp_sd_spi_mosi) (GPIO\_NUM\_23) | | define | [**BSP\_SD\_SPI\_SCK**](#define-bsp_sd_spi_sck) (GPIO\_NUM\_18) | | define | [**BSP\_SPIFFS\_MOUNT\_POINT**](#define-bsp_spiffs_mount_point) CONFIG\_BSP\_SPIFFS\_MOUNT\_POINT | ## Structures and Types Documentation ### struct `bsp_sdcard_cfg_t` _BSP SD card configuration structure._ Variables: - sdmmc\_host\_t \* host - const esp\_vfs\_fat\_sdmmc\_mount\_config\_t \* mount - const sdmmc\_slot\_config\_t \* sdmmc - const sdspi\_device\_config\_t \* sdspi - union [**bsp\_sdcard\_cfg\_t**](#struct-bsp_sdcard_cfg_t) slot ## Functions Documentation ### function `bsp_sdcard_get_handle` _Get SD card handle._ ```c sdmmc_card_t * bsp_sdcard_get_handle ( void ) ``` **Returns:** SD card handle ### function `bsp_sdcard_get_sdmmc_host` _Get SD card MMC host config._ ```c void bsp_sdcard_get_sdmmc_host ( const int slot, sdmmc_host_t *config ) ``` **Parameters:** * `slot` SD card slot * `config` Structure which will be filled ### function `bsp_sdcard_get_sdspi_host` _Get SD card SPI host config._ ```c void bsp_sdcard_get_sdspi_host ( const int slot, sdmmc_host_t *config ) ``` **Parameters:** * `slot` SD card slot * `config` Structure which will be filled ### function `bsp_sdcard_mount` _Mount microSD card to virtual file system._ ```c esp_err_t bsp_sdcard_mount ( void ) ``` **Returns:** * ESP\_OK on success * ESP\_ERR\_INVALID\_STATE if esp\_vfs\_fat\_sdmmc\_mount was already called * ESP\_ERR\_NO\_MEM if memory can not be allocated * ESP\_FAIL if partition can not be mounted * other error codes from SDMMC or SPI drivers, SDMMC protocol, or FATFS drivers ### function `bsp_sdcard_sdmmc_get_slot` _Get SD card MMC slot config._ ```c void bsp_sdcard_sdmmc_get_slot ( const int slot, sdmmc_slot_config_t *config ) ``` **Parameters:** * `slot` SD card slot * `config` Structure which will be filled ### function `bsp_sdcard_sdmmc_mount` _Mount microSD card to virtual file system (MMC mode)_ ```c esp_err_t bsp_sdcard_sdmmc_mount ( bsp_sdcard_cfg_t *cfg ) ``` **Parameters:** * `cfg` SD card configuration **Returns:** * ESP\_OK on success * ESP\_ERR\_INVALID\_STATE if esp\_vfs\_fat\_sdmmc\_mount was already called * ESP\_ERR\_NO\_MEM if memory cannot be allocated * ESP\_FAIL if partition cannot be mounted * other error codes from SDMMC or SPI drivers, SDMMC protocol, or FATFS drivers ### function `bsp_sdcard_sdspi_get_slot` _Get SD card SPI slot config._ ```c void bsp_sdcard_sdspi_get_slot ( const spi_host_device_t spi_host, sdspi_device_config_t *config ) ``` **Parameters:** * `spi_host` SPI host ID * `config` Structure which will be filled ### function `bsp_sdcard_sdspi_mount` _Mount microSD card to virtual file system (SPI mode)_ ```c esp_err_t bsp_sdcard_sdspi_mount ( bsp_sdcard_cfg_t *cfg ) ``` **Parameters:** * `cfg` SD card configuration **Returns:** * ESP\_OK on success * ESP\_ERR\_INVALID\_STATE if esp\_vfs\_fat\_sdmmc\_mount was already called * ESP\_ERR\_NO\_MEM if memory cannot be allocated * ESP\_FAIL if partition cannot be mounted * other error codes from SDMMC or SPI drivers, SDMMC protocol, or FATFS drivers ### function `bsp_sdcard_unmount` _Unmount micorSD card from virtual file system._ ```c esp_err_t bsp_sdcard_unmount ( void ) ``` **Returns:** * ESP\_OK on success * ESP\_ERR\_NOT\_FOUND if the partition table does not contain FATFS partition with given label * ESP\_ERR\_INVALID\_STATE if esp\_vfs\_fat\_spiflash\_mount was already called * ESP\_ERR\_NO\_MEM if memory can not be allocated * ESP\_FAIL if partition can not be mounted * other error codes from wear levelling library, SPI flash driver, or FATFS drivers ### 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\_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\_2) | | define | [**BSP\_I2S\_DSIN**](#define-bsp_i2s_dsin) (GPIO\_NUM\_34) | | define | [**BSP\_I2S\_LCLK**](#define-bsp_i2s_lclk) (GPIO\_NUM\_0) | | define | [**BSP\_I2S\_MCLK**](#define-bsp_i2s_mclk) (GPIO\_NUM\_NC) | | define | [**BSP\_I2S\_SCLK**](#define-bsp_i2s_sclk) (GPIO\_NUM\_12) | | define | [**BSP\_MUTE\_STATUS**](#define-bsp_mute_status) (GPIO\_NUM\_NC) | | define | [**BSP\_POWER\_AMP\_IO**](#define-bsp_power_amp_io) (GPIO\_NUM\_NC) | ## Functions Documentation ### 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 occured ### 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 occured ### 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._ | | struct | [**bsp\_touch\_config\_t**](#struct-bsp_touch_config_t) _BSP touch configuration structure._ | ## Functions | Type | Name | | ---: | :--- | | esp\_err\_t | [**bsp\_display\_backlight\_off**](#function-bsp_display_backlight_off) (void) _Turn off display backlight._ | | esp\_err\_t | [**bsp\_display\_backlight\_on**](#function-bsp_display_backlight_on) (void) _Turn on display backlight._ | | esp\_err\_t | [**bsp\_display\_brightness\_init**](#function-bsp_display_brightness_init) (void) _Initialize display's brightness._ | | esp\_err\_t | [**bsp\_display\_brightness\_set**](#function-bsp_display_brightness_set) (int brightness\_percent) _Set display's brightness._ | | 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\_display\_rotation\_t rotation) _Rotate screen._ | | lv\_display\_t \* | [**bsp\_display\_start**](#function-bsp_display_start) (void) _Initialize display._ | | 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._ | | esp\_err\_t | [**bsp\_touch\_new**](#function-bsp_touch_new) (const [**bsp\_touch\_config\_t**](#struct-bsp_touch_config_t) \*config, esp\_lcd\_touch\_handle\_t \*ret\_touch) _Create new touchscreen._ | ## Macros | Type | Name | | ---: | :--- | | define | [**BSP\_LCD\_BACKLIGHT**](#define-bsp_lcd_backlight) (GPIO\_NUM\_NC) | | 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\_BGR) | | define | [**BSP\_LCD\_CS**](#define-bsp_lcd_cs) (GPIO\_NUM\_5) | | define | [**BSP\_LCD\_DC**](#define-bsp_lcd_dc) (GPIO\_NUM\_15) | | define | [**BSP\_LCD\_DRAW\_BUFF\_DOUBLE**](#define-bsp_lcd_draw_buff_double) (1) | | define | [**BSP\_LCD\_DRAW\_BUFF\_SIZE**](#define-bsp_lcd_draw_buff_size) (BSP\_LCD\_H\_RES \* 50) | | define | [**BSP\_LCD\_H\_RES**](#define-bsp_lcd_h_res) (320) | | define | [**BSP\_LCD\_MISO**](#define-bsp_lcd_miso) (GPIO\_NUM\_38) | | define | [**BSP\_LCD\_MOSI**](#define-bsp_lcd_mosi) (GPIO\_NUM\_23) | | define | [**BSP\_LCD\_PCLK**](#define-bsp_lcd_pclk) (GPIO\_NUM\_18) | | 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\_NC) | | define | [**BSP\_LCD\_SPI\_NUM**](#define-bsp_lcd_spi_num) (SPI2\_HOST) | | define | [**BSP\_LCD\_TOUCH\_INT**](#define-bsp_lcd_touch_int) (GPIO\_NUM\_39) | | 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. ### struct `bsp_touch_config_t` _BSP touch configuration structure._ Variables: - void \* dummy Prepared for future use. ## Functions Documentation ### function `bsp_display_backlight_off` _Turn off display backlight._ ```c esp_err_t bsp_display_backlight_off ( void ) ``` Backlight must be already initialized by calling [**bsp\_display\_brightness\_init()**](#function-bsp_display_brightness_init) or[**bsp\_display\_start()**](#function-bsp_display_start) **Returns:** * ESP\_OK On success * ESP\_ERR\_INVALID\_ARG Parameter error ### function `bsp_display_backlight_on` _Turn on display backlight._ ```c esp_err_t bsp_display_backlight_on ( void ) ``` Backlight must be already initialized by calling [**bsp\_display\_brightness\_init()**](#function-bsp_display_brightness_init) or[**bsp\_display\_start()**](#function-bsp_display_start) **Returns:** * ESP\_OK On success * ESP\_ERR\_INVALID\_ARG Parameter error ### function `bsp_display_brightness_init` _Initialize display's brightness._ ```c esp_err_t bsp_display_brightness_init ( void ) ``` Brightness is controlled with AXP2101 via I2C. **Returns:** * ESP\_OK On success * ESP\_ERR\_INVALID\_ARG Parameter error ### function `bsp_display_brightness_set` _Set display's brightness._ ```c esp_err_t bsp_display_brightness_set ( int brightness_percent ) ``` Brightness is controlled with AXP2101 via I2C. Backlight must be already initialized by calling [**bsp\_display\_brightness\_init()**](#function-bsp_display_brightness_init) or[**bsp\_display\_start()**](#function-bsp_display_start) **Parameters:** * `brightness_percent` Brightness in [%] **Returns:** * ESP\_OK On success * ESP\_ERR\_INVALID\_ARG Parameter error ### 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()**](#function-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_display_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._ ```c lv_display_t * bsp_display_start ( void ) ``` This function initializes SPI, display controller and starts LVGL handling task. LCD backlight must be enabled separately by calling [**bsp\_display\_brightness\_set()**](#function-bsp_display_brightness_set) **Returns:** Pointer to LVGL display or NULL when error occured ### 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. LCD backlight must be enabled separately by calling [**bsp\_display\_brightness\_set()**](#function-bsp_display_brightness_set) **Parameters:** * `cfg` display configuration **Returns:** Pointer to LVGL display or NULL when error occured ### function `bsp_display_unlock` _Give LVGL mutex._ ```c void bsp_display_unlock ( void ) ``` ### function `bsp_touch_new` _Create new touchscreen._ ```c esp_err_t bsp_touch_new ( const bsp_touch_config_t *config, esp_lcd_touch_handle_t *ret_touch ) ``` If you want to free resources allocated by this function, you can use esp\_lcd\_touch API, ie.: ````cpp esp_lcd_touch_del(tp); ```` **Parameters:** * `config` touch configuration * `ret_touch` esp\_lcd\_touch touchscreen handle **Returns:** * ESP\_OK On success * Else esp\_lcd\_touch failure ### Others API Reference ## Structures and Types | Type | Name | | ---: | :--- | | enum | [**bsp\_feature\_t**](#enum-bsp_feature_t) | ## Functions | Type | Name | | ---: | :--- | | esp\_err\_t | [**bsp\_feature\_enable**](#function-bsp_feature_enable) (bsp\_feature\_t feature, bool enable) | ## Structures and Types Documentation ### enum `bsp_feature_t` ```c enum bsp_feature_t { BSP_FEATURE_LCD, BSP_FEATURE_TOUCH, BSP_FEATURE_SD, BSP_FEATURE_SPEAKER, BSP_FEATURE_BATTERY, BSP_FEATURE_VIBRATION }; ``` ## Functions Documentation ### function `bsp_feature_enable` ```c esp_err_t bsp_feature_enable ( bsp_feature_t feature, bool enable ) ```

readme

api

Links

Target

License: Apache-2.0

Tags

Stats

Badge