MQTT enabled CODESYS 3 Home Automation
This CODESYS 3.5 project is built for home automation purposes. The goal of the approach is to perform any critical operations like reading inputs, switching lights, controlling sun blinds, etc. inside the PLC itself and make use of MQTT to send events to an MQTT broker. Using MQTT subscriptions it's possible to send commands to the PLC to control -for example- outputs.
The purpose? Redundancy on a software level but also on a hardware level!
- PLCs are very (very) robust controllers: no PC, SoC, etc. is more robust and failure resistant.
- Hardware continuity: Home automation providers often renew their modules every X years, modules aren't sold anymore or a full upgrade is required when something breaks. PLC models and their modules are sold decades after their initial release date. For an example, check out the Wago 750 series controllers and modules.
- Avoid performing critical operations that should work 24/7 inside a less redundant controller (it will fail sooner or later).
- Keep your wife/girlfriend happy when you're not at home and your RPi, Odroid, Banana Pi, PC crashes (running your MQTT broker, openHAB, Home Assistant, etc.).
Supported Devices & Getting started
The project is developed using the IEC 61131-3 standard in CODESYS. Although CODESYS supports a large number of different device types, this project is specifically tested and developed on the WAGO PFC100/200 device series. There are multiple generations of the WAGO PFC100/200 series, the documentation below aims to get you acquainted with the differences between generations and their implications:- Choosing and preparing your WAGO PFC device
- Getting started guide
- Configuring an I/O module with WAGO-I/O-CHECK — for the settings that
Architecture
Core processing logic is executed in the (robust) PLC. Meaning that events like reading pushbuttons/switches, updating outputs are executed in the PLC software. To enable integration with external software the PLC sends out events to an MQTT broker when events occur (like pushbutton events, outputs that change state). MQTT subscriptions are enabled as well to allow the external software to control -for example- outputs.Software Architecture
More information on the software architecture here.
Function blocks
Basic function blocks
Basic function blocks for basic IO events and operations.- FB_INPUT_PUSHBUTTON_MQTT
- FB_INPUT_PUSHBUTTON_DIMMER_MQTT
- FB_INPUT_BINARYSENSOR_MQTT
- FB_INPUT_TEMPERATURE_RTD_MQTT
- FB_INPUT_PULSE_COUNTER_MQTT
- FB_OUTPUT_BINARY_MQTT
- FB_OUTPUT_DIMMER_MQTT
- FB_OUTPUT_COVER_MQTT
- FB_OUTPUT_COVER_POSITION_MQTT
- FB_OUTPUT_BISTABLE_MQTT
Modbus RTU over RS485
With many PLCs having an onboard RS485 serial port it is a popular protocol to create a robust Modbus RTU sensor network.Using Modbus RTU
How to use Modbus RTU differs depending on the PLC/development environment used. The topics below address the usage of Modbus RTU in several development environments:RS485 function blocks
To translate the byte array received by the Modbus device to their actual value and send their values through MQTT the function blocks below have been developed. Note that a specific function block is required for each type of Modbus RTU device.- FB_RS485_EASTRON_SDM220_MQTT
- FB_RS485_EASTRON_SDM_POWER_MQTT
- FB_RS485_EASTRON_SDM630_MQTT
- FB_RS485_DUCO_DUCOBOX_FOCUS_MQTT
- FB_RS485_ESERA_OWD_MQTT
- FB_RS485_DFROBOT_SEN0492_MQTT
The three Eastron meter blocks announce themselves to Home Assistant over MQTT discovery:
give the instance a FriendlyName and it appears as a device of its own with its
measurements underneath, no YAML and no init calls. See
MQTT self-wiring.
Three more blocks sit underneath:
- FB_RS485_BUSCONTROLLER decides whose turn it
- FB_RS485_COMMISSIONER puts devices onto the
- FB_RS485_TRANSPORT_RTU speaks Modbus RTU over
DALI
Control DALI drivers using the WAGO DALI multi-master module (753-647). Needs theWagoAppDALI library, which WAGO's licence does not allow this repository to ship —
install it once per engineering PC
before building.
Two caveats, both on the function block's page: **only a G2 WAGO device can drive
the module under the CODESYS runtime**, because FbDaliMaster binds to a port
instance that only WAGO's own device description provides, and the whole feature
is untested on hardware — compile-verified on every build, never run against
a real ballast.
DMX
Control DMX drivers.HVAC
Control your HVAC setup, more detail in the HVAC getting started guide.Additional functionality
- MQTT related settings
- MQTT Discovery
- Naming a block instead of wiring it
- Controlling Wago PFC user LEDs
FAQ
- Contributing guidelines
- Coding style
- Migrating to the naming convention
- How-to: adding a new MQTT subscription
- How-to: verifying resource usage on a Wago PFC PLC
- How-to: updating function blocks to the latest version
- RS485: tips and tricks
- I'm missing some functionality
Libraries
The following libraries are used in this PLC project and can be found under src\Libraries:
- MQTT (stefandreyer/CODESYS-MQTT)