PixelIt turns an ESP8266/ESP32 with a WS2812B LED matrix or an Ulanzi TC001 into a pixel art display for images, animations, scrolling text and clocks. Control it through the WebUI, HTTP JSON API, MQTT or WebSocket, or connect it to Node-RED, Home Assistant and ioBroker.
If you want to get an impression of the WebUI, you can do that here in Demo WebUI 🚀
- 📝 Documentation
- 💚 PixelIt Icon Gallery (in Demo WebUI)
- 💡 GitHub Discussions (Forum)
- 💬 Telegram Channel
- 💬 Discord Channel
- 🔥 Support for Node-RED, HomeAssistant and ioBroker
- 🔥 Support for DIY matrices (ESP32/ESP8266) and prebuilt Ulanzi TC001 Pixel Clock*
- 🔥 Awesome WebUI for configuration and control. Check out the Demo
- 🔥 Great documentation
- 🔥 Unlimited possibilities through the open API
- 🔥 Helpful and welcoming community on Telegram, Discord and GitHub Discussions
- 🔥 Showroom for your own PixelIt builds on the Show your PixelIt thread.
- Choose your hardware and follow the setup documentation.
- Use the Webflasher and installation guide, or download the matching board image from GitHub Releases.
For ESP32 USB installation, use the
.full-upgrade.binimage; for WebUI OTA updates, use the application.binwithout.full-upgrade. - Complete WiFi setup, then open the device's IP address in your browser.
- Configure the display in the WebUI, browse the icon gallery, or create your own bitmaps and animations in Pixel Creator.
Firmware builds are available for ESP8266 generic, D1 mini and NodeMCU v2, and ESP32 generic, D1 mini32 and Ulanzi TC001. Choose the image for your exact board.
- WebUI: device settings, live preview, icon gallery, bitmap and animation editor, configuration backup and firmware updates.
- HTTP, MQTT and WebSocket: send screens, text, bitmaps and animations through the JSON API.
- Home Assistant: use the custom integration for direct WebSocket control, playlists and a liveview card, or enable firmware MQTT discovery for display, text, clock, sensor and button entities. See the MQTT discovery reference for setup and topic details.
- Node-RED: build display flows with node-red-contrib-pixelit.
- ioBroker: connect through the PixelIt adapter.
Screen transitions, an automatic clock fallback and ambient-light brightness control are configurable; sensors and physical buttons depend on the installed hardware.
Since firmware 3.0.0, animation capacity depends on the device:
| Frame size (width × height) | ESP8266 maximum frames | ESP32 maximum frames |
|---|---|---|
| 8×8 | 28 | 160 |
| 32×8 (full display) | 7 | 40 |
These limits apply to HTTP, MQTT and WebUI uploads. Payload size and available memory can further limit uploads. See animation usage and examples for the JSON format, transport limits and playback diagnostics.
Use GitHub Releases for stable firmware and the changelog for version-specific changes. The optional beta update channel is disabled by default. This branch can contain unreleased changes; the optional sleep-animation setting is currently unreleased.
When upgrading from firmware before 3.0.0 with Home Assistant MQTT discovery,
device topics are now always enabled. Availability automations that previously
used the master topic must use <master>/<hostname>/state.
- Build and test instructions
- Firmware source (this repository)
- WebUI source
- User documentation source
- Bitmap API service
Thanks to these great people for supporting this project.
|
o0shojo0o |
foorschtbar |
miccgn |
rliegmann |
jekader |
Metaln00b |
|
pplucky |
fmunozs |
rozza-m |
Flolant |
hermannbach |
d4rkd3v1l |
|
hamster65 |
* This link and some others in the documentation are affiliate links. We would be happy if you use this link, but of course you don't have to.