Skip to content

Samples Binding Config

Nick edited this page May 27, 2015 · 30 revisions

This page contains samples for binding configurations. These samples are sorted by binding.

KNX basic configuration

The openhab.cfg file

  • The easiest way of configuring a KNX binding is by connecting in ROUTER mode. To do so, enable this: knx:type=ROUTER . If you cannot use the ROUTER mode, set it to TUNNEL, but you must then configure the IP: knx:ip=<IP of the KNX-IP module>

The items file

The items may include the KNX group address to use them. They might be actively read by openHAB or not. They look like this:

  • Number Lighting_Room_Sensor "Lighting in the Room [Lux](%.2f)" <switch> (Room,Lighting) { knx = "<0/1/1" }: This is a sensor item. It uses the 0/1/1 group address and openHAB will ask for its value periodically because there is a "<" sign before the address. It is a number item, called Lighting_Room_Sensor, and belongs to Room and Lighting groups.
  • Switch Light_Room_Table "Table Light" (Room, Lights) { knx = "<0/1/10+0/1/30"}: This is a switch item that has two addresses. openHAB may responds to events in any of them, but may actively read the first one.

How to send Date and Time from NTP to KNX

This example sends the current date and time from the NTP to the KNX binding

DateTime Date "Date & Time [%1$td.%1$tm.%1$tY %1$tT]" { ntp="Europe/Berlin:de_DE", knx="11.001:0/0/1, 10.001:0/0/2" } 

Items:

0/0/1 is the GA for Date

0/0/2 is the GA for Time

Additional information on date and time formatting can be found here

How to use KNX data types 2.xxx Priority Control

Starting with version 1.6.0 KNX data types 2.xxx are supported. This examples shows the usage of DPT 2.001 "Switch Control".

item definition:

Number item2_001 "2.001 Switch Control" { knx="2.001:1/2/3"}

sitemap definition:

Selection item=item2_001 mappings=[ 0="priority override disabled (off)", 1="priority override disabled (on)", 2="priority override: off", 3="priority override: on" ]

or

Switch item=item2_001 mappings=[ 0="priority override disabled (off)", 1="priority override disabled (on)", 2="priority override: off", 3="priority override: on" ]

How to use KNX scenes

KNX devices differ in the ways scenes can be activated and learned (programmed). Some devices require a bit trigger using data point type 1.022 "DPT_SCENE_AB", which will activate either scene A or B. These devices can be used as follows (starting with version 1.6.0):

item definition:

Number item1_022 "1.022 SCENE AB" { knx="1.022:1/2/3"}

sitemap definition:

Selection item=item1_022 mappings=[ 0="Scene A", 1="Scene B" ]

or

Switch item=item1_022 mappings=[ 0="Scene A", 1="Scene B" ]

Some devices require a byte using data point type 18.001 "DPT_SCENE_CONTROL", which will activate or learn one of 64 possible scenes. Adding 128 to the scene number to allow switching to learn mode. Example: "activate Scene 2" requires value 1, "learn Scene 2" requires value 129 These devices can be used as follows (starting with version 1.6.0):

item definition:

Number item18_001 "Scene Control" {knx="18.001:1/2/3"}

sitemap definition:

Selection item=item18_001 mappings=[ 0="Scene 1", 1="Scene 2", 2="Scene 3", 3="Scene 4", 128="learn Scene 1", 129="learn Scene 2", 130="learn Scene 3" ]

or

Switch item=d18_001 mappings=[0="Scene 1", 1="Scene 2", 2="Scene 3", 128="learn Scene 1", 129=" learn Scene 2", 130="learn Scene 3"]

If you have a device requiring 17.001 DPT_SCENE_NUMBER for selecting or indicating scenes, then use one of the above mentioned examples and replace 18.001 with 17.001. Additionally, remove all "learn" mappings.

How to get temperatures from OW-SERVER via HTTP binding

Requirements:

Instructions:

  1. Go to http://<ow-server-IP>/devices.htm and look for the ROMId-Value OW Server

  2. Add an Number-Item to your items-configuration like this one

// Example:
Number Temp_Kitch "Küche [°C](%.1f)" { http="<[Units=\"Centigrade\">(.*?)</Temperature>.*)](http://192.168.1.16/details.xml:60000:REGEX(.*?<ROMId>A7000002CC4D2228</ROMId>.*?<Temperature)" }

