waveshare/waveshare_boards

<div align="center"> <h1>Waveshare Boards</h1> Waveshare board definitions for ESP Board Manager <a href="https://github.com/waveshareteam/waveshare_boards/actions/workflows/ci.yml"><img src="https://github.com/waveshareteam/waveshare_boards/actions/workflows/ci.yml/badge.svg" alt="Build"></a> <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" alt="License"></a> English | [简体中文](README_ZH.md) <a href="docs/CI.md">📚 Documentation</a> · <a href="#quick-start">🚀 Quick start</a> </div> --- This board pack describes Waveshare hardware using Board Manager YAML files and board-specific setup code. It follows the component-pack workflow in [demo_boards](https://github.com/LiuCodee/demo_boards), with Waveshare definitions, bilingual documentation, and generation/build checks. <a id="board-catalog"></a> ## 📋 Board catalog ### ESP32-S3 <table> <tr> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.75C"><img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-AMOLED-1.75C/6d19f7e16fb9a3be219e9eed43ca9eb56c88d01c/docs/images/esp32-s3-touch-amoled-1.75c.jpg" alt="ESP32-S3-Touch-AMOLED-1.75C development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-S3-Touch-AMOLED-1.75C <a href="boards/esp32_s3_touch_amoled_1_75c/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.75C">Product documentation</a> </td> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.8"><img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-AMOLED-1.8/7ab8f957e22ea1ab811256359f4eddcaaf49ee91/assets/ESP32-S3-Touch-AMOLED-1.8-hero.webp" alt="ESP32-S3-Touch-AMOLED-1.8 development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-S3-Touch-AMOLED-1.8 <a href="boards/esp32_s3_touch_amoled_1_8/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-1.8">Product documentation</a> </td> </tr> <tr> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-2.16"><img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-AMOLED-2.16/225a62bff11b5d0a0b607873860d39485a9a9685/docs/assets/ESP32-S3-Touch-AMOLED-2.16-details-1.jpg" alt="ESP32-S3-Touch-AMOLED-2.16 development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-S3-Touch-AMOLED-2.16 <a href="boards/esp32_s3_touch_amoled_2_16/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-AMOLED-2.16">Product documentation</a> </td> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-S3-Touch-LCD-7"><img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-Touch-LCD-7/bc51a84b30c0cea018fee6e0d7427ec10102060e/assets/Product-1.webp" alt="ESP32-S3-Touch-LCD-7 development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-S3-Touch-LCD-7 <a href="boards/esp32_s3_touch_lcd_7/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-S3-Touch-LCD-7">Product documentation</a> </td> </tr> <tr> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-S3-LR1121-OLED-1.54"><img src="https://raw.githubusercontent.com/waveshareteam/esp32-s3-lr1121-oled-1.54/main/assets/ESP32-S3-LR1121-OLED-1.54-DocHeader-1.webp" alt="ESP32-S3-LR1121-OLED-1.54-XF development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-S3-LR1121-OLED-1.54-XF <a href="boards/esp32_s3_lr1121_oled_1_54_xf/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-S3-LR1121-OLED-1.54">Product documentation</a> </td> </tr> <tr> <td align="center" valign="middle" width="180"> <a href="https://docs.waveshare.com/ESP32-S3-LR1121-ePaper-2.9"> <img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S3-LR1121-ePaper-2.9/4aa6c326ca3a23317b180c86bbaea15d3327386f/docs/images/ESP32-S3-LR1121-ePaper-2.9-details-5-2.webp" alt="ESP32-S3-LR1121-ePaper-2.9 development board" width="160"> </a> </td> <td valign="middle" width="600"> ESP32-S3-LR1121-ePaper-2.9 <a href="boards/esp32_s3_lr1121_epaper_2_9/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-S3-LR1121-ePaper-2.9">Product documentation</a> </td> </tr> </table> ### ESP32-P4 <table> <tr> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-P4-NANO-WIFI6-DB"><img src="https://www.waveshare.net/photo/development-board/ESP32-P4-NANO-WIFI6-DB/ESP32-P4-NANO-WIFI6-DB-details-1.jpg" alt="ESP32-P4-NANO-WIFI6-DB development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-P4-NANO-WIFI6-DB <a href="boards/esp32_p4_nano_wifi6_db/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-P4-NANO-WIFI6-DB">Product documentation</a> </td> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-P4-WIFI6-DB"><img src="https://www.waveshare.net/photo/development-board/ESP32-P4-WIFI6-DB/ESP32-P4-WIFI6-DB-details-1.jpg" alt="ESP32-P4-WIFI6-DB development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-P4-WIFI6-DB <a href="boards/esp32_p4_wifi6_db/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-P4-WIFI6-DB">Product documentation</a> </td> </tr> <tr> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-P4-NANO"><img src="https://www.waveshare.net/photo/development-board/ESP32-P4-NANO/ESP32-P4-NANO-details-1.jpg" alt="ESP32-P4-NANO development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-P4-NANO <a href="boards/esp32_p4_nano/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-P4-NANO">Product documentation</a> </td> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-P4-WIFI6"><img src="https://www.waveshare.net/photo/development-board/ESP32-P4-WIFI6/ESP32-P4-WIFI6-details-1.jpg" alt="ESP32-P4-WIFI6 development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-P4-WIFI6 <a href="boards/esp32_p4_wifi6/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-P4-WIFI6">Product documentation</a> </td> </tr> <tr> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-4B"><img src="https://raw.githubusercontent.com/waveshareteam/ESP32-P4-WIFI6-Touch-LCD-4B/main/docs/assets/esp32-p4-wifi6-touch-lcd-4b.jpg" alt="ESP32-P4-WIFI6-Touch-LCD-4B development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-P4-WIFI6-Touch-LCD-4B <a href="boards/esp32_p4_wifi6_touch_lcd_4b/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-4B">Product documentation</a> </td> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-7B"><img src="https://raw.githubusercontent.com/waveshareteam/ESP32-P4-WIFI6-Touch-LCD-7B/main/assets/ESP32-P4-WIFI6-Touch-LCD-7B-details-1.jpg" alt="ESP32-P4-WIFI6-Touch-LCD-7B development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-P4-WIFI6-Touch-LCD-7B <a href="boards/esp32_p4_wifi6_touch_lcd_7b/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-7B">Product documentation</a> </td> </tr> <tr> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-3.5"><img src="https://raw.githubusercontent.com/waveshareteam/ESP32-P4-WIFI6-Touch-LCD-3.5/870588e62daaf723f3c52f0060d8dc053665ed30/assets/ESP32-P4-WIFI6-Touch-LCD-3.5-details-1.jpg" alt="ESP32-P4-WIFI6-Touch-LCD-3.5 development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-P4-WIFI6-Touch-LCD-3.5 <a href="boards/esp32_p4_wifi6_touch_lcd_3_5/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-3.5">Product documentation</a> </td> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-4.3"><img src="https://www.waveshare.net/photo/development-board/ESP32-P4-WIFI6-Touch-LCD-4.3/ESP32-P4-WIFI6-Touch-LCD-4.3-1.jpg?v=26020602" alt="ESP32-P4-WIFI6-Touch-LCD-4.3 development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-P4-WIFI6-Touch-LCD-4.3 <a href="boards/esp32_p4_wifi6_touch_lcd_4_3/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-4.3">Product documentation</a> </td> </tr> <tr> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-X"><img src="https://raw.githubusercontent.com/waveshareteam/ESP32-P4-WIFI6-Touch-LCD-X/f15098fe62072156db1e7baf9a0945801f8a8877/assets/ESP32-P4-WIFI6-Touch-LCD-X.jpg" alt="ESP32-P4-WIFI6-Touch-LCD-X development boards" width="140"></a></td> <td valign="middle" width="350"> ESP32-P4-WIFI6-Touch-LCD-X <a href="boards/esp32_p4_wifi6_touch_lcd_x/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-X">Product documentation</a> </td> <td align="center" valign="middle" width="150"><a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-XC"><img src="https://raw.githubusercontent.com/waveshareteam/ESP32-P4-WIFI6-Touch-LCD-XC/6948676d64515b6273998236d98a643ead640735/assets/ESP32-P4-WIFI6-Touch-LCD-XC.jpg" alt="ESP32-P4-WIFI6-Touch-LCD-XC development boards" width="140"></a></td> <td valign="middle" width="350"> ESP32-P4-WIFI6-Touch-LCD-XC <a href="boards/esp32_p4_wifi6_touch_lcd_xc/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-P4-WIFI6-Touch-LCD-XC">Product documentation</a> </td> </tr> <tr> <td align="center" valign="middle" width="150"><a href="https://www.waveshare.com/wiki/ESP32-P4-Knob-Touch-AMOLED-1.75"><img src="docs/images/esp32-p4-knob-touch-amoled-1.75.jpg" alt="ESP32-P4-Knob-Touch-AMOLED-1.75 development board" width="140"></a></td> <td valign="middle" width="350"> ESP32-P4-Knob-Touch-AMOLED-1.75 <a href="boards/esp32_p4_knob_touch_amoled_1_75/">Board definition</a> · <a href="https://www.waveshare.com/wiki/ESP32-P4-Knob-Touch-AMOLED-1.75">Product documentation</a> </td> </tr> </table> ### ESP32-S31 <table> <tr> <td align="center" valign="middle" width="180"> <a href="https://docs.waveshare.com/ESP32-S31-Touch-LCD-4.3C"> <img src="https://raw.githubusercontent.com/waveshareteam/ESP32-S31-Touch-LCD-4.3C/8007c28a43f19fea878a61df5ad34ee61cecb5e4/docs/images/Product-1.webp" alt="ESP32-S31-Touch-LCD-4.3C development board" width="160"> </a> </td> <td valign="middle" width="600"> ESP32-S31-Touch-LCD-4.3C <a href="boards/esp32_s31_touch_lcd_4_3c/">Board definition</a> · <a href="https://docs.waveshare.com/ESP32-S31-Touch-LCD-4.3C">Product documentation</a> </td> </tr> </table> Some boards support [display configuration](#display-configurations) with `-a`. <details> <summary>Device and peripheral definitions</summary> The table lists definitions present in this repository. Peripheral declarations such as `spi_sd` describe a bus; they do not imply a complete storage application.  | Board | Chip | Device definitions | Peripheral definitions | | --- | --- | --- | --- | | [`esp32_p4_knob_touch_amoled_1_75`](boards/esp32_p4_knob_touch_amoled_1_75/) | ESP32-P4 | `display_lcd`, `lcd_touch`, `audio_dac`, `audio_adc`, `fs_spiffs`, `fs_sdcard`, `wireless` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `gpio_knob_cw`, `gpio_knob_ccw`, `gpio_haptic_in1`, `gpio_haptic_in2`, `gpio_boot`, `gpio_power`, `gpio_rtc_int`, `gpio_imu_int1`, `gpio_imu_int2`, `ldo_mipi`, `dsi_display` | | [`esp32_p4_nano`](boards/esp32_p4_nano/) | ESP32-P4 | `audio_dac`, `audio_adc`, `sdcard_power_ctrl`, `fs_sdcard`, `display_lcd`, `lcd_brightness`, `fs_spiffs`, `lcd_touch`, `camera` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `gpio_sd_power`, `ldo_mipi`, `dsi_display` | | [`esp32_p4_nano_wifi6_db`](boards/esp32_p4_nano_wifi6_db/) | ESP32-P4 | `audio_dac`, `audio_adc`, `camera`, `display_lcd`, `lcd_brightness`, `fs_spiffs`, `sdcard_power_ctrl`, `fs_sdcard`, `lcd_touch` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `gpio_sd_power`, `ldo_mipi`, `dsi_display` | | [`esp32_p4_wifi6`](boards/esp32_p4_wifi6/) | ESP32-P4 | `camera`, `audio_dac`, `audio_adc`, `display_lcd`, `lcd_brightness`, `fs_spiffs`, `lcd_touch`, `fs_sdcard`, `sdcard_power_ctrl` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `gpio_sd_power`, `ldo_mipi`, `dsi_display` | | [`esp32_p4_wifi6_db`](boards/esp32_p4_wifi6_db/) | ESP32-P4 | `camera`, `audio_dac`, `audio_adc`, `display_lcd`, `lcd_brightness`, `fs_spiffs`, `lcd_touch`, `fs_sdcard`, `sdcard_power_ctrl` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `gpio_sd_power`, `ldo_mipi`, `dsi_display` | | [`esp32_p4_wifi6_db_poe_eth`](boards/esp32_p4_wifi6_db_poe_eth/) | ESP32-P4 | `camera`, `audio_dac`, `audio_adc`, `display_lcd`, `lcd_brightness`, `fs_spiffs`, `lcd_touch`, `fs_sdcard`, `sdcard_power_ctrl` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `gpio_sd_power`, `ldo_mipi`, `dsi_display` | | [`esp32_p4_wifi6_touch_lcd_3_5`](boards/esp32_p4_wifi6_touch_lcd_3_5/) | ESP32-P4 | `audio_dac`, `audio_adc`, `fs_spiffs`, `fs_sdcard`, `display_lcd`, `lcd_touch`, `lcd_brightness`, `camera` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `ldo_mipi`, `spi_lcd`, `ledc_backlight` | | [`esp32_p4_wifi6_touch_lcd_4_3`](boards/esp32_p4_wifi6_touch_lcd_4_3/) | ESP32-P4 | `audio_dac`, `audio_adc`, `fs_spiffs`, `sdcard_power_ctrl`, `fs_sdcard`, `display_lcd`, `lcd_touch`, `lcd_brightness`, `camera` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `gpio_sd_power`, `ldo_mipi`, `dsi_display`, `ledc_backlight` | | [`esp32_p4_wifi6_touch_lcd_4b`](boards/esp32_p4_wifi6_touch_lcd_4b/) | ESP32-P4 | `audio_dac`, `audio_adc`, `fs_spiffs`, `sdcard_power_ctrl`, `fs_sdcard`, `display_lcd`, `lcd_touch`, `lcd_brightness`, `camera` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `gpio_sd_power`, `ldo_mipi`, `dsi_display`, `ledc_backlight` | | [`esp32_p4_wifi6_touch_lcd_7b`](boards/esp32_p4_wifi6_touch_lcd_7b/) | ESP32-P4 | `fs_sdcard`, `sdcard_power_ctrl`, `audio_adc`, `audio_dac`, `camera`, `display_lcd`, `lcd_touch`, `lcd_brightness`, `fs_spiffs` | `gpio_sd_power`, `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `ldo_mipi`, `dsi_display`, `ledc_backlight` | | [`esp32_p4_wifi6_touch_lcd_x`](boards/esp32_p4_wifi6_touch_lcd_x/) | ESP32-P4 | `audio_dac`, `audio_adc`, `fs_spiffs`, `fs_sdcard`, `display_lcd`, `lcd_touch`, `lcd_brightness`, `camera` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `ldo_mipi`, `dsi_display`, `ledc_backlight` | | [`esp32_p4_wifi6_touch_lcd_xc`](boards/esp32_p4_wifi6_touch_lcd_xc/) | ESP32-P4 | `audio_dac`, `audio_adc`, `fs_spiffs`, `sdcard_power_ctrl`, `fs_sdcard`, `display_lcd`, `lcd_touch`, `backlight_power_ctrl`, `lcd_brightness`, `camera` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `gpio_sd_power`, `ldo_mipi`, `dsi_display`, `ledc_backlight`, `gpio_backlight_control` | | [`esp32_s31_touch_lcd_4_3c`](boards/esp32_s31_touch_lcd_4_3c/) | ESP32-S31 | `display_lcd`, `lcd_touch`, `lcd_brightness`, `sdcard_power_ctrl`, `fs_sdcard`, `audio_dac`, `audio_adc`, `rtc_pcf85063`, `imu_qmi8658`, `bat_bq27220`, `canfd` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `ledc_backlight`, `gpio_sd_power`, `gpio_power_amp`, `uart_rs485` | | [`esp32_s3_lr1121_epaper_2_9`](boards/esp32_s3_lr1121_epaper_2_9/) | ESP32-S3 | `status_led`, `epaper_power_ctrl`, `epaper_ssd16xx`, `rtc_pcf85063a`, `bat_axp2602`, `radio_lr1121` | `i2c_master`, `spi_shared`, `gpio_boot`, `gpio_epaper_power` | | [`esp32_s3_lr1121_oled_1_54_xf`](boards/esp32_s3_lr1121_oled_1_54_xf/) | ESP32-S3 | `button_boot`, `button_power`, `button_menu`, `button_ptt`, `button_rtc_irq`, `radio`, `oled`, `rtc`, `battery`, `audio`, `sdcard` | `i2c_main`, `spi_radio`, `gpio_boot`, `gpio_power`, `gpio_menu`, `gpio_ptt`, `gpio_rtc_irq`, `gpio_amplifier`, `gpio_radio_cs`, `gpio_radio_irq`, `gpio_radio_reset`, `gpio_radio_busy`, `i2s_speaker`, `i2s_microphone` | | [`esp32_s3_touch_amoled_1_75c`](boards/esp32_s3_touch_amoled_1_75c/) | ESP32-S3 | `axp2101_power_manager`, `audio_dac`, `audio_adc`, `display_lcd`, `lcd_touch` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `spi_display` | | [`esp32_s3_touch_amoled_1_8`](boards/esp32_s3_touch_amoled_1_8/) | ESP32-S3 | `gpio_expander`, `axp2101_power_manager`, `audio_dac`, `audio_adc`, `display_lcd`, `lcd_touch`, `fs_sdcard` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `spi_display` | | [`esp32_s3_touch_amoled_2_16`](boards/esp32_s3_touch_amoled_2_16/) | ESP32-S3 | `axp2101_power_manager`, `audio_dac`, `audio_adc`, `display_lcd`, `lcd_touch`, `fs_sdcard` | `i2c_master`, `i2s_audio_out`, `i2s_audio_in`, `gpio_pa_control`, `spi_display` | | [`esp32_s3_touch_lcd_7`](boards/esp32_s3_touch_lcd_7/) | ESP32-S3 | `display_lcd`, `lcd_touch` | `i2c_master`, `uart_rs485`, `uart_external`, `adc_sensor`, `spi_sd` |  </details> Definitions live under `boards/<full_model>/`. The three AMOLED profiles come from Espressif Brookesia; see [board revisions and migration notes](docs/BOARDS.md). CI validates generation and compilation; physical operation requires board testing. The LR1121 OLED XF profile provides hardware definitions and requires application-side custom device adapters; see [its support scope](docs/BOARDS.md#lr1121-oled-154-xf-definition-scope). The LR1121 ePaper 2.9 profile defines the display, radio, RTC, battery gauge and status LED. Custom devices require application-side adapters; see [its support scope](docs/BOARDS.md#lr1121-epaper-29-definition-scope). ESP32-S31-Touch-LCD-4.3C uses target `esp32s31`; the ESP32-S3 quick-start commands below do not apply to it. See [board notes](docs/BOARDS.md#s31-touch-lcd-43c-definition-scope) for preview/development toolchain requirements, initialization and current CI limits. ESP32-P4-Knob-Touch-AMOLED-1.75 uses target `esp32p4`. Its SD card, wireless co-processor and SPIFFS entries have application-side prerequisites; see [its support scope](docs/BOARDS.md#p4-knob-touch-amoled-175-definition-scope). <a id="quick-start"></a> ## 🚀 Quick start Activate ESP-IDF first. For a local checkout, clone this pack into an **existing ESP-IDF application's** component directory: ```bash mkdir -p components git clone https://github.com/waveshareteam/waveshare_boards.git components/waveshare_boards python -m pip install esp-bmgr-assist==0.8.3 idf.py set-target esp32s3 idf.py bmgr -l idf.py bmgr -b esp32_s3_touch_lcd_7 idf.py build ``` Use the Component Manager version from the active IDF environment; the tested versions for each IDF line are listed in [the CI guide](docs/CI.md). `set-target` resolves the pack dependencies before discovery. In an already configured ESP32-S3 application, use `idf.py reconfigure` instead to preserve its configuration. Keep the local directory name `waveshare_boards`: ESP-IDF uses the directory name as the component name. The pack declares `espressif/esp_board_manager` as a public dependency. Applications can include `esp_board_manager.h` and initialize the selected board using `esp_board_manager_init()`. Published versions can be installed from the registry: ```bash idf.py add-dependency "waveshare/waveshare_boards" idf.py reconfigure idf.py bmgr -l ``` Find available versions in the [Component Registry](https://components.espressif.com/components/waveshare/waveshare_boards). ### Display configurations Some boards provide display amendments selected with `-a`: | Board | Display amendment | | --- | --- | | `esp32_p4_wifi6_touch_lcd_x` | `lcd_7_dsi_touch_a`, `lcd_8_dsi_touch_a` | | `esp32_p4_wifi6_touch_lcd_xc` | `lcd_3_4_dsi_touch_c` | For example, select the 7-inch configuration in an ESP32-P4 application: ```bash idf.py bmgr -b esp32_p4_wifi6_touch_lcd_x -a lcd_7_dsi_touch_a ``` Re-run the command after changing the board or amendment. Without an amendment, `esp32_p4_wifi6_touch_lcd_x` uses its 10.1-inch base configuration. ESP32-P4 boards with an external MIPI-DSI connector (`esp32_p4_nano`, `esp32_p4_nano_wifi6_db`, `esp32_p4_wifi6`, `esp32_p4_wifi6_db`, and `esp32_p4_wifi6_db_poe_eth`) can use the shared [DSI display overlays](boards/esp32_p4_dsi_overlay/) for `5_dsi_touch_a`, `7_dsi_touch_c`, `8_dsi_touch_a`, `10_1_dsi_touch_a`, and `10_1_dsi_touch_b`. The overlay path is resolved relative to the selected board directory: ```bash idf.py bmgr -b esp32_p4_wifi6_db -a ../esp32_p4_dsi_overlay/7_dsi_touch_c ``` See the [Board Manager amend guide](https://docs.espressif.com/projects/esp-board-manager/en/latest/create-board/amend.html). ## 🗂️ Repository layout ```text boards/<full_model>/ Board metadata, peripherals, devices, and setup code include/ Framework-independent AMOLED brightness helper idf_component.yml Component metadata and managed dependencies CMakeLists.txt Board-pack component registration ci/test_app/ Board Manager integration compile test ci/scripts/ Discovery, change routing, and validation tests ci/versions.json Exact ESP-IDF and Python tooling versions scripts/ Generated board catalog maintenance docs/ Board revisions, CI, and registry publication guides .github/ Workflows and contribution templates ``` The integration test is maintained under `ci/`; this repository currently has no first-party application examples, Arduino sketches, or delivery firmware. ## 🛠️ Maintenance ```bash python scripts/update_supported_boards_table.py python ci/scripts/board_pack.py check python -m unittest discover -s ci/scripts -p 'test_*.py' -v ``` Use one `boards/` container and keep the chip prefix in each model name. Do not add another chip/category directory: the layout must fit Board Manager scanning from an application's `components/` root. Each model directory must match its unique `board` value. The catalog is regenerated from the definitions. ## 📚 Documentation - [Board organization, hardware revisions, and migration](docs/BOARDS.md) - [AMOLED brightness control](docs/INTEGRATIONS.md) - [CI coverage and local validation](docs/CI.md) - [Registry credentials and publication](docs/PUBLISHING.md) - [Contributing](CONTRIBUTING.md) - [Support](SUPPORT.md) - [ESP Board Manager documentation](https://docs.espressif.com/projects/esp-board-manager/en/latest/index.html) ## 📄 License [Apache License 2.0](LICENSE), with imported files retaining their original SPDX notices, including CC0-1.0. See [source attribution](docs/BOARDS.md).

Readme

Links

Supports all targets

Tags

Stats

Badge