<img src=".github/logo.png" width="100px" height="100px" />

PixelIt - The Matrix Display

The PixelIt is an ESP8266/ESP32 and WS2812B-LED based PixelArt display, controlled and fed via a JSON API. Settings and small tests are possible via the web interface, also a Node-RED node (node-red-contrib-pixelit) for the JSON API is available.

If you want to get an impression of the WebUI, you can do that here in Demo WebUI :rocket:

• :memo: Documentation
• :green_heart: PixelIt Icon Gallery (in Demo WebUI)
• :bulb: GitHub Discussions (Forum)
• :speech_balloon: Telegram Channel
• :speech_balloon: Discord Channel

Project highlights

• :fire: Support for Node-RED, HomeAssistant and ioBroker
• :fire: Support for DIY Matrixes (ESP32/ESP8266) and prebuild Ulanzi TC001 Pixel Clock*
• :fire: Awesome WebUI for configuration and control. Checkout the Demo
• :fire: Great documentation
• :fire: Unlimited possibilities through the open API
• :fire: Helpful and welcoming community on Telegram, Discord and GitHub Discussions
• :fire: Showroom for your own PixelIt builds on the Show you PixelIt thread.

Contributors

Thanks to these great people for supporting this project.

<!-- readme: contributors -start --> <table> <tbody> <tr> <td align="center"> <a href="https://github.com/o0shojo0o"> <img src="https://avatars.githubusercontent.com/u/19333515?v=4" width="100;" alt="o0shojo0o"/> <br /> _{<b>o0shojo0o</b>} </a> </td> <td align="center"> <a href="https://github.com/foorschtbar"> <img src="https://avatars.githubusercontent.com/u/10727275?v=4" width="100;" alt="foorschtbar"/> <br /> _{<b>foorschtbar</b>} </a> </td> <td align="center"> <a href="https://github.com/miccgn"> <img src="https://avatars.githubusercontent.com/u/71180164?v=4" width="100;" alt="miccgn"/> <br /> _{<b>miccgn</b>} </a> </td> <td align="center"> <a href="https://github.com/rliegmann"> <img src="https://avatars.githubusercontent.com/u/16445478?v=4" width="100;" alt="rliegmann"/> <br /> _{<b>rliegmann</b>} </a> </td> <td align="center"> <a href="https://github.com/jekader"> <img src="https://avatars.githubusercontent.com/u/2088123?v=4" width="100;" alt="jekader"/> <br /> _{<b>jekader</b>} </a> </td> <td align="center"> <a href="https://github.com/Metaln00b"> <img src="https://avatars.githubusercontent.com/u/25951169?v=4" width="100;" alt="Metaln00b"/> <br /> _{<b>Metaln00b</b>} </a> </td> </tr> <tr> <td align="center"> <a href="https://github.com/pplucky"> <img src="https://avatars.githubusercontent.com/u/16407309?v=4" width="100;" alt="pplucky"/> <br /> _{<b>pplucky</b>} </a> </td> <td align="center"> <a href="https://github.com/fmunozs"> <img src="https://avatars.githubusercontent.com/u/1041604?v=4" width="100;" alt="fmunozs"/> <br /> _{<b>fmunozs</b>} </a> </td> <td align="center"> <a href="https://github.com/rozza-m"> <img src="https://avatars.githubusercontent.com/u/1784953?v=4" width="100;" alt="rozza-m"/> <br /> _{<b>rozza-m</b>} </a> </td> <td align="center"> <a href="https://github.com/Flolant"> <img src="https://avatars.githubusercontent.com/u/103022070?v=4" width="100;" alt="Flolant"/> <br /> _{<b>Flolant</b>} </a> </td> <td align="center"> <a href="https://github.com/hermannbach"> <img src="https://avatars.githubusercontent.com/u/6616722?v=4" width="100;" alt="hermannbach"/> <br /> _{<b>hermannbach</b>} </a> </td> <td align="center"> <a href="https://github.com/d4rkd3v1l"> <img src="https://avatars.githubusercontent.com/u/13336238?v=4" width="100;" alt="d4rkd3v1l"/> <br /> _{<b>d4rkd3v1l</b>} </a> </td> </tr> <tr> <td align="center"> <a href="https://github.com/hamster65"> <img src="https://avatars.githubusercontent.com/u/36369379?v=4" width="100;" alt="hamster65"/> <br /> _{<b>hamster65</b>} </a> </td> </tr> <tbody> </table> <!-- readme: contributors -end -->

WebUI

Videos

Changelog

<!-- ** WORK IN PROGRESS ** -->

2.5.5 (2025-04-24)

• (foorschtbar) Battery screen on boot can now be disabled
• (foorschtbar) Added autobrightness to API

2.5.3 (2024-10-09)

• (foorschtbar) Fixed ESP32 Battery Pin Definition
• (foorschtbar) Removed color convertion libary
• (o0shojo0o) Added compatibility check for configuration restore.

2.5.2 (2024-10-09)

• The version has been withdrawn.

2.5.1 (2024-04-07)

• (rliegmann) Fixed ESP32 Pin Definition
• (foorschtbar) Fixed build issue with MAX44009 lib

2.5.0 (2023-11-20)

• (foorschtbar) Fixes "MQTT message is to long" [#322]
• (o0shojo0o) Adjustments in the WebUI for the new API structure of the UserMap endpoint
• (o0shojo0o) Also now in the WebUI Improved check of new firmware through a real version comparison
• (o0shojo0o) Added config backup and restore to WebUI [#319]
• (o0shojo0o) Added Statistics to WebUI
• (jekader) Added large 8px non-bold clock font [#320]
• (foorschtbar) Made HomeAssistant service discovery configurable
• (foorschtbar) Added optional MQTT device topic (<Mastertopic>/<Hostname>/<commands>)

2.4.3 (2023-10-17)

• (foorschtbar) Native support for Ulanzi TC001 Pixel Clock* :tada:
• (foorschtbar) Display zZz on the matrix when the device going to sleep
• (foorschtbar) Fixed issue with flickering icons, wenn device wake from sleep mode
• (Metaln00b) Improved new firmware check by doing real version compare (major, minor, patch and prerelease)
• (o0shojo0o) As of this version, it is possible to install via the new webflasher
• (jekader) Remove duplication from platformio.ini [#315]
• (foorschtbar) MQTT/Websocket message interval for sensors and matrix info are now minimum 10 seconds to reduce "noise" on the network
• (foorschtbar) Added support for SHT31 sensor
• (foorschtbar) Log error if MQTT or Websocket messa