Awesome

Home Assistant Glow 🌟

Project Maintenance

During my internship at Nabu Casa in the first half of 2021, I focused on energy management for your house, how to collect all energy data and display it on a dashboard. Since Home Assistant release 2021.8 it's possible to use the Home Assistant Energy dashboard to display your energy usage. Unfortunately, not everyone has a smart meter and/or is equipped with a P1 port. This is where the Home Assistant Glow comes in!

<img width="80%" src="docs/static/img/home-assistant-glow.jpg"> <details> <summary>CLICK HERE! To see the Home Assistant Glow in action.</summary> <img src="assets/images/glow_sensor_testing.gif" alt="Glow testing" width="40%"/><img src="assets/images/glow_in_action.gif" alt="Glow in action" width="40%"/> </details>

Home Assistant Glow makes a (not so) smart meter without a P1 port easily readable, reading the pulse LED that is always present in most cases and it works with ESPHome! To neatly hide it all in your meter cupboard, a case has been designed that you can 3D print yourself.

How do I know if my meter is supported?

To make sure your meter will work with the Home Assistant Glow, you have to look for the imp/kWh rate on your meter (see picture). Make a note of this value because you may need it later when configuring your device.

Getting Started

[!IMPORTANT] Please note, the default branch shows development and may be ahead of the released version. For copying YAML code, use the release branch. It's best to use the website to install the latest firmware on your ESP.

On the documentation website you will find a complete walkthrough with which hardware you need, how to install the correct firmware on your ESP (using esp web tools) and how to add it to Home Assistant.

Hardware

First, fill your 🛒 or see if you already have the components below.

Choose one of the listed microcontrollers, but keep in mind that the ESP32 is recommended.

ESP32 (recommended) - AliExpress or Banggood or AliExpress
ESP8266 - AliExpress or Banggood or AliExpress
Dupont Jumpers (female to male) - AliExpress or Banggood
3D-printed case (see the case folder)
LM393 Photodiode: AliExpress or Banggood or AliExpress (please note that you will not receive an LDR)
LED RGB 5mm 4 pin - kathode: AliExpress or Banggood or AliExpress

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Disclamer

Affiliate links are used on this repository to support the Home Assistant Glow 🌟 project. Some Ad-blockers might block these links and thus they seem to appear broken. You will have to temporarily disable ad-blocker to open these links.

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.