From 5a9d08a611f7e8c3d0154d628ddb59a4a3e66b2c Mon Sep 17 00:00:00 2001 From: Ard Kuijpers Date: Sun, 12 Feb 2023 14:33:13 +0100 Subject: [PATCH] Updated docs --- README.md | 11 +++++++---- app_settings.py | 2 +- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 357d113..a0ac6c5 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,15 @@ This bridigng component reads Dutch Smart Meter Requirements (DSMR) telegrams an * [DSMR Parser](https://github.com/ndokter/dsmr_parser) * [Homie4](https://github.com/mjcumming/homie4) -![Works with Homie](https://homieiot.github.io/img/works-with-homie.png). - ## Configuration Create some environment variables (e.g. with a .env file) to specify the required settings: ```bash PYTHONPATH="." -MQTT_HOST=mqtt.local +MQTT_HOST= DSMR_PORT=/dev/ttyUSB0 +DSMR_PROTOCOL=V5 ``` If you have forwared the raw serial signal through ser2net, you should use `DSMR_PORT=remote://:`, e.g.: @@ -29,5 +28,9 @@ If you use credentials to access the MQTT broker, then alsp specify: ```bash MQTT_USERNAME= -MQTT_PASSWORD= +MQTT_PASSWORD= ``` + +Inspect the source [`app_settings.py`](app_settings.py) to find out about the other less frequently used settings. + +![Works with Homie](https://homieiot.github.io/img/works-with-homie.png) diff --git a/app_settings.py b/app_settings.py index 5544a7b..74be225 100644 --- a/app_settings.py +++ b/app_settings.py @@ -5,7 +5,7 @@ VERSION = "0.1.1" class Settings(BaseSettings): - """Application settings for the DSMR MQTT bridge.""" + """Application settings for the DSMR 2 MQTT bridge.""" loglevel: str = Field('INFO', env='LOGLEVEL')