From 4a70a5174a925234d586003070e4882277331666 Mon Sep 17 00:00:00 2001 From: Pieter Hollander Date: Sat, 27 Jul 2024 01:11:46 +0200 Subject: [PATCH] Small clarification of setup steps. --- p1-logger/DOCS.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/p1-logger/DOCS.md b/p1-logger/DOCS.md index 8fcab15..88e8925 100644 --- a/p1-logger/DOCS.md +++ b/p1-logger/DOCS.md @@ -1,16 +1,16 @@ # 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 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. -2. Install and setup the Mosquitto MQTT broker from the official add-ons repository. -3. Install and setup ESPhome to commission a P1 reader. -4. Install P1 Logger to connect to a P1 reader through the MQTT broker and record data into the database. -5. Finally, we setup Grafana to visualise the data recorded by P1 Logger. +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. Thirdly, we setup ESPhome to commission a P1 reader, which will send P1 meter messages to the MQTT Broker. +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 in the database. ### Install Expaso's TimescaleDB add-on