podpalch/ha-devi-mqtt repository overview

⁠Home Assistant MQTT Danfoss Binding

This is Home Assistant service for DeviReg Smart thermostats. Main idea behind - integration with Home Assistant via MQTT by auto discovery (not as HA addon or HACS integration). Around 50 sensors are implemented and can be used in Home Assistant.

⁠Supported Things

• DeviReg(tm) Smart floor thermostat (supported, tested https://www.devismart.com/⁠)
• Danfoss Icon controller (unsupported, requires real device to implement)
• Danfoss Icon room (unsupported, requires real device to implement)

If you have Icon device and know Java a little bit - you can fork and implement it by yourself.

⁠Installation and supported architectures

Relies on OpenSDG library (https://github.com/Sonic-Amiga/opensdg/releases⁠) for communicating with the hardware. The final JAR includes all dependencies compiled in and is ready to use without installing any other dependencies. Tested on Linux, MacOS, but should work fine on Windows as well. Docker image is also available.

⁠Discovery

Discovery of configuration is required step to use the software. Thermostat is using cloud security and requires setup/pairing by OTP code entry. As it's required user input, it can't be done in Docker.

To pair the software with the thermostat, you need mobile application paired with the thermostat. In mobile application, you have to go to Settings -> Share house -> Generate OTP.

Steps:

1. Run the discovery tool, follow the instructions from app.

java -cp ha-devi-mqtt.jar io.homeassistant.devi.mqtt.service.DiscoveryService

1. Launch mobile application, enter username and OTP code (it might be required to enter OTP more then once, due to bug in library).
2. The configuration file will be generated (devi_config.json).
3. Keep the configuration file in secure place, it contains private key required to control your device.

⁠Runtime

Two options how to start is available.

1. Plain Java

java -cp target/ha-devi-mqtt.jar io.homeassistant.devi.mqtt.service.ConsoleRunner --auto-discovery-templates auto-discovery-templates --mqtt-config mqtt_config.json --devi-config devi_config.json

1. Docker (linux/amd64, linux/arm64/v8 - Mac M1)

docker run -it --rm -v $(pwd)/devi_config.json:/app/config/devi_config.json -v $(pwd)/mqtt_config.json:/app/config/mqtt_config.json -v $(pwd)/auto-discovery-templates:/app/config/auto-discovery-templates  podpalch/ha-devi-mqtt

⁠Configuration

⁠devi_config.json (this file is generated by discovery tool)

{
  "peerId": "Peer ID, also known as Public key. All devices on the Grid are identified by these keys",
  "privateKey": "hex coded private key",
  "houseName": "name of the house (not used anywhere in code)",
  "rooms": [
    {
      "serialNumber": "(int) serial number (used to build MQTT topic path)",
      "devicePeerID": "peer id of the thermostat",
      "name": "name of the room (not used anywhere in code, device is bound to room)"
    }
  ],
  "userName": "unique username, that was entered during the pairing"
}

⁠mqtt_config.json

{
  "host": "IP or hostname of the MQTT broker",
  "port": "1883",
  "user": "mqtt-user",
  "password": "mqtt-password"
}

⁠Schedule editing component

I've built simple lovelace Card to edit weekly schedule for this thermostat. It's available here: https://github.com/igor-podpalchenko/ha-weekly-schedule-card⁠

type: custom:weekly-schedule-card
entity: sensor.devi_sensor_week_schedule_0
devMode: false
encodingSchema: Devi
commandTopic: devi/command/10159384/sensor_week_schedule

⁠Climate lovelace card

• Mode: used only to display state. Off / Heat - corresponds to relay state.
• Presets: displays current mode, option "SET OVERRIDE" is used to switch to OVERRIDE mode (Temporary Setpoint is used to set target temperature).
• Temperature slider: used to set target temperature (Temporary Setpoint).

Note: thermostat has a plenty of modes, every mode has it's own temperature setpoint. Override mode sets temperature till the end of the day, after that thermostat will switch to previous mode.

⁠Auto-discovery-templates folder

This folder contains templates for auto-discovery of the devices in Home Assistant. The templates are in JSON format and are used by the discovery service to create the entities. You should copy this folder to your installation.

${deviceSN} - will be replaced with device serial number ${deviceNumber} - will be replaced with device number (if more than one device is used at home)

⁠binary_sensor_heating_state.json

{
    "topic": "homeassistant/binary_sensor/${deviceSN}_binary_sensor_heating_state/config",
    "template": {
        "state_topic": "devi/state/${deviceSN}/binary_sensor_heating_state",
        "device": {
            "identifiers": [
                "${deviceSN}"
            ],
            "manufacturer": "Danfoss",
            "name": "DeviReg ${deviceSN}",
            "model": "DeviReg Smart Thermostat"
        },
        "unique_id": "${deviceSN}_binary_sensor_heating_state",
        "object_id": "devi_binary_sensor_heating_state_${deviceNumber}",
        "name": "Sensor heating state",
        "device_class": "heat"
    }
}

⁠Available Sensors

⁠Default command topics

Note: the pairing is performed with the home, not with the concrete device. If you have multiple devices, all devices will be paired with software.

Protocol is called SecureDeviceGrid(tm) (http://securedevicegrid.com/⁠).

Original source (https://github.com/Sonic-Amiga/org.openhab.binding.devireg⁠)