Replace the ip address and the ROMId-value with your data.

How to get humidity from OW-SERVER via HTTP binding

Device: OW-ENV-TH (EDS0065)

Example:

Number Humidity "Humidity [%.1f %%]" { http="<[http://192.168.1.16/details.xml:5000:REGEX(.*?<ROMId>C30010000027767E</ROMId>.*?<Humidity Units=\"PercentRelativeHumidity\">(.*?)</Humidity>.*)]" }

How to get contact from OW-SERVER via HTTP binding

Device: D2C (DS2406)

Example:

Number Door "Door [MAP(contact.map):%d]" { http="<[http://192.168.1.16/details.xml:5000:REGEX(.*?<ROMId>BD0000009D93DC12</ROMId>.*?<InputLevel_A>(.*?)</InputLevel_A>.*)]" }

You may want to change the query-interval (here 5000ms) to a few seconds. You can get the value for InputLevel_B, too. ;)

contact.map:
    0=open
    1=close
    -=UNKNOWN

How to turn on/off a switch from OW-SERVER via HTTP binding

Device: D2C (DS2406)

Example:

Switch Lamp "Switch [MAP(switch.map):%d]" { http="<[http://192.168.1.16/details.xml:5000:REGEX(.*?<ROMId>BD0000009D93DC12</ROMId>.*?<InputLevel_B>(.*?)</InputLevel_B>.*)]" }

This only reads the state of the switch.

switch.map:
    1=ON
    0=OFF
    -=undefiniert

To turn the switch on or off you need to define two rules: rule "Turn Lamp on" when Item Lamp changed to ON then sendHttpGetRequest("http://192.168.1.16/devices.htm?rom=BD0000009D93DC12&variable=FlipFlop_B&value=0") end

rule "Turn Lamp off"
when 
	Item Lamp changed to OFF
then
	sendHttpGetRequest("http://192.168.1.16/devices.htm?rom=BD0000009D93DC12&variable=FlipFlop_B&value=1")
end

How to read the status from a OneWire sensor DS2413 (2 port I/O)

item definition:

Number WindowContact1   "Window 1 is [MAP(contact.map):%s]"                  (All) { onewire = "3C.16AA13000000#sensed.A" }
Number WindowContact2   "Window 2 is [MAP(contact.map):%s]"                  (All) { onewire = "3C.16AA13000000#sensed.B" }

sitemap definition:

Text item=WindowContact1
Text item=WindowContact2

map file contact.map

1=closed
0=opened

Sample output for this definition would then be "Window 1 is opened" or "Window 2 is closed".

How to get data from Kostal Piko solar inverter via HTTP binding

Kostal Piko

/* solar power (AC) */
Number solar_active_power     "active power [%.0f W]"               <inverter>   { http="<[kostal-inverter-cache:30000:REGEX(.*aktuell</td>.*?([0-9]*)</td>.*)]" }

/* solar energy */
Number solar_energy_total     "solar production total [%.0f kWh]"   <energy>     { http="<[kostal-inverter-cache:30000:REGEX(.*Gesamtenergie</td>.*?(\\d*)</td>.*)]" }
Number solar_energy_day       "solar production per day [%.2f kWh]" <energy>     { http="<[kostal-inverter-cache:30000:REGEX(.*Tagesenergie</td>.*?([0-9\\.]*)</td>.*)]" }

/* solar inverter String 1*/
Number solar_Str1_voltage     "String1 voltage [%d V]"                           { http="<[kostal-inverter-cache:30000:REGEX(.*?String 1.*?Spannung</td>.*?(\\d*)</td>.*)]" }
Number solar_Str1_current     "String1 current [%.2f A]"                         { http="<[kostal-inverter-cache:30000:REGEX(.*?String 1.*?Strom</td>.*?([0-9.]*)</td>.*)]" }

/* solar inverter String 2*/
Number solar_Str2_voltage     "String2 voltage [%d V]"                           { http="<[kostal-inverter-cache:30000:REGEX(.*?String 2.*?Spannung</td>.*?(\\d*)</td>.*)]" }
Number Solar_Str2_current     "String2 current [%.2f A]"                         { http="<[kostal-inverter-cache:30000:REGEX(.*?String 2.*?Strom</td>.*?([0-9.]*)</td>.*)]" }

