Skip to content

waveshareteam/Waveshare-ESP32-components

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Waveshare ESP32 Board Support Packages and Drivers

Welcome to the repository for Waveshare ESP32 products! This repository is designed to provide resources, drivers, and support packages for Waveshare's ESP32-based boards and compatible display modules. It aims to simplify development and accelerate your project setup.


πŸ“¦ Repository Contents

1. Board Support Packages (BSP)

Board supported
ESP32-P4-NANO
βœ…
ESP32-S3-Touch-AMOLED-1.8
πŸ•’
ESP32-S3-Touch-LCD-1.69
πŸ•’
ESP32-S3-LCD-1.69
πŸ•’
ESP32-S3-Touch-LCD-4
πŸ•’

2. Display Drivers

Product ID Dependency tested
2.8inch DSI LCD
waveshare/esp_lcd_dsi βœ…
3.4inch DSI LCD (C)
waveshare/esp_lcd_dsi βœ…
4inch DSI LCD (C)
waveshare/esp_lcd_dsi βœ…
4inch DSI LCD
waveshare/esp_lcd_dsi βœ…
5inch DSI LCD (D)
waveshare/esp_lcd_dsi βœ…
6.25inch DSI LCD
waveshare/esp_lcd_dsi βœ…
5inch DSI LCD (C)
waveshare/esp_lcd_dsi βœ…
7inch DSI LCD (C)
waveshare/esp_lcd_dsi βœ…
7.9inch DSI LCD
waveshare/esp_lcd_dsi βœ…
7inch DSI LCD (E)
waveshare/esp_lcd_dsi βœ…
8inch DSI LCD (C)
waveshare/esp_lcd_dsi βœ…
10.1inch DSI LCD (C)
waveshare/esp_lcd_dsi βœ…
8.8inch DSI LCD
waveshare/esp_lcd_dsi βœ…
11.9inch DSI LCD
waveshare/esp_lcd_dsi βœ…
:101M-8001280-IPS-CT-K
waveshare/esp_lcd_jd9365_10_1 βœ…

πŸ“š Documentation

Each library and support package comes with detailed documentation and examples. Key highlights include:

  • Initialization Guides: Step-by-step instructions for setting up your board and peripherals.
  • Examples:
    • The driver library code provides the simplest low-level drivers
    • BSP sample programs can be queried in different product wikis, and will be synchronized in the ESP32-display-support
  • Code Comments: Inline documentation for better understanding.

πŸš€ Getting Started

Prerequisites

  • Hardware:
    • Waveshare ESP32 boards
    • Supported display modules
    • Compatible touch controllers(Optional)
  • Software:
    • ESP-IDF(Each product has a recommended version on the wiki as well as sample routines)

🌟 Features

  • LVGL Support:
    • Widgets, animations, and custom UI components for Waveshare displays.
  • Optimized Drivers:
    • DMA and double buffering for smooth graphics.
  • Peripheral Utilities:
    • Simplified access to RTC, I/O expanders, and power management ICs.
  • Arduino-Compatible Libraries:
    • Easy porting of code using the Arduino ecosystem.

πŸ”§ Configuration

You can view some of the configurations that have been added via menuconfig, which will allow you to verify the functionality directly


πŸ“‚ Directory Structure

.
β”œβ”€β”€ bsp/           # Board support packages
β”œβ”€β”€ display/          # Display drivers
└── README.md         # Project overview (this file)

πŸ› οΈ Contributing

We welcome contributions! Here’s how you can help:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Commit your changes with clear descriptions.
  4. Submit a pull request for review.

🧩 Issues and Support

If you encounter any issues:

  • Check the Issues section.
  • Create a new issue with detailed information.
  • Refer to the documentation for troubleshooting tips.

πŸ“œ License

This repository is licensed under the Apache License License. See the LICENSE file for details.


πŸ™Œ Acknowledgments

  • Waveshare for their excellent hardware platforms and software support
  • The Espressif Team for their continuous support.
  • Open-source contributors who make these projects possible.

Thank you for using Waveshare-ESP32-components! πŸš€

About

waveshare componets For ESP Component Registry

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published