ESP-BSP Generator

These fields describe your board for the generated component and README:

• BSP Name — becomes the component folder name (lowercase, safe characters).
• BSP URL — repository URL used in idf_component.yml (for publishing or documentation).
• HW Link — link to schematic, product page, or wiki.
• Long description & photo — appear in the generated README.
• NoGlib — optional second package without LVGL if you do not need graphics.
• SquareLine Studio pack — optional; requires Display. Generates OBP files (.slb, .zip, .png) for SquareLine Studio (see Help → SquareLine Studio).

Hover the beside form labels for short explanations.

Each tab corresponds to a BSP capability. Enable the checkbox on the tab, then configure pins and drivers inside:

• Dependencies between features are checked at generate time (e.g. touch over I2C requires I2C enabled).
• GPIO selects list MCU pins; enable IO Expander mapping to use expander pins where supported.
• After changing MCU, reopen tabs if pin lists look empty.
• A basic GPIO check runs before generation — it does not catch every problem (see warning below).

You can start from an existing setup instead of filling everything manually:

• Load configuration — pick a starter board (click the row) or upload a JSON file from a previous run.
• Back & change — after generation, reload the same JSON from the result page to edit and regenerate.
• Clear configuration — start from an empty form.

A saved JSON is more than a backup — it lets you refresh your BSP when the ecosystem moves on:

• ESP-IDF upgrade or new target support — reload the JSON, adjust sdkconfig-related choices if needed, and regenerate.
• BSP or driver API changes — update pins or feature options in the form instead of editing generated C files by hand.
• New generator features — load an old configuration, enable what is new, and generate again to pick up template improvements.
• Keep the JSON in your project repo next to the BSP so you can repeat this workflow anytime.

When the form is valid, Generate BSP builds a ZIP with the component, sdkconfig.defaults, and metadata JSON:

• Copy the BSP folder into your ESP-IDF project under components/.
• Add a path dependency in main/idf_component.yml.
• Copy sdkconfig.defaults from the ZIP root into your project root.
• Set the target chip and run idf.py build — details are on the success page.
• Optional: enable SquareLine Studio pack and copy the OBP files to ~/SquareLine/boards/ (see Help → SquareLine Studio).

SquareLine Studio can load custom boards via OBP. Enable Generate SquareLine Studio pack on the form (Display required). The ZIP contains a ready-made board pack under SquareLine/espressif/.

• In the ZIP, open SquareLine/espressif/<board>_v1_0_0/ — you will find <board>.slb, <board>.zip, and <board>.png.
• Copy those three files into your user SquareLine boards directory, in a version subfolder: boards/<board_name>/v1_0_0/ (folder names must match the pack).
• macOS: ~/SquareLine/boards/<board_name>/v1_0_0/
• Linux: ~/SquareLine/boards/<board_name>/v1_0_0/
• Windows: C:\Users\USERNAME\SquareLine\boards\<board_name>\v1_0_0\
• Restart SquareLine Studio if needed — the board appears in the Create menu on the Launcher screen.
• The .png is shown on the Launcher (380×300 px recommended). The .zip is a template ESP-IDF project; the .slb describes resolution, LVGL version, and export paths.

Expected folder layout in SquareLine Studio (OBP):

SquareLine/boards/
└── <board_name>/
    └── v1_0_0/
        ├── <board_name>.png
        ├── <board_name>.zip
        └── <board_name>.slb

Click a board to load that configuration into the form. Use the GitHub icon to open the matching BSP in esp-bsp (when available).

• ESP-BOX-3 esp32s3 , ili9341, 320x240, gt911, ES8311, ES7210, icm42670, aht30
• ESP-VoCat esp32s3 , st77916, 360x360, cst816s, ES8311, ES7210
• ESP32-C3-LCDKit esp32c3 , gc9a01, 240x240
• ESP32-P4-EYE esp32p4 , st7789, 240x240, OV2710
• ESP32-S3-EYE esp32s3 , st7789, 240x240, OV2640
• ESP32-S3-Korvo-2 esp32s3 , ili9341, 320x240, gt911, ES8311, ES7210, OV3660
• ESP32-S3-Korvo-2 esp32s3 , ili9341, 320x240, tt21100, ES8311, ES7210, OV3660
• ESP32-S3-LCD-EV-Board esp32s3 , 800x480, gt1151, ES8311, ES7210
• ESP32-S31-Korvo-1 esp32s31 , 800x480, gt1151, ES8389, OV3660
• M5Stack Tab5 esp32p4 , st7123, 720x1280, ES8388, ES7210, SC202CS, bmi270

The esp-bsp repository contains production-ready BSP packages for Espressif boards and M5Stack boards. Use them as reference or depend on them directly in your project:

The repository also includes detailed documentation in the docu/ folder (guides, API notes, and per-board README files). Browse bsp/, examples/, and SquareLine board packs. BSPs you generate here follow a similar layout but can target any custom hardware.