Z Wave Binding

TheKorn2 edited this page Dec 14, 2016 · 69 revisions

feature overview

Installation

Setup intro

Linux and OS X

Windows

FreeBSD


Configuration

Automation*

User Interfaces

Persistence


Community

(link to openHAB forum)

Development


Bindings


Application Integration

Misc


Samples

A good source of inspiration and tips from users gathered over the years. Be aware that things may have changed since they were written and some examples might not work correctly.

Please update the wiki if you do come across any out of date information.

Binding configurations

Use case examples

Item definition examples

Sitemap definition examples

Collections of Rules on a single page

Single Rules

Scripts

Syntax highlighting for external editors


Release Notes

Clone this wiki locally

Documentation of the Z-Wave binding Bundle.

Introduction

The OpenHAB Z-Wave binding allows you to connect to your Z-Wave wireless mesh network. A Z-Wave network typically consists of one primary controller “stick”, zero or more additional controllers and zero or more Z-Wave enabled devices, e.g. dimmers, switches, sensors etc. Connection to the Z-Wave controller is done through the serial port of your host system. USB controllers typically create a virtual COM port to connect to the stick. Please write down the port name before configuring this binding. In case your port name changes dynamically and you want to use a symlink, see Tricks. A list of supported controllers is listed below.

Initialization of the binding typically takes several seconds to minutes depending on the number of devices in the network. When battery operated devices are used the binding tries to reach the device first. After one minute the node is marked sleeping. On wake up of the device initialization will continue.

HABmin can be used to configure devices (setting configuration parameters and association groups) directly within openHAB. Alternatively the open-zwave control panel is a good choice to set up your network. Commercial software like Homeseer can be used as well.

For installation of the binding, please see Wiki page Bindings.

The snapshot version of the binding can be downloaded, together with the rest of openhab, from the cloudbees page.

NOTE: There is an issue with using the RPi with the zwave binding - see the known issues below.

For technical reference and implementation: Chris Jackson maintains an excellent technical resource for the ZWave binding on the HABmin Wiki

Supported controllers

The binding supports all controllers that implement the Z-Wave Serial API. A list of confirmed supported controllers is

Aeon Labs USB Z-Stick No remarks
Aeon Labs USB Z-Stick Gen5 Do NOT enable Soft Reset
The Razberry-Zwave-Daughterboard See known issues
Vision USB stick Z-wave Do NOT enable Soft Reset
Z-Wave.me Z-StickC No remarks
Z-Wave.me ZME-UZB1 Do NOT enable Soft Reset
Sigma UZB ZWave-Plus No Windows drivers ?

NOTE: Sigma UZB ZWave-Plus driver can be get there https://github.com/benoit934/drivers/blob/master/ZW050x_USB_VCP_PC_Driver.zip This is an official driver for the RS232 chip, you just have to install it manually using the inf file, actually working on Windows 7, probably any Windows version.

Binding Configuration

First of all you need to introduce the port settings of your Z-Wave controller in the openhab.cfg file (in the folder '${openhab_home}/configurations'). The refresh interval and the refresh delay can be specified optionally.

############################## Z-Wave  Binding ###################################

# Z-Wave controller port
# Valid values are e.g. COM1 for Windows and /dev/ttyS0 or /dev/ttyUSB0 for Linux
zwave:port=COM1
Option Description
zwave:port value indicates the serial port on the host system to which the Z-Wave controller is connected, e.g. "COM1" on Windows, "/dev/ttyS0" or "/dev/ttyUSB0" on Linux or "/dev/tty.PL2303-0000103D" on Mac.
Note that some controllers register themselves as a modem (/dev/ttyACM) on Linux. In this case it is necessary to add user "openhab" to the group "dialout". Else openHAB won't be able to access the controller.
zwave:healtime Sets the time of day when a network heal will be performed.
zwave:pollingQueue Sets the maximum number of frames in the polling queue at once. This avoids swamping the network with poll messages.
zwave:aliveCheckPeriod Sets the time (in milliseconds) between each node health check message. This is used to periodically check if a node is alive.
zwave:softReset Set to true to perform a soft reset on the controller during the heal, and when the binding starts. This can help solve some problems with the stick, but it can also cause some new controllers to lock up (eg the ZWave Plus controllers)
zwave:masterController This option tells the binding that it is the main controller in the network. This isn't necessarily the same as a primary controller - it simply means that your openhab binding is being used as the main network interface. If set to ```true```, the binding will configure devices automatically to send some communications to the binding. This would include setting the wakeup class to send notifications to openhab, and set some associations so that the binding recieves notifications of configuration change or alarms. (being introduced for 1.7)
zwave:setSUC=true See: https://github.com/cdjackson/HABmin/wiki/ZWave-SUC-Controller-Mode

