Skip to content
pixelit-projectPublic

About

PixelIt is an ESP8266/ESP32 and WS2812B LED Matrix based PixelArt display

Topics

Resources

Stars

457 stars

Watchers

20 watching

Forks

Repository files navigation

PixelIt - The Matrix Display

GitHub Workflow Status (with event) GitHub all releases GitHub Repo stars GitHub commit activity (branch) GitHub commit activity (branch) GitHub top language

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 🚀

Project highlights

Getting started

  1. Choose your hardware and follow the setup documentation.
  2. Use the Webflasher and installation guide, or download the matching board image from GitHub Releases. For ESP32 USB installation, use the .full-upgrade.bin image; for WebUI OTA updates, use the application .bin without .full-upgrade.
  3. Complete WiFi setup, then open the device's IP address in your browser.
  4. 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.

Control and integrations

  • 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.

Bitmap animations

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.

Releases and development

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.

Contributors

Thanks to these great people for supporting this project.

o0shojo0o
o0shojo0o
foorschtbar
foorschtbar
miccgn
miccgn
rliegmann
rliegmann
jekader
jekader
Metaln00b
Metaln00b
pplucky
pplucky
fmunozs
fmunozs
rozza-m
rozza-m
Flolant
Flolant
hermannbach
hermannbach
d4rkd3v1l
d4rkd3v1l
hamster65
hamster65

WebUI

Videos

Disclaimer

* 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.

About

PixelIt is an ESP8266/ESP32 and WS2812B LED Matrix based PixelArt display

Topics

Resources

Stars

457 stars

Watchers

20 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages