README.md

🦕 saur'pad

ESP32 based notification center for Home Assistant

main features

• displays sensor info from Home Assistant
• warning for preset conditions, see get_warning(unsigned long)
• warning for custom conditions
• support for custom warning sound and led blinking pattern (requires an SD card)
• credentials setup using hotspot web server
• ota updates using a web server (requires an SD card)

screenshots

main screen

warning pop-up

boot screen

setup screen

setup web interface

update screen

configuration and OTA update interface

setup

Home Assistant

• add MQTT integration and install Mosquitto broker
• setup credentials for Mosquitto broker
• enable MQTT Discovery
• import these automation blueprints

blueprints are configured to work with sensors, binary sensors, air quality and covers
additional devices can be added during import process
it is important to add the same devices in every template where asked to

blueprints

ESP32

• download firmware.bin from the releases page
• flash ESP32 with firmware.bin
• connect to Wi-Fi hotspot created by device and fill out credentials in the web interface
• additional configuration and OTA updates can be made on a web server hosted on device

custom warning conditions

• send a MQTT message on topic homeassistant/<device_id>/status formatted {"warning": "ON/OFF"}

custom audio/led pattern

• create a folder named saurpad on an SD card
• add audio files names <device_class>.mp3
• add text files names <device_class>.txt formatted:

<time in ms for action>,<r/g/b>

example

flashes each color for 1s with 0,5s breaks, then turn every color on for 0,5s

1000,r
500
1000,g
500
1000,b
500
500,rgb

• room audio files can be added in saurpad/rooms named <room_name>.mp3

Acknowledgments

• Status bar icons form Uicons by Flaticon
• Sauropod emoji from SerenityOS Emoji Font, Copyright (c) 2018-2023, the SerenityOS developers, Copyright (c) 2022-2023, Gegga Thor xexxa@serenityos.org - LICENSE
• Source Code Pro font from Google Fonts by Paul D. Hunt - SIL OPEN FONT LICENSE Version 1.1
• esp_panel_drivers_conf.h, esp_utils_conf.h, lvgl_v8_port.h, lvgl_v8_port.cpp and part of void setupdisplay() from ESP Display Panel by ESP Arduino Libs - Apache-2.0 license
• index.css partially reused from ios-rcs - MIT license
• config.hpp and begining of void sendtoclass(String, devices) generated using ArduinoJson Assistant
• UI created using EEZ Studio