repository·main·Indexed 25 days ago
https://github.com/blueforcer/awtrix3An open-source ESP32-based firmware for pixel matrix clocks, such as the Ulanzi TC001, that functions as a visual dashboard for smart home data via MQTT and HTTP APIs. The project includes support for CustomApps, which act as dynamic display pages driven by external logic, and integrates various libraries including ArduinoHA for Home Assistant integration, DFMiniMp3 for MP3 module control, and MeanFilter/MedianFilter for data processing.
The DFMiniMp3 library is designed to control the DFPlayer Mini MP3 module within Arduino projects.
Key features include:
Important: Before connecting your module, review the official hardware documentation to avoid errors: DFRobot's DFPlayer Mini Mp3 Wiki
AWTRIX 3 is an open-source custom firmware designed for the Ulanzi Smart Pixel clock TC001, the older AWTRIX 2 Mainboard, or self-built matrix clocks.
Key Requirements & Compatibility:
Out of the box, it includes pre-installed pages for time, date, temperature, and humidity. Advanced users can extend functionality using CustomApps via MQTT or HTTP APIs.
The TJpg_Decoder library is an Arduino library designed to render JPEG files onto a TFT display. It supports loading images from several sources:
The library uses the highly optimized TJpgDec decompressor engine.
ArduinoHA is a library designed to integrate Arduino or ESP-based devices (such as ESP8266/ESP8255) with Home Assistant via MQTT. It is optimized for low resource consumption (RAM/flash) and is compatible with hardware ranging from Arduino Uno with Ethernet Shields to ESP-based boards.
Key capabilities include:
The ArduinoHA library allows you to integrate Arduino or ESP-based hardware with Home Assistant using the MQTT protocol. It is designed for low resource consumption (RAM/flash) and supports two-way communication: reporting device states to Home Assistant and executing commands received from Home Assistant.
Key features include:
The web interface provides several configuration sections for initial setup and ongoing management:
.bin file from the AWTRIX 3 release section.MedianFilter library implements a moving median filter for Arduino. It stores the last N elements of a window and calculates the median value. The library uses C++ templates, allowing it to work with various data types such as int, long, and float.MeanFilter library implements a moving average filter for Arduino. It maintains a circular buffer of the last N elements to calculate the mean, ensuring high efficiency. The library uses C++ templates, allowing it to work with various data types such as int, long, and float.The library automates the connection to the MQTT broker and the Home Assistant discovery process. When you create device types (such as sensors, switches, lights, or fans), they are automatically registered in the MQTT manager. Once a connection to the MQTT broker is established, the configuration for all registered device types is pushed to Home Assistant.
Crucial Requirement: To ensure device types can access the internal MQTT instance, you must construct your device types after the HAMqtt class has been instantiated.
A Device type represents a single entity within the Home Assistant panel (e.g., a sensor, lock, or camera).
A single physical device (such as an ESP-01 board) can have multiple device types assigned to it. In the Home Assistant interface, these assigned types will appear as child entities belonging to the main physical device.
To implement business logic using the Home Assistant integration, you must follow these initialization and lifecycle rules:
HADevice and HAMqtt instances must be initialized once globally or as part of another global object.HAMqtt::begin at the end of your setup() logic. This method provides the MQTT broker credentials used for the connection.HAMqtt::loop() method periodically within your main loop (it does not need to be called on every single tick).HAMqtt class.