Item configuration

In order to bind an item to a Z-Wave device, you need to provide configuration settings. The easiest way to do so is to add some binding information in your item file (in the folder configurations/items`). The syntax for the Z-Wave binding configuration string is explained here: The format of the binding configuration is simple and looks like this:

zwave="<nodeId>[:<endpointId>][:command=<command>[,parameter=<value>][,parameter=<value>]...]"

where parts in brackets indicate an optional item. Usually only one item is bound to a device, but more items can be bound to a device as well, either for reporting variables, or in case the device consists of multiple endpoints / instances.

The node ID indicates the number (in decimal notation) of the node, to which this item is bound. To find out your devices nodeIds either look at the startup log of openhab or use other Z-Wave configuration programs like openzwave control panel to detect and configure your setup.

The endpoint ID is only required/allowed when using the multi_instance command class. In case a node consists of multiple instances or endpoints, the instance number can be specified using this value. The default value is not to use the multi_instance command class - the number must be positive and must not be 0. An example of a multi-endpoint device is the Fibaro FGS 221 double relay.

PLEASE NOTE THAT THE ENDPOINT NUMBERING CHANGED FOR 1.6 RELEASE. Previously, the default value was 1, but this caused problems with multi-instance devices. This meant that a binding string of zwave=18:1 and zwave=18 was the same - this is now NOT the case.

If you're not sure about endpoint numbering, look in the logs to see if sensor data is being correlated. You may see the following warning -:

2014-12-14 12:51:17.065 WARN  o.o.b.z.i.ZWaveActiveBinding[:459]- NODE 8: No item bound for event, endpoint = 0, command class = SENSOR_MULTILEVEL, value = 51, ignoring.

This indicates that the binding can’t find an item linked to this sensor - often this is because the endpoint numbering is incorrect. If the warning above says endpoint = 0, then the binding string shouldn't include an endpoint number.

The command is optional, but recommended if you have multiple items bound to the same device, or the device reports multiple bits of information. Without the command class, the binding can not unambiguously differentiate different data, so it is recommended to provide a command class. Z-Wave nodes support functionality through command classes. A specific command class can be specified to use that specific functionality of the node. A node can contain multiple supported command classes. If the command is omitted, the best suitable command class for the item / node combination is automatically chosen.

Command classes may support parameters. A parameter is a name=value pair that configures some aspect of the command class on the node or in the binding.

A list with command classes and parameter values is provided below:

Supported Command Classes

Each node in the network provides functionality in the form of Command Classes. The OpenHAB Z-Wave binding implements the same Command Classes to be able to use the nodes in the network. Not all Z-Wave Command classes are currently supported by the binding. The supported command classes are listed in the table below.

Command Class Remarks Supported parameters
NO_OPERATION Used by the binding during initialization
BASIC Provides basic SET and GET of the default node value
HAIL Used by nodes to indicate that they want to be polled. The binding handles this automatically
METER Used to get measurements from a node **meter_scale=value** : optional parameter to select the meter scale in case the meter supports multiple scales (and types). Value is one of the following **textual** values:
E_KWh (0, MeterType.ELECTRIC, "kWh", "Energy")
E_KVAh (1, MeterType.ELECTRIC, "kVAh", "Energy")
E_W(2, MeterType.ELECTRIC, "W", "Power")
E_Pulses (3, MeterType.ELECTRIC, "Pulses", "Count")
E_V (4, MeterType.ELECTRIC, "V", "Voltage")
E_A (5, MeterType.ELECTRIC, "A", "Current")
E_Power_Factor (6, MeterType.ELECTRIC, "Power Factor", "Power Factor")
G_Cubic_Meters (0, MeterType.GAS, "Cubic Meters", "Volume")
G_Cubic_Feet (1, MeterType.GAS, "Cubic Feet", "Volume")
G_Pulses(3, MeterType.GAS, "Pulses", "Count")
W_Cubic_Meters (0, MeterType.WATER, "Cubic Meters", "Volume")
W_Cubic_Feet (1, MeterType.WATER, "Cubic Feet", "Volume")
W_Gallons (2, MeterType.WATER, "US gallons", "Volume")
W_Pulses (3, MeterType.WATER, "Pulses", "Count")
METER_RESET Used to reset a meter back to 0 To reset a meter use the "meter_reset=true" attribute on the meter. When moving the switch from off to on it will reset the meter.
e.g.:
Switch sReset { zwave="8:command=meter, meter_reset=true"}
SWITCH_BINARY Used to bind directly to a SWITCH
SWITCH_MULTILEVEL Used to bind directly to a DIMMER restore_last_value=true : restores the dimmer to it's last value if an ON command is sent to the dimmer (as opposed to setting it's value to 100%)
SENSOR_BINARY Used to bind to a sensor. **sensor_type=value** : optional parameter to select a sensor in case the node supports multiple sensors. Value is one of the following **numerical** values:
1 = General Purpose
2 = Smoke
3 = Carbon Monoxide
4 = Carbon Dioxide
5 = Heat
6 = Water
7 = Freeze
8 = Tamper
9 = Aux
10 = Door/Window
11 = Tilt
12 = Motion
13 = Glass Break
SENSOR_MULTILEVEL Used to bind to e.g. a temperature sensor. Currently only single sensors are supported. **sensor_type=value** : optional parameter to select a sensor in case the node supports multiple sensors. Value is one of the following **numerical** values:
1 = Temperature
2 = General
3 = Luminance
4 = Power
5 = RelativeHumidity
6 = Velocity
7 = Direction
8 = AtmosphericPressure
9 = BarometricPressure
10 = SolarRadiation
11 = DewPoint
12 = RainRate
13 = TideLevel
14 = Weight
15 = Voltage
16 = Current
17 = CO2
18 = AirFlow
19 = TankCapacity
20 = Distance
21 = AnglePosition
22 = Rotation
23 = WaterTemperature
24 = SoilTemperature
25 = SeismicIntensity
26 = SeismicMagnitude
27 = Ultraviolet
28 = ElectricalResistivity
29 = ElectricalConductivity
30 = Loudness
31 = Moisture
32 = MaxType
MULTI_INSTANCE Used to channel commands to the right endpoint on multi-channel devices. See item configuration.
MANUFACTURER_SPECIFIC Used to get manufacturer info from the device
BATTERY Used to get the battery level from battery operated devices. See item configuration.
WAKE_UP Used to respond to wake-up signals of battery operated devices.
VERSION Used to get version info from a node.
SENSOR_ALARM Used to get alarm info from sensors. *alarm_type=value* : optional parameter to select an alarm type in case the node supports multiple alarms. Value is one of the following **numerical** values:
GENERAL(0, "General")
SMOKE(1, "Smoke")
CARBON_MONOXIDE(2, "Carbon Monoxide")
CARBON_DIOXIDE(3, "Carbon Dioxide")
HEAT(4, "Heat")
FLOOD(5, "Flood")
SCENE_ACTIVATION Used to respond to Scene events. scene=xx to identify the scene to trigger on
state=xx to set the item to the specified state (xx is an integer)
ALARM
MULTI_CMD Used to send multiple command classes in a single packet.
THERMOSTAT_MODE (since 1.6.0) Used to get and set the mode (of Number type) of the thermostat numeric values translate to the following types
0 = "Off"
1 = "Heat"
2 = "Cool"
3 = "Auto"
4 = "Aux Heat"
5 = "Resume"
6 = "Fan Only"
7 = "Furnace"
8 = "Dry Air"
9 = "Moist Air"
10 = "Auto Changeover"
11 = "Heat Econ"
12 = "Cool Econ"
13 = "Away"
THERMOSTAT_OPERATING_STATE (since 1.6.0) Used to get the operating state (of Number type) of the thermostat numeric values translate to the following types
0 = "Idle"
1 = "Heating"
2 = "Cooling"
3 = "Fan Only"
4 = "Pending Heat"
5 = "Pending Cool"
6 = "Vent / Economizer"
THERMOSTAT_SETPOINT (since 1.6.0) Used to get and set the setpoint of the thermostat **setpoint_type=value** : parameter to select setpoint type, value is one of the following numerical values:
1 = Heat
2 = Cool
*setpoint_scale=value** : parameter to select setpoint scale, value is one of the following numerical values:
0 = Celsius
1 = Fahrenheit
THERMOSTAT_FAN_MODE (since 1.6.0) Used to get the fan mode (of Number type) of the thermostat numeric values translate to the following types
0 = "Auto Low"
1 = "On Low"
2 = "Auto High"
3 = "On High"
4 = "Unknown"
5 = "Unknown"
6 = "Circulate"
THERMOSTAT_FAN_STATE (since 1.6.0) Used to get the fan state (of Number type) of the thermostat numeric values translate to the following types
0 = "Idle"
1 = "Running"
2 = "Running High"
CONFIGURATION Used to set configuration parameters. Normally, this is done through HABmin as most configuration is static, but some devices have parameters that need to be changed via a rule or sitemap. Use the "parameter=" option in the binding string to set the parameter number linked to this item.
INFO This is not a 'real' zwave command class, but can be used to get information from the binding about a node and its state. Controller only:
HOME_ID
SOF
CAN
NAK
OOF
ACK
TIME_OUT
TX_QUEUE

All Nodes:
NODE_ID
LISTENING
DEAD
ROUTING
VERSION
BASIC
BASIC_LABEL
GENERIC
GENERIC_LABEL
SPECIFIC
SPECIFIC_LABEL
MANUFACTURER
DEVICE_ID
DEVICE_TYPE
LAST_UPDATE
INDICATOR Show the state, or level of a device, usually through a button LED, or display on the actual device If you use the bit=n (n between 0 and 8) parameter then you can bind Switch Items to individual bits in the indicator value which can be used to turn on and off status LEDs on device buttons for instance.

Parameters that can be added to any item

There are some general parameters that can be added to any command class in an item string. These are refresh_interval=value and respond_to_basic=true

refresh_interval=value sets the refresh interval to value seconds. 0 indicates that no polling is performed and the node should inform the binding itself on value changes. This is the default value.

respond_to_basic=true indicates that the item will respond to basic reports. Some Fibaro contacts and universal sensors report their values as BASIC reports instead of a specific command class. You can add this parameter to an item to indicate that this item should respond to those reports.

meter_zero=xx.x can be set when using the Meter command class. If set, anything below the value specified will be considered as 0. This allows the user to account for small power consumption readings even when a device is off.

sensor_scale=X can be set for the multilevel sensor class to force the sensor to be converted to a specific scale. This uses the scale information provided by the device to decide how, or if, the conversion needs to be applied. Currently this is only available for temperature sensors. eg. sensor_scale=0 will ensure that a temperature sensor is always shown in celsius, while sensor_scale=1 will ensure fahrenheit.

invert_state=true can be used to invert the state of a multilevel switch command class. eg this can be used to reverse the direction of a rollershutter.

Basic command class

The basic Command Class is a special command class that almost every node implements. It provides functionality to set a value on the device and/or to read back values. It can be used to address devices that are currently not supported by their native command class like thermostats.

When the basic command class is used, devices support setting values and reporting values when polling. Direct updates from the device on changes will fail however.

You can force a device to work with the basic command set (or any specific command set for that matter using a syntax like:

Switch    ZwaveDevice        { zwave="3:1:command=BASIC" }

To find out which command classes are supported by your Z-Wave device, you can look in the manual or use the list at http://www.pepper1.net/zwavedb/ or http://products.z-wavealliance.org/. In case your command class is supported by the device and binding, but you have a problem, you can create an issue at: https://github.com/openhab/openhab/issues. In case you want a command class implemented by the binding, please create an issue.

Known Issues

ARM Compatibility issue (fixed - updated Dec. 11, 2016 see below): There seems to be an issue with the binding running on the latest oracle VM Beta, on ARM based architectures (e.g. raspberry PI). It manifests itself as messages being received multiple times and causes considerable problems with the operation of the binding. In large networks, the queue can get extremely long, which can delay initialisation considerably and cause potentially long delays in sending messages. Some time has been spent investigating this issue and a solution has not been found - the issue doesn't appear to be with the binding itself as the problem doesn't manifest itself on an other platform. If anyone with the hardware and programming experience can help with this it would be useful (add information to https://github.com/openhab/openhab/issues/1564).

(Update Dec. 11, 2016): This issue is no longer affecting "all" ARM processors. The above issue report has been closed as the problem has vanished in newer Java JRE versions.
I recently built a successful setup with no duplication problems with these versions of software and hardware:
Raspberry Pi 3 (ARM v7l) Aeon Zstick Gen5 Raspbian - November 2016 - Kernel 4.4 Openhab 1.8.3 Z-wave binding version 1.8.3 Java Runtime SE: build 1.8.0_65-b17

The original issue (1564) has been closed and the symptoms have vanished since an update to Java JRE's serial library that is now standard in the new versions of Raspbian. I have not tested with original Raspberry pi (ARM v5) nor a Raspberry pi 2 (ARM v6). Assuming it was fixed in Java those should work now too. But maybe it is only fixed based on Raspberry pi 3 being ARM v7l.

You should no longer fear using OpenHAB with raspberry pi 3 and Z-wave! For my install it is very successful and zero errors.

Examples

Numerous examples of item definitions available at the Binding examples page

Healing

The binding can perform a nightly heal. This will try to update the neighbor node list, associations and routes. The actual routing is performed by the controller. Two options are possible in the config file to set the healing. healtime sets the time (in hours) that the automatic heal will occur. softReset can also be set to true to perform a soft reset on the controller before the heal. Note that it has been observed that this can cause some zwave-plus sticks to lock up, so you should test this first.

Battery Devices and Wakeup

One of the questions that gets asked a lot is "my battery device is sending information, so it's clearly awake, but I can't change parameters". ZWave battery devices only 'wake up' periodically however they will send their data whenever THEY want. So if the door opens, then a sensor will send its data immediately (otherwise it would be of no use!) and for temperature sensors, or multi sensors, there's normally a configuration that allows you to configure how often the sensor will send the data, or how much change there needs to be before it will send an update (or a combination of the two).

However, wakeup is different. In the above scenarios, the device is not 'awake' - it's just sending notifications. When a device wakes up, it sends a special message to the binding to say "I'm awake, do you have anything to send me". We can then send data to the device (configuration setting, parameter requests etc), and the device can respond. When we have no more messages to send to the device, we tell it to go back to sleep (this currently happens 1 second after we send the last message - just to give the system time to respond to any rules etc before the device goes to sleep again).

A device will wake up based on the information in the wakeup command class, which is available in HABmin. If wakeup isn't set correctly, then we can't command the device, even though we may receive sensor data etc. The binding will attempt to configure this automatically when the device/binding initialises - it will make sure that the node is set to reference the binding, but in general it won't touch the time. The exception to this is where the time is set to 0, it will set it to 1 hour.

If wakeup hasn't been set, then we will never be able to send commands to the device to initialise it, or change parameters. In this case, you need to wake the device up manually. Normally, this is achieved by pressing a button on the device (maybe 3 times). This causes the device to send what's called a NIF (Node Information Frame) - this is sent as a broadcast though so it's not routed. This means that the device MUST be able to communicate directly to the controller, so it needs to be close by.

The last wakeup time is shown in HABmin in the wakeup area for a battery device.

One last point on the wakeup configuration node. There is (currently) no way to set the target node - the binding will automatically set it to its own ID when the interval is changed. Some people have used a value of 255 for the target node, or it may come as the default value - this means that the wakeup is broadcast to anyone who wants to listen. This might seem a good idea as multiple controllers can receive the message however, broadcast messages do not get routed, so this only works if the controller is in direct contact with the device which is often not the case.

Database

Note: A new online database editor is being produced. This should make it easier for most people to add and update devices within the database, and will improve support for both the OH1 and OH2 bindings. Please support this here.

The binding uses a database of devices so that it can work around any quirks, or present information about association groups and configuration data. The format for the database is here.

If you are not able to produce the XML file yourself, then please open an issue. The following information is required -:

  • Type and ID for the device - HABmin will print this information when a device is not in the database
  • Manufacturer
  • Reference to the device manual (ie link to PDF)
  • Link to device in pepper1 database (if it exists). http://www.pepper1.net/zwavedb/

Logging

The ZWave binding can generate a lot of debug/trace logging when enabled so it is advisable to generate a separate log file for this binding. This also makes it easier for analysis since there is nothing from other bindings/openHAB polluting the logs.

In order to configure logging for this binding to be generated in a separate file add the following to your /configuration/logback.xml file;

<appender name="ZWAVEFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
   <file>logs/zwave.log</file>
   <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <!-- weekly rollover and archiving -->
      <fileNamePattern>logs/zwave-%d{yyyy-ww}.log.zip</fileNamePattern>
      <!-- keep 30 days' worth of history -->
      <maxHistory>30</maxHistory>
   </rollingPolicy>
   <encoder>
     <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%-30.30logger{36}:%-4line]- %msg%n</pattern>
   </encoder>
</appender>

<!-- Change DEBUG->TRACE for even more detailed logging -->
<logger name="org.openhab.binding.zwave" level="DEBUG" additivity="false">
   <appender-ref ref="ZWAVEFILE" />
</logger>

It is highly recommended to turn on at least DEBUG logging whilst setting up and configuring your ZWave network for the first time.

Refreshing a value manually

In seldom cases it is useful to refresh values from the network manually in rules.

To achieve this, use the refresh.REFRESH command on the corresponding item. e.g.

sendCommand("BEDROOM_TV", refresh.REFRESH)

Attention: This works only with OH2