Welcome to Awesome Info Display, your open-source solution for creating customizable information displays on external ESP32 devices. With this project, you can easily set up a display to show various screens, such as current memory usage, currently played tracks, or weather information. Whether you're a hobbyist, a tinkerer, or a professional, this project offers flexibility and customization to meet your needs.
- 🖥️ Display various screens on an external ESP32 display.
- 📈 Supported screens include current memory usage, currently played track, and weather information.
- 🔌 Plugin support for custom written plugins with a mini api to request config fields, if necessary.
- 🗔 Works seamlessly on Windows, with plans for Linux and MacOS support in the future.
- https://www.lilygo.cc/products/t-display-s3?variant=42284559827125
- Teensy 4.0 based devices with a 256x64 OLED SSD 1322 (see https://github.com/daniel-prause/teensy-awesome-display)
To get started with Awesome Info Display, follow these simple steps:
-
Clone this repository: Clone this repository to your local machine using git clone https://github.com/daniel-prause/awesomeinfodisplay.git.
-
Install dependencies: Ensure you have all dependencies installed. This should be done automatically via cargo, if you build the project for the first time.
-
Clone the repository https://github.com/daniel-prause/companion-display. Compile and move the firmware to the ESP32.
-
Connect ESP32 display: Connect your ESP32 display to your Windows machine.
-
Run the application: Execute the application on your Windows machine. The display contents of the first available screen will be transferred to the external display, showcasing the currently active screen. You can switch to the next screen by pressing the pause button.
We welcome contributions from the community to help improve Awesome Info Display. Whether you're a developer, a designer, or just an enthusiast, there are many ways you can contribute:
- Report bugs or suggest features by opening an issue on GitHub.
- Submit pull requests to address issues or implement new features.
This project is licensed under the MIT license.
This project utilizes the following third-party components:
- Font Awesome - License information available here.
- Liberation Font - License information available on the project website.
Thank you for choosing Awesome Info Display. Let's build something amazing together! 🚀