The Plugwise Home Automation binding adds support to openHAB for the Plugwise Home Automation ecosystem.
This system is built around a gateway from Plugwise called the 'Adam' which incorporates a Zigbee controller to manage thermostatic radiator valves, room thermostats, floor heating pumps, et cetera.
Users can manage and control this system either via a web app or a mobile phone app developed by Plugwise.
The (web) app allows users to define heating zone's (e.g. rooms) and add radiator valves to those rooms to manage and control their heating irrespective of other rooms.
Using the Plugwise Home Automation binding you can incorporate the management of these devices and heating zones into openHAB.
The binding uses the same RESTfull API that both the mobile phone app and the web app use.
The binding requires users to have a working Plugwise Home Automation setup consisting of at least 1 gateway device (the 'Adam') and preferably 1 radiator valve as a bare minimum.
The 'Adam' (from hereon called the gateway) needs to be accessible from the openHAB instance via a TCP/IP connection.
Supported Things
Device Type
Description
Thing Type
-
A Plugwise heating zone configured with at least 1 of the devices below
A room thermostat (also supports the 'Anna' room thermostat)
appliance_thermostat
[Boiler]
A central boiler used for heating and/or domestic hot water
appliance_boiler
Discovery
After setting up the Plugwise Home Automation bridge you can start a manual scan to find all devices registered on the gateway.
You can also manually add things by entering the corresponding device id as a configuration parameter.
The device IDs can be found be enabling TRACE logging in the Karaf console.
Thing Configuration
You must define a Plugwise Home Automation gateway (Bridge) before defining zones or appliances (Things) for this binding to work.
Plugwise Home Automation gateway (Bridge):
Parameter
Description
Config
Default
host
The IP address or hostname of the Adam HA gateway
Required
'adam'
username
The username for the Adam HA gateway
Optional
'smile'
smileID
The 8 letter code on the sticker on the back of the Adam boiler gateway
Required
-
refresh
The refresh interval in seconds
Optional
15
Plugwise Home Automation zone (zone):
Parameter
Description
Config
Default
id
The unique ID of the zone
Required
-
Plugwise Home Automation appliance (appliance_valve):
Parameter
Description
Config
Default
id
The unique ID of the radiator valve appliance
Required
-
lowBatteryPercentage
Battery charge remaining at which to trigger battery low warning. (Only applicable for battery operated devices)
Optional
15
Plugwise Home Automation appliance (appliance_thermostat):
Parameter
Description
Config
Default
id
The unique ID of the room thermostat appliance
Required
-
lowBatteryPercentage
Battery charge remaining at which to trigger battery low warning. (Only applicable for battery operated devices)
Optional
15
Plugwise Home Automation appliance (appliance_pump):
Parameter
Description
Config
Default
id
The unique ID of the pump appliance
Required
-
Plugwise Home Automation boiler (appliance_boiler):
Parameter
Description
Config
Default
id
The unique ID of the boiler
Required
-
Channels
channel
type
Read-only?
description
temperature
Number:Temperature
Yes
The temperature of an appliance that supports the thermostat functionality
setpointTemperature
Number:Temperature
No
The setpoint temperature (read/write) of an appliance that supports the thermostat functionality
power
Switch
No
Toggle an appliance ON/OFF that supports the relay functionality
lock
Switch
No
Toggle an appliance lock ON/OFF that supports the relay functionality.(When the lock is ON the gateway will not automatically control the corresponding relay switch depending on thermostat mode)
powerUsage
Number:Power
Yes
The current power usage in Watts of an appliance that supports this
batteryLevel
Number
Yes
The current battery level of an appliance that is battery operated
batteryLevelLow
Switch
Yes
Switches ON when the battery level of an appliance that is battery operated drops below a certain threshold
chState
Switch
Yes
The current central heating state of the boiler
dhwState
Switch
Yes
The current domestic hot water state of the boiler
waterPressure
Number:Pressure
Yes
The current water pressure of the boiler
presetScene
String
No
The current active scene for the zone
regulationControl
String
No
Toggle current regulation control (Active, Passive, Off) for the zone
coolingAllowed
Switch
No
Toggle the cooling allowed of a zone ON/OFF
valvePosition
Number
Yes
The current position of the valve
preHeat
Switch
No
Toggle the pre heating of a zone ON/OFF
coolingState
Switch
Yes
The current cooling state of the boiler
intendedBoilerTemp
Number:Temperature
Yes
The intended boiler temperature
flameState
Switch
Yes
The flame state of the boiler
intendedHeatingState
Switch
Yes
The intended heating state of the boiler
modulationLevel
Number
Yes
The current modulation level of the boiler
otAppFaultCode
Number
Yes
The Opentherm application fault code of the boiler