energy/home-assistant-addons
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Small clarification of setup steps.

Browse source
This commit is contained in:
Pieter Hollander 2024-07-27 01:11:46 +02:00
parent f746db6690
commit 4a70a5174a
Signed by: pieter
SSH key fingerprint: SHA256:HbX+9cBXsop9SuvL+mELd29sK+7DehFfdVweFVDtMSg
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
p1-logger/DOCS.md
View file

@ -1,16 +1,16 @@
# Documentation # Documentation
NB: This documentation page is a work-in-progress and unfinished at the moment of writing. The ESPhome section still needs to be written. However, experienced ESPHome users should be able to figure the configuration out themselves using [the ESPhome configuration available in the P1 logger git repo](https://git.hollander.online/energy/p1-logger/src/branch/main/esphome) and the brief explanation below. NB: This documentation page is a work-in-progress at the moment of writing. The ESPhome section still needs to be written in a beginner-friendly way. However, experienced ESPHome users should be able to figure the configuration out themselves using [the ESPhome configuration available in the P1 logger git repo](https://git.hollander.online/energy/p1-logger/src/branch/main/esphome) and the details provided below.
## Installation instructions ## Installation instructions
These instructions contain 5 steps: These instructions contain 5 steps:
1. This add-on requires a PostgreSQL database, optionally with TimescaleDB support. In this example, we'll Expaso's TimescaleDB add-on in order to store data. 1. This add-on requires a PostgreSQL database, optionally with TimescaleDB support. In this example, we'll Expaso's TimescaleDB add-on in order to store data.
2. Install and setup the Mosquitto MQTT broker from the official add-ons repository. 2. Secondly, we install and setup the Mosquitto MQTT broker from the official add-ons repository. MQTT is a standard used to exchange IoT data.
3. Install and setup ESPhome to commission a P1 reader. 3. Thirdly, we setup ESPhome to commission a P1 reader, which will send P1 meter messages to the MQTT Broker.
4. Install P1 Logger to connect to a P1 reader through the MQTT broker and record data into the database. 4. Then, we setup P1 Logger (this add-on) to monitor the MQTT broker for new messages and record data into the database.
5. Finally, we setup Grafana to visualise the data recorded by P1 Logger. 5. Finally, we setup Grafana to visualise the data recorded in the database.
### Install Expaso's TimescaleDB add-on ### Install Expaso's TimescaleDB add-on