Updated docs
This commit is contained in:
11
README.md
11
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)
|
||||
|
||||
.
|
||||
|
||||
## Configuration
|
||||
|
||||
Create some environment variables (e.g. with a .env file) to specify the required settings:
|
||||
|
||||
```bash
|
||||
PYTHONPATH="."
|
||||
MQTT_HOST=mqtt.local
|
||||
MQTT_HOST=<mqtt-broker-hostname>
|
||||
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.:
|
||||
@@ -29,5 +28,9 @@ If you use credentials to access the MQTT broker, then alsp specify:
|
||||
|
||||
```bash
|
||||
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.
|
||||
|
||||

|
||||
|
||||
Reference in New Issue
Block a user