Update DSMR Reader documentation (#14912)

Add some additional information and steps how to setup up the MQTT topics.
This commit is contained in:
Gerard 2020-10-05 09:56:18 +02:00 committed by GitHub
parent 4e41bb6d8b
commit fb481cd2f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,6 +3,7 @@ title: DSMR Reader
description: Instructions on how to integrate DSMR Reader.
ha_category:
- Energy
- Sensor
ha_iot_class: Cloud Polling
ha_release: 0.103
ha_codeowners:
@ -10,15 +11,25 @@ ha_codeowners:
ha_domain: dsmr_reader
---
The `dsmr_reader` sensor platform allows you to easily add all sensors that [DSMR Reader](https://dsmr-reader.readthedocs.io/en/latest/) exposes to MQTT. It adds a separate sensor for every field in the MQTT topics.
The `dsmr_reader` sensor integration allows you to easily add all sensors that [DSMR Reader](https://dsmr-reader.readthedocs.io/en/latest/) (Dutch Smart Meter Requirements Reader) exposes to MQTT. It adds a separate sensor for every field in the MQTT topics which is named `sensor_dsmr_<mqtt_topic>`.
## Prerequisites
- DSMR Reader
- MQTT broker
## Setup
To use this component, you will need DSMR Reader to be set up to publish to the MQTT server, that Home Assistant also uses. It is important that you setup DSMR Reader to publish to MQTT using "Split Topic" and that you use the default mappings.
1. Configure the MQTT broker in DSMR Reader which Home Assistant also connects to
2. Enable the following data sources in DSMR Reader with the default mapping:
- Day consumption: Split topic
- Gas consumption: Split topic
- Meter Statistics: Split topic
- Telegram: Split topic
## Configuration
To use this sensor in your installation, add the following to your `configuration.yaml` file:
To use this integration in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry