Edit WiP message.

This commit is contained in:
Pieter Hollander 2024-07-26 20:05:20 +02:00
parent cc99b21759
commit 05596a8a64
Signed by: pieter
SSH key fingerprint: SHA256:HbX+9cBXsop9SuvL+mELd29sK+7DehFfdVweFVDtMSg

View file

@ -1,6 +1,6 @@
# Documentation
NB: This documentation page is a work-in-progress and unfinished at the moment of writing. The MQTT and ESPhome sections still need to be written. However, expert users may be able to figure these settings out themselves using the Mosquitto add-on documentation and [the ESPhome configuration available in the P1 logger git repo](https://git.hollander.online/energy/p1-logger/src/branch/main/esphome). A complete version will be released soon.
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, users with ESPHome experience should be able to figure these settings out themselves using [the ESPhome configuration available in the P1 logger git repo](https://git.hollander.online/energy/p1-logger/src/branch/main/esphome)
## Installation instructions
@ -91,7 +91,7 @@ Having setup the PostgreSQL / TimescaleDB database and Mosquitto MQTT broker, we
- If you're using Expaso's TimescaleDB add-on, the `db` setting will **not** require any changes.
- MQTT
- `mqtt_broker`:
- `mqtt_broker`:
- Default: `tcp://core-mosquitto:1883`.
- In case of using an external broker, use a syntax like `tls://mqtt.example.org:8883` or `tcp://mqtt.example.org:1883`
- `mqtt_topic`: `p1/metrics`