Skip to content

Commit

Permalink
update Readme.md (#72)
Browse files Browse the repository at this point in the history
* update Readme.md

* Update Readme.md #committing suggestions

adding the suggestions you provided πŸ‘πŸ½

Co-authored-by: Klaas Schoute <[email protected]>

* Update Readme.md #committing suggestions -2

Co-authored-by: Klaas Schoute <[email protected]>

* Update Readme.md 

I believe this resolves all the changes you requested for .... thank you for letting me contribute to your project ....hopefully next year i'll make a more valuable contributionπŸ€žπŸ½πŸ€žπŸ½πŸ˜„

* Update Readme.md

Co-authored-by: Klaas Schoute <[email protected]>

* Update Readme.md

Co-authored-by: Klaas Schoute <[email protected]>
  • Loading branch information
PranavKrishnan007 and klaasnicolaas authored Oct 26, 2021
1 parent 8f9a669 commit 62526e2
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Home Assistant Glow 🌟
# Home Assistant Glow 🌟

<!-- PROJECT SHIELDS -->
![Project Maintenance][maintenance-shield]
Expand All @@ -11,7 +11,7 @@
[![GitHub Last Commit][last-commit-shield]][commits]
[![Contributors][contributors-shield]][contributors-url]

During my internship at [Nabu Casa][nc] in the first half of 2021, I focused on energy management in your house and how you can collect all energy data and display it in a dashboard. From core release **2021.8** you can now also get started with the [energy dashboard][energy] in Home Assistant!
During my internship at [Nabu Casa][nc] in the first half of 2021, I focused on energy management in homes and how to collect all energy data and display it on a dashboard. From core release **2021.8** you can now also get started with the [energy dashboard][energy] in Home Assistant!

<p align="center">
<img width="80%" src="images/home-assistant-glow.jpg">
Expand All @@ -25,11 +25,11 @@ During my internship at [Nabu Casa][nc] in the first half of 2021, I focused on
</p>
</details>

Home Assistant Glow makes it possible to read a (not so) smart meter that is not equipped with a P1 port, reading the pulse LED that is always present in most cases and it works with [ESPHome][esphome]! To neatly hide it all in your meter cupboard, a case has been designed that you can 3D print yourself.
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][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
### 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 (see picture). Make a note of it, because you will need this value at a later stage to configure the yaml file.
To make sure your meter will work with the Home Assistant Glow, you have to look for the **imp/kWh** rate (see picture). Note the value, because it will be of importance at a later stage to configure the `.yaml` file.

<p align="center">
<img width="60%" src="images/pulse_rate.png">
Expand All @@ -43,7 +43,7 @@ First, fill your πŸ›’ or see if you already have the components below.
- [Dupont Jumpers](https://banggood.app.link/It6c1WPIgib)
- 3D printed case (see the [case](/case) folder)
- Photodiode - [Banggood](https://banggood.app.link/2OqdFiWIgib) or [AliExpress](https://nl.aliexpress.com/item/1005001640685908.html) (make sure that you do not accidentally order or receive an LDR)
- [LED RGB 5mm 4 pin kathode](https://banggood.app.link/cmAcKpuKgib)
- [LED RGB 5mm 4 pin - kathode](https://banggood.app.link/cmAcKpuKgib)

### Diagrams

Expand Down Expand Up @@ -73,11 +73,11 @@ How the status led is connected to the ESP32. For each measured pulse, the LED w

## Get started

Once you've connected all the hardware, we'll get started with the configuration for ESPHome. In this repository you will find the file [home_assistant_glow.yaml][file], which you can copy into the `esphome` folder of your Home Assistant config. Adjust the value `pulse_rate` under **substitutions** to the value on your meter ([how do I find my imp/kWh rate?](#how-do-i-know-if-my-meter-is-supported)), by default the value `1000` is used in the yaml file. Finally go through the installation wizard of ESPHome and flash the ESP32/8266.
Once you are done connecting all the hardware, we'll get started with the configuration for ESPHome. In this repository you will find the file [home_assistant_glow.yaml][file], which you can copy into the `esphome` folder of your Home Assistant config. Adjust the value `pulse_rate` under **substitutions** to the value on your meter ([how do I find my imp/kWh rate?](#how-do-i-know-if-my-meter-is-supported)), by default the value is `1000` in the yaml file. Finally go through the installation wizard of ESPHome and flash the ESP32/8266.

## FAQ

The answers to the most common problems raised in the issues.
Anwers to some of the most frequently asked questions:

### Wrong soldered diode

Expand Down

0 comments on commit 62526e2

Please sign in to comment.