ardkuijpers/dsmr2mqtt
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Ard Kuijpers
2023-02-12 14:33:13 +01:00
parent 1732181fbb
commit 5a9d08a611
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -7,16 +7,15 @@ This bridigng component reads Dutch Smart Meter Requirements (DSMR) telegrams an
* [DSMR Parser](https://github.com/ndokter/dsmr_parser) * [DSMR Parser](https://github.com/ndokter/dsmr_parser)
* [Homie4](https://github.com/mjcumming/homie4) * [Homie4](https://github.com/mjcumming/homie4)
![Works with Homie](https://homieiot.github.io/img/works-with-homie.png).
## Configuration ## Configuration
Create some environment variables (e.g. with a .env file) to specify the required settings: Create some environment variables (e.g. with a .env file) to specify the required settings:
```bash ```bash
PYTHONPATH="." PYTHONPATH="."
MQTT_HOST=mqtt.local MQTT_HOST=<mqtt-broker-hostname>
DSMR_PORT=/dev/ttyUSB0 DSMR_PORT=/dev/ttyUSB0
DSMR_PROTOCOL=V5
``` ```
If you have forwared the raw serial signal through ser2net, you should use `DSMR_PORT=remote://<hostname>:<port>`, e.g.: If you have forwared the raw serial signal through ser2net, you should use `DSMR_PORT=remote://<hostname>:<port>`, e.g.:
@@ -29,5 +28,9 @@ If you use credentials to access the MQTT broker, then alsp specify:
```bash ```bash
MQTT_USERNAME=<mqtt-user> MQTT_USERNAME=<mqtt-user>
MQTT_PASSWORD=<mqtt_passwrd> 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)

2
app_settings.py
View File

@@ -5,7 +5,7 @@ VERSION = "0.1.1"
class Settings(BaseSettings): class Settings(BaseSettings):
"""Application settings for the DSMR MQTT bridge.""" """Application settings for the DSMR 2 MQTT bridge."""
loglevel: str = Field('INFO', env='LOGLEVEL') loglevel: str = Field('INFO', env='LOGLEVEL')