diff --git a/README.md b/README.md new file mode 100644 index 0000000..fbc5359 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Digital clock + +A home digital clock using [Adafruit 7 segment led](https://learn.adafruit.com/adafruit-7-segment-led-featherwings) and D1 mini ESP8266, that integrates with [Home Assistant](https://www.home-assistant.io/) by means of [ha-mqtt library](https://git.hodos.ro/libraries/ha-mqtt). + +### Supported features +- synchronize time using NTP client +- display time in current time zone, with configurable 12/24 hour format +- display date and day of the week +- change the brightness, from within Home Assistant or automatically based on the time of the day +- measure and display temperature and humidity due to the connected [BME280](https://www.bosch-sensortec.com/products/environmental-sensors/humidity-sensors-bme280/) sensor +- expose the temperature and humidity to Home Assistant +- custom timer configurable from Home Assistant