From fcf037045cd3dfba5e1677e0af77706ccf88041b Mon Sep 17 00:00:00 2001 From: Madelena Mak Date: Mon, 27 Jun 2022 21:09:18 -0700 Subject: [PATCH] Update README.md --- README.md | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d5b733b..27c74ce 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ -# esphome-weatherman-dashboard -A simple dashboard with weather and NYC subway information for ESPHome +# Weatherman Dashboard for ESPHome + +I have multiple dashboards around my apartment and they display different information depending on the context. Since this is placed near the front door, it contains concise information for what's outside with a homey style to match the rest of the wall. + +This is part of the ecosystem for [my Home Assistant configuration](https://github.com/Madelena/hass-config-public). + +## Hardware + +- [Waveshare 7.5" e-Paper Screen](https://amzn.to/3brxxl3) - 640x384 display resolution +- [Waveshare Universal e-Paper Driver Board with ESP32](https://amzn.to/3nkMRT8) +- [Ikea RIBBA Picture Frame 5"x7"](https://amzn.to/3QM3Zip) +- [Legrand 3 Way Switch + USB](https://amzn.to/3u7EKNz) +- [Micro USB Thin Ribbon Cable](https://amzn.to/3AatofQ) +- [Angled USB Thin Ribbon Cable](https://amzn.to/3blAhQT) + +## Installation + +1. No soldering is required since the e-Paper driver board was integrated into the ESP32 board. All I needed to do was to connect the e-Paper screen to the driver board, and then connect the driver board to the USB socket on my light switch. +2. Copy `/fonts`, `/images`, and `weatherman.yaml` to your /.config/esphome folder. +3. Add the content of `templates.yaml` to your Home Assistant template configuration YAML file. +3. Once booted, flash `weatherman.yaml` the ESP32 board using ESPHome. +4. Enjoy! + +## Data Sources + +- Metno Hourly Weather Forecast +- Goodservice.io API + +## References + +Here are some other repos that I referenced from: +- https://github.com/DeastinY/esphome-waveshare-e-paper-dashboard +- https://github.com/savikko/smarthome + + + +*Weatherman* is a reference to the song *Blame it on the Weatherman* by B*Witched. If you're late to your date because of this, blame it on the Weatherman.