DigitalSTROM MQTT

This application allows you to set and react to any DigitalSTROM devices using MQTT.

You can set the output values using the command topic and get the current value using the state topic.

See Migration from V1.x to V2.x

DigitalSTROM system is built upon scenes. You press a button, and a scene starts. The scene can trigger as many output devices as you want. While this is fine for a standalone system, it’s really difficult to integrate with a more complex automation system. Basically, if you want the master of your automation to be an external system, you will have a bad time.

DigitalSTROM provides a REST api, but it’s not that easy to use since the structures of the element can be quite complex. There is also a notification endpoint that uses websocket to alert you of any value change. This app uses latest version of the REST API and the notification endpoint to provide a simple MQTT interface.

Currently, digitalSTROM integrations with home automation systems are rare and sometimes limited. The intent of this app is to solve this issue as all of them support MQTT.

The main goal of this application is to have direct access to the output devices (light, blinds,...) and be notified when something changes. All of this using MQTT as it’s widely used in home automation systems.

This application will not reflect the internal functioning of digitalSTROM. It will rather try to make an abstraction of it.

This app use the Smarthome API from digitalSTROM. It doesn't use the old json/device/ api. The documentation is sometimes lacking, some information where found on forum and discussion groups. Accuracy may not be the best but that's all we have.

You have two ways of configuring the app. Either using a config.yaml file next to the executable or with environment variables.

The meterings module polls api/v1/apartment/meterings/values periodically. Large digitalSTROM installations can return large payloads for this endpoint, so the default 10 second interval may create noticeable baseline network traffic. Set METERINGS_ENABLED=false if you do not need MQTT/HA energy and power sensors, or increase METERINGS_INTERVAL_SECONDS if slower updates are acceptable.

There is a build-in tool to get the API key. You can run it with the following command:

./digitalstrom-mqtt -mode=get-api-key -host 192.168.1.x -username=dssadmin -password=XXX

Just copy the API key spilled out in the console in your config file. Be sure to save the key, you want be able to see it again and you will have to create another key. The key will then be visible in the digitalSTROM web api under System -> Access Authorization. You can also remove it from there if you want to.

To see all available option, you can do:

./digitalstrom-mqtt -h

From docker you can run this:

docker run --rm gaetancollaud/digitalstrom-mqtt -mode=get-api-key -host 192.168.1.x -username=dssadmin -password=XXX

config.yaml

DIGITALSTROM_HOST: 192.168.1.x
DIGITALSTROM_API_KEY: XXX
MQTT_URL: tcp://192.168.1.X:1883

The topic format is as follows for the devices:

{prefix}/devices/{deviceName}/{channel}/{commandState}

The topic format is as follows for the meterings:

{prefix}/meterings/{deviceName}/{channel}/state

The topic format is as follows for the scene events (only with SCENES_ENABLED=true):

{prefix}/scenes/{zoneName}/{sceneName}/event

The topic and payload are the same as in version 1.x, but only callScene events are published (buttonClick and model_ready are not), and +, # and / in names are replaced by _. Scene calls are not part of the Smarthome API, so they are read from the legacy JSON API of the dSS.

The server status topic is

{prefix}/server/status

Go to Releases, download and unzip the latest version for your OS. Create the config file as shown above.

Start the executable

./digitalstrom-mqtt

docker run \
  -e DIGITALSTROM_HOST=192.168.1.x \
  -e DIGITALSTROM_API_KEY=XXX \
  -e MQTT_URL=tcp://192.168.1.X:1883 \
  gaetancollaud/digitalstrom-mqtt

This repository contains a native Home Assistant App package in home-assistant-app. It keeps the existing MQTT Discovery integration, so devices appear automatically after the App connects. The package is an unofficial community App and is not provided or supported by digitalSTROM.

The App is available for Home Assistant OS. Add this repository in Settings -> Apps -> App Store -> Repositories, then install digitalSTROM MQTT. For a first setup, follow the beginner guide in English or Deutsch. The detailed App documentation is also available in English and Deutsch.

• Home Assistant
• OpenHAB

We recommend using https://mqtt-explorer.com/ if you want a simple interface for MQTT.

digitalstrom/devices/DEVICE_NAME/brightness/state
digitalstrom/devices/DEVICE_NAME/brightness/command

digitalstrom/devices/DEVICE_NAME/shadePositionOutside/state
digitalstrom/devices/DEVICE_NAME/shadePositionOutside/command
digitalstrom/devices/DEVICE_NAME/shadeOpeningAngleOutside/state
digitalstrom/devices/DEVICE_NAME/shadeOpeningAngleOutside/command

digitalstrom/meterings/chambres/consumptionW/state
digitalstrom/meterings/chambres/energyWs/state

The dSS apartment status exposes weather measurements as one apartment-wide source, including when multiple weather stations are configured.

digitalstrom/weather_station_sensors/ds_weather/temperature/state
digitalstrom/weather_station_sensors/ds_weather/illuminance/state
digitalstrom/weather_station_sensors/ds_weather/wind_speed_10min_average/state
digitalstrom/weather_station_sensors/ds_weather/wind_gust/state
digitalstrom/weather_station_sensors/ds_weather/rain/state

digitalSTROM-MQTT was tested successfully with these devices:

• dSM12
• dSS20
• GE-KM200
• GE-TKM210
• GE-UMV200 (see #22)
• GE-KL200 (see #23)
• SW-TKM200
• SW-TKM210
• GR-KL200
• GR-KL210
• GR-KL220
• GN-KM200 (see #21)
• dS-Weather (tested with the Theben version)

Some devices are known to have issues or limitations:

• BL-KM300 ( see #7 #19)

Feel free to create an issue or to directly edit this file if you have tested this software with your devices.

See CONTRIBUTING.md