nibe-mqtt 1.0.3

Nibe heatpump MQTT integration

Nibe MQTT integration

MQTT integration for controlling Nibe heatpumps. Supports HomeAssistant MQTT Autodiscovery.

Connection methods

• RS485 hardwired using NibeGW on Arduino or RPi. NibeGW was developed by Pauli Anttila for Openhab's integration.
• TCP Modbus for S Models
• Serial Modbus for Nibe Modbus 40)

Supported heatpump models

F series

• F370
• F470
• F730
• F750
• F1145
• F1155
• F1245
• F1255
• F1345
• F1355

S series

• S320
• S325
• S330
• S332
• S735
• S1156
• S1256
• S2125

SMO series

• SMO20
• SMO40

SMOS series

• SMOS40

VVM series

• VVM225
• VVM310
• VVM320
• VVM325
• VVM500

VVMS series

• VVMS325

Installation

PyPi

It is possible to install directly from PyPi

pip3 install nibe-mqtt

Then you will be able to run the service with command

nibe-mqtt -c config.yaml

Docker

See Docker Hub for available versions (tags)

Run with:

docker run -ti --pull=always --rm -p 9999:9999/udp -v "/Users/myuser/Desktop/config.yaml:/config/nibe-mqtt/config.yaml:ro" yozik04/nibe-mqtt:latest

Basic configuration

With NibeGW:

mqtt:
  host: 192.168.1.2
  port: 1883
  protocol: 5
  username: user
  password: pass
nibe:
  model: F1255
  nibegw:
    ip: 192.168.1.3
  poll:
    coils:
      - bt50-room-temp-s1-40033

For all configuration options lookup in config.py

With Modbus:

mqtt:
  host: 192.168.1.2
  protocol: 5
  username: user
  password: pass
nibe:
  model: F1255
  word_swap: true
  modbus:
    url: tcp://192.168.1.3:502
    slave_id: 1
  poll:
    coils:
      - bt50-room-temp-s1-40033

For all configuration options lookup in config.py

Supported coils

See the list of available parameters here

Writing Registers

See the list of supported coils to find out which registers can be written (set). For setting a register/coil, publish your data under the following topic: [prefix]/[coil]/set. Example: Publish ONE TIME INCREASE to nibe/coils/temporary-lux-48132/set for turning on temporary hot water lux mode.

Word swap

You might need to specify word_swap setting to let underneath library understand how to decode 32-bit integers (mostly counters). For most of the heat pumps with NibeGW connection method it will be auto detected (since nibe-mqtt 1.1.0, nibe 2.1.0).

...
nibe:
  ...
  word_swap: true
  ...

You can find the setting value in you Heat pump service menu 5.3.11 (modbus settings), there is a setting called word swap.

You need to set word_swap setting in yaml to match the setting in the service menu.

Failing to do so will start throwing errors with decoding errors of 32-bit registers.

Disclaimer

Nibe is registered mark of NIBE Energy Systems.

The code was developed as a way of integrating personally owned Nibe heatpump, and it cannot be used for other purposes. It is not affiliated with any company, and it doesn't have commercial intent.

The code is provided AS IS and the developers will not be held responsible for failures in the heatpump operation or any other malfunction.

IMPORTANT: Using this library to control your heatpump is done at your own risk. The developers assume no responsibility for any damage that may occur to your heating system, property, or for any unsafe conditions that may result from improper use. Changing heatpump parameters can potentially damage your equipment or create hazardous conditions. Users should have sufficient knowledge of their heating system before attempting to control it.