Skip to content

Latest commit

 

History

History
76 lines (59 loc) · 4.29 KB

FB_RS485_ESERA_OWD_MQTT.md

File metadata and controls

76 lines (59 loc) · 4.29 KB
Raw

FB_RS485_ESERA_OWD_MQTT

General

Represents a single One Wire Device (OWD) on the 1-Wire bus network. The following 1-Wire devices are currently supported:

Device Devicecode exports link
Maxim integrated DS1820 & DS18B20 1820 temperature link
Esera multisensor Pro 1 11151 air quality, humidity, temperature link
Esera multisensor Pro 2 11152 air quality, humidity, temperature link
Esera temperature sensor living space Pro 11148 humidity, temperature link
Esera MSP 105 multisensor Pro Air Humidity and Temperature Sensor 11150 humidity, temperature link
Esera multisensor Pro temperature, humidity living room flush-mounted for Berker, Jung, Merten 11160 humidity, temperature link
Esera MS105 multisensor temperature, humidity living room flush-mounted for Berker, Jung, Merten 11132 humidity, temperature, brightness link
Esera multisensor for temperature, humidity, brightness, indoor, surface 11134 humidity, temperature, brightness link

Note that the Esera documents the full list of supported devices over here: link. Yet, only the devices are above are supported in the software due to lack of actual testing devices. Nevertheless, adding a new device is a simple task, feel free to reach out.

Block diagram

MQTT Event Behaviour

Requires method call InitMQTT to enable MQTT capabilities.

Event Description MQTT payload QoS Retain flag Published on startup
sensor data is received temperature, humidity, etc readings received. real value 2 FALSE no

MQTT publish topic is a concatination of the publish prefix and the function block name, the OWD numer and a unique sensor value. For example:

Devices/PLC/House/Out/RS485/FB_RS485_ESERA_1WIRE_GATEWAY_MQTT_HOME/OWD/1/TEMP

Naturally /TEMP will only be ommited by the OWD if the physical sensor exposes it.

output MQTT topc suffic Unit
TEMPERATURE /TEMP °C
HUMIDITY /HUM %
OWD_VOLTAGE /OWDV V
AIR_QUALITY /AIRQ ppm
DEW_POINT /DEWP °C
BRIGHTNESS /BNESS Lux

Code example

  • Enabling the OWD & configuring the OWD polling interval (called once during startup using the managing gateway function block):
FB_RS485_ESERA_1WIRE_GATEWAY_MQTT_HOME.EnableOwd(
	OwdNumber := 1,
	DataPollingInterval := T#2M
);

Home Assistant YAML

To integrate with Home Assistant use the YAML code below in your MQTT sensors config. Adopt where necessary depending on the exposed values of your OWD.

mqtt:
  sensor:
  - name: "temperature kitchen"
    object_id: "kitchen_temp"
    state_topic: "Devices/PLC/House/Out/RS485/FB_RS485_ESERA_1WIRE_GATEWAY_MQTT_HOME/OWD/1/TEMP"
    unit_of_measurement: "°C"
    qos: 2
    availability:
      - topic: "Devices/PLC/House/Out/RS485/FB_RS485_ESERA_1WIRE_GATEWAY_MQTT_HOME/OWD/1/availability"
      - topic: "Devices/PLC/House/availability"
    availability_mode : "all"
    payload_available: "online"
    payload_not_available: "offline"