/* solar inverter output voltage and power phase 1 (L1) */
Number solar_out_L1_voltage   "L1 voltage [%d V]"                                { http="<[kostal-inverter-cache:30000:REGEX(.*?String 1.*?Spannung</td>.*?Spannung</td>.*?(\\d*)</td>.*)]" }
Number solar_out_L1_power     "L1 power [%d W]"                                  { http="<[kostal-inverter-cache:30000:REGEX(.*?String 1.*?Leistung</td>.*?(\\d*)</td>.*)]" }

/* solar inverter output voltage and power phase 2 (L2) */
Number solar_out_L2_voltage   "L2 voltage [%d V]"                                { http="<[kostal-inverter-cache:30000:REGEX(.*?L2</u></td>.*?Spannung</td>.*?Spannung</td>.*?(\\d*)</td>.*)]" }
Number Solar_out_L2_power     "L2 power [%d W]"                                  { http="<[kostal-inverter-cache:30000:REGEX(.*?L2</u></td>.*?Leistung</td>.*?(\\d*)</td>.*)]" }

/* solar inverter output voltage and power phase 3 (L3) */
Number solar_out_L3_voltage   "L3 voltage [%d V]"                                { http="<[kostal-inverter-cache:30000:REGEX(.*?L3</u></td>.*?Spannung</td>.*?(\\d*)</td>.*)]" }
Number solar_out_L3_power     "L3 power [%d W]"                                  { http="<[kostal-inverter-cache:30000:REGEX(.*?L3</u></td>.*?Leistung</td>.*?(\\d*)</td>.*)]" }

To avoid loading the HTML page for each entry add a HTTP cache entry (for the HTTP binding) to your openhab.cfg like:

http:kostal-inverter-cache.url=http://pvserver:password@192.168.1.1/index.fhtml
http:kostal-inverter-cache.updateInterval=60000

Make sure you replace "password" with your password and edit the ip address!

How to send commands to Telldus Tellstick

This a simple example of how to command your tellstick devices from Openhab. For event triggered inbound integration, check the Integration with other applications page.

Please note that if you use the inbound integration you must name you item td_device_<number> where <number> is the tellstick device enumeration as listed from command: tdtool -l. Obviously you also need to change enumeration after --on and --off in the exec binding.

Item definition:

Switch td_device_5 "Tellstick device 5" {exec=">[ON:tdtool --on 5] >[OFF:tdtool --off 5]"}

How to get power on a TV connected to HDMI with exec binding and update the status automatically

This is an example of how to power on a TV connected to the openhab server via HDMI. First you have to install cec-client utility on your host (you can see more details in [page)

The next thing is use the exec and the samsung binding (I can't switch on the TV with the samsung binding, and I can't switch off with the cec-client). My item definition shows like:

Switch  TV_GF_Living_TV_power  "Power"  (GF_Living_TV)  { exec="ON:/usr/local/bin/samsungTvStart.sh, OFF:/bin/true", samsungtv="OFF:Livingroom:KEY_POWEROFF, ON:Livingroom:KEY_POWERON" }

And the script /usr/local/bin/samsungTvStart.sh is

echo 'on 0' | cec-client -s

The next thing is automatically check and update the status. I use a shell script that I run every minute with cron. The script /usr/local/bin/samsungTvCheck.sh is

#!/bin/bash
OH_URL=[OPENHAB_URL]
OH_USER=[OPENHAB_USER]
OH_PASS=[OPENHAB_PASS]
OH_ITEM=[OPENHAB_ITEM]
RESULT=`echo pow 0 | cec-client -d 1 -s | grep "power status:" | awk '{ print $3; }'`

case $RESULT in
        on)
                curl --user $OH_USER:$OH_PASS --max-time 2 --connect-timeout 2 --header "Content-Type: text/plain" --request PUT --data "ON" $OH_URL/rest/items/$OH_ITEM/state
                exit 0
                ;;
        *)
                curl --user $OH_USER:$OH_PASS --max-time 2 --connect-timeout 2 --header "Content-Type: text/plain" --request PUT --data "OFF" $OH_URL/rest/items/$OH_ITEM/state
                exit 1
esac

and you can add a line to your cron (in linux systems) with the command

crontab -e
*/1 * * * * /usr/local/bin/samsungTvCheck.sh

Note that you have to change OPENHAB_URL, [OPENHAB_PASS and [OPENHAB_ITEM] according to your installation. This script update the status of the item, and you can see if your childs has switch on the tv ;)

How to catch a Mobotix T24 bell button signal

To catch the bell ring event we make use of the Tcp/Ip binding. Please make sure to have it correctly placed in your addons directory. To configure the binding we edit the openhab.cfg and add the following lines:

######################### TCP - UDP Binding ################################### 
# 
# all parameters can be applied to both the TCP and UDP binding unless  
# specified otherwise 

# Port to listen for incoming connections 
tcp:port=3000 

# Share connections within the Item binding configurations 
tcp:itemsharedconnections=true 

# Share connections between Item binding configurationswin 
tcp:bindingsharedconnections=true 

# Share connections between inbound and outbound connections 
tcp:directionssharedconnections=false 

# Allow masks in ip:port addressing, e.g. 192.168.0.1:* etc 
tcp:addressmask=true 

# Perform all write/read (send/receive) operations in a blocking mode, e.g. the binding
# will wait for a reply from the remote end after data has been sent
tcp:blocking=false

# Timeout - or 'refresh interval', in milliseconds, of the worker thread
tcp:refreshinterval=250

# Update the status of Items using the response received from the remote end (if the
# remote end sends replies to commands)
tcp:updatewithresponse=false

Now we configure the Mobotix T24 via the web GUI

First we add a new IP-Notification profile: We use the Admin Menu and chose Transfer Profiles/IP Notify Profiles. Then we make the settings according to the screenshot:

  • We chose a name for the profile
  • We select user defined configuration
  • Destination address and port (of the openHab server)
  • Tcp/Ip as protocoll
  • Datatype just text
  • an the text you whish to send and parse on openHab
  • additionally you can configure the source port of the request. This tightens the security and you don't need to allow openHab to accept requests from any source port.

As a next step we assign this new Network Profile to the Event "CameraBellButton" i.e. when someone rings at the door.

We chose the Setup menu Event Control/Action Group Overview and add a new group

  • We add a name for the group
  • Set it active
  • And chose the event Signal:CameraBellButton

Then we add a new Action and select the previously created IP-Notification profile

Now we can create a new item in openHab e.g.

/*Bell*/

Switch  Bell {tcp="<[ON:192.168.0.101:*:'REGEX((ON))']", autoupdate="false" } // for a Switch Item that captures the ringing from the T24 Mobotix  that connects to openHAB 

The REGEX parses the TCP message for the keyword "ON" which we have set in the Mobotix configuration.

In case you want to open the door via a Switch item as well:

/*MainDoor*/

Switch MainDoor { http=">[ON:GET:http://user:password@192.168.0.101/control/rcontrol?`action=customfunction&action=sigout&profile=~Door]", autoupdate="false" }

The Camera image can be put on the openHab sitemap via:

Image url="http://user:password@192.168.0.101/record/current.jpg" refresh=1000 //Camera image with 1fps

Serial Modbus Nilan Heatpump configuration

openhab.cfg

# See: org.openhab.binding.modbus/src/main/java/net/wimpi/modbus/util/SerialParameters.java
# See: org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/ModbusBinding.java
modbus:serial.nilan.connection=/dev/ttyUSB0:19200:8:even:1:rtu
modbus:serial.nilan.id=30

modbus:serial.nilan.start=200
modbus:serial.nilan.length=16
modbus:serial.nilan.type=input
modbus:serial.pollinterval=2000

modbus:serial.nilan.valuetype=int16

# write out nilan connection
modbus:writemultipleregisters=true
modbus:serial.nilan2.connection=/dev/ttyUSB0:19200:8:even:1:rtu
modbus:serial.nilan2.id=30
modbus:serial.nilan2.start=1001
modbus:serial.nilan2.length=4
modbus:serial.nilan2.type=holding

rules/demo.rules

/* nilan computations */
rule "nilan t0-15 sensor division"
when 
	Time cron "0/1 * * * * ?" or
	System started
then
	heat_nilan?.members.forEach(sourceEl| {
			var Number temp = (sourceEl.state as DecimalType) 
			if(temp > 0x8000) {temp = temp - 0xFFFF }
			temp = temp / 100
			
			nilan_aggregated?.members.forEach[targetEl |
				if(targetEl.name.toString == sourceEl.name.toString + "_div"){
					postUpdate(targetEl, temp)
				} ]
		}
	)
end

items/demo.item

/* Nilan */
Group heat_nilan (All)
Number nilan_t0		"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:0"}
Number nilan_t1		"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:1"}
Number nilan_t2		"t2_tmp variable [%2.2f °C]" 		<temperature> (heat_nilan)		{modbus="nilan:2"}
Number nilan_t3		"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:3"}
Number nilan_t4		"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:4"}
Number nilan_t5		"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:5"}
Number nilan_t6		"temporary variable will be processed in .rules file[%2.2f °C]" 		<temperature> (heat_nilan)	{modbus="nilan:6"}
Number nilan_t7		"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:7"}
Number nilan_t8		"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:8"}
Number nilan_t9		"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:9"}
Number nilan_t10	"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:10"}
Number nilan_t11	"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:11"}
Number nilan_t12	"temporary variable will be processed in .rules file[%2.2f °C]" 		<temperature> (heat_nilan)	{modbus="nilan:12"}
Number nilan_t13	"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:13"}
Number nilan_t14	"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:14"}
Number nilan_t15	"temporary variable will be processed in .rules file" 		<temperature> (heat_nilan)		{modbus="nilan:15"}

Group nilan_aggregated (All)
Number nilan_t0_div		"Controller board (t0) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t1_div		"Fresh air intake (t1) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t2_div		"Inlet (before heater) (t2) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t3_div		"Room exhaust (t3) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t4_div		"Outlet (t4) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t5_div		"Condenser (t5) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t6_div		"Evaporator (t6) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t7_div		"Inlet (after heater) (t7) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t8_div		"Outdoor (t8) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t9_div		"Heating surface (t9) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t10_div	"External room (t10) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t11_div	"Boiler Top (t11) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t12_div	"Boiler Bottom (t12) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t13_div	"EK return (t13) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t14_div	"EK supply (t14) [%2.2f °C]" <temperature> (nilan_aggregated)
Number nilan_t15_div	"User Panel room (t15) [%2.2f °C]" <temperature> (nilan_aggregated)

Switch nilan_onoff	"Device main power"		(heat_nilan) {modbus="nilan2:0"}
Number nilan_user_operation_mode "User operation mode" (heat_nilan) {modbus="nilan2:1"}
Number nilan_vent	"User ventilation step select [Level]" (heat_nilan) {modbus="nilan2:2"}
Number nilan_user_tempset	"User temperature selection [%d °C]" (heat_nilan) {modbus="nilan2:3"}
Number nilan_user_tempset_div "User temperature selection [%d °C]" (nilan_aggregated)

sitemaps/demo.sitemap

sitemap demo label="Main Menu"
{
Frame label="Nilan Overview" {
	Text item=nilan icon="firstfloor" label="Nilan heatpump" {
		Frame {
			Switch item=nilan_onoff
			Selection item=nilan_user_operation_mode mappings=[0="Off", 1="Heat", 2="Cool", 3="AUTO", 4="Service"]
			Switch item=nilan_vent mappings=[1="1", 2="2", 3="3", 4="4"]
			Text item=nilan_user_tempset_div
			
			Text item=nilan_t15_div
			Text item=nilan_t11_div valuecolor=[>45="green",<=40"blue",<20"red"]
			Text item=nilan_t12_div valuecolor=[>45="green",<=45"blue",<20"red"]
			
			Text item=nilan_t7_div
			Text item=nilan_t10_div
		}
		Frame {
			//in & outlets
			Text item=nilan_t1_div
			Text item=nilan_t4_div
			Text item=nilan_t8_div
			Text item=nilan_t5_div
			Text item=nilan_t6_div
			
			Text item=nilan_t0_div
			Text item=nilan_t2
			//Text item=Weather_Humidity
		}
	}
}
}

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
You can’t perform that action at this time.