This tool polls live data from an E3/DC device cyclically and publishes them to a MQTT broker. The polling interval is adjustable.
Note: This is only a wrapper around the great python-e3dc library. Credits for the E3/DC part to the people over there!
Note: This is a very early stage of the project, documentation is not completed and the tool is not fully tested yet.
| Parameter name | Required | Description |
|---|---|---|
| loglevel | No | Minimum log level. Possible values: DEBUG, INFO, WARNING, ERROR, CRITICAL |
| interval | No | Interval in seconds in which E3/DC data is requested. Minimum: 1.0 |
| Parameter name | Required | Description |
|---|---|---|
| mqtt-broker | yes | Address of MQTT Broker to connect to |
| mqtt-port | no | Port of MQTT Broker. Default is 1883 (8883 for TLS) |
| mqtt-clientid | no | Id of the client. Default is a random id |
| mqtt-keepalive | no | Time between keep-alive messages |
| mqtt-username | no | Username for MQTT broker |
| mqtt-password | no | Password for MQTT broker |
| mqtt-basetopic | no | Base topic of mqtt messages |
| Parameter name | Required | Description |
|---|---|---|
| e3dc-host | yes | Address of the E3/DC device |
| e3dc-username | yes | Username for login on E3/DC device |
| e3dc-password | yes | Password for login on E3/DC device |
| e3dc-rscpkey | yes | RSCP key for login on E3/DC device. Must be set on device |
There is a docker image for this tool.
docker pull mdhom/e3dc-to-mqtt:latest
You can run the docker container using a docker-compose file like the following:
Make sure to replace the <> placeholders with your credentials!
version: '3.3'
services:
e3dc-to-mqtt:
image: "mdhom/e3dc-to-mqtt:latest"
restart: always
environment:
- MQTT_BROKER=<ip of your mqtt broker>
- E3DC_HOST=<ip of your e3dc device>
- E3DC_USERNAME=<username for e3dc>
- E3DC_PASSWORD=<password for e3dc>
- E3DC_RSCPKEY=<encryption key of your e3dc device>
- ADDITIONAL_PARAMETERS=--interval 5
This tool is also available for running via command line. The necessary parameters are passed via arguments.
If you want to use the latest release without cloning the source code, just run
pip install e3dc-to-mqtt
If you want to use the latest dev commits, you can install the package directly from source:
python3 -m pip install -e . --user
Make sure to run it from this projects main directory (containing setup.py).
To start the cli tool, just run
e3dc-to-mqtt --mqtt-broker *** --e3dc-host *** --e3dc-username *** --e3dc-password *** --e3dc-rscpkey ***
The tool will then start polling the data from the device and publish it to mqtt.
Instead of passing all parameters as args, you can pass a config json file:
e3dc-to-mqtt --configFile config.json
The file must be a valid json with the following content:
{
"mqttbroker": "xxx",
"e3dchost": "xxx",
"e3dcusername": "xxx",
"e3dcpassword": "xxx",
"e3dcrscpkey": "xxx"
}
- python-e3dc: Base library to connect to E3/DC device and poll live data from
- E3/DC: Website of the manufacturer