Ir Trans Binding

kgoderis edited this page Aug 24, 2014 · 5 revisions

Documentation of the IRtrans binding Bundle


The IRtrans binding bundle is available as a separate (optional) download. If you want to let openHAB communicate with the infrared emitter/transceiver of IrTrans (, please place this bundle in the folder ${openhab_home}/addons and add binding information to your configuration. See the following sections on how to do this. Note: the IRtrans binding makes use of the TCP/UDP binding, and therefore also the TCP binding has to be copied into the ${openhab_home}/addons folder

The IRtrans binding currently supports the Ethernet version of the IRtrans transceiver and communicates with the transceiver over a TCP connection

Generic Item Binding Configuration

In order to bind an item to an ethernet transceiver, 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 IrTrans binding configuration string is explained here:

The format of the binding configuration is simple and looks like this:

irtrans="[<command>:<ip address>:<port>:<led>:<device>:<ircommand>], [<command>:<ip address>:<port>:<led>:<device>:<ircommand>], ..."

where <ip address> is the hostname or ip address in dotted notation of the remote host

where <led> is the transceiver led to be used to send or receive the infrared command, and is one of the following values: DEFAULT, INTERNAL, EXTERNAL, ALL, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT. Note: It is up to the user to check that the led value is valid for the device installed, e.g. not all IRtrans transceivers have the same number of led transmitters or received built-in. See the documentation of your IRtrans device

where <device> is the name of the device (category), as defined using the IRtrans LAN Server software

and where,finally, <ircommand> is the name of the infrared command, as defined using the IRtrans LAN Server software, to be sent to the transceiver when <command> is received. When an infrared command is received by the transceiver that matches the <device>:<ircommand>, then the Item will be updated with the <command>

It is possible to define 'wildcards' for <device> and <ircommand> : if either of them are equal to ** then respectively, any device that defines the given <ircommand>, or any <ircommand> for the given <device>, will 'match' and will trigger the status update of the Item. If you would put ** for both <device> and <ircommand> then any infrared command received by the transceiver will cause the Item to be updated.

Note: the IRtrans device does not communicate which <led> a command is received by, so that information can not be used to wildcard infrared commands received

Note: If the Item is of the type String, then any infrared command received by the transceiver will cause the Item to be updated with "<device>,<ircommand>". Likewise, any string passed on by the OpenHAB runtime will simply be parsed using the "<device>,<ircommand>" pattern. For such Items the <command> element has to be omitted in the configuration string

Here are some examples of valid binding configuration strings:

 irtrans="[ON:]" // send the 'voldown' infrared command of remote type 'pioneer' when ON is received
 irtrans="[ON:*]" // accept any command from remote of type Pioneer, e.g. any key press on the remote
 irtrans="[ON:*:pioneer:voldown]" // send command on all leds
 irtrans="[ON:*:*]" // accept all infrared commands from any type of remote
 irtrans="[*:*]" // for String Items, take or update 'remote,command' strings that match the pattern

As a result, your lines in the items file might look like the following: Switch PioneerReceiver_Vol "Pioneer" (AV) { irtrans="*[ON:], *[OFF:]" }

feature overview


Setup intro

Linux and OS X





User Interfaces



(link to openHAB forum)



Application Integration



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


Syntax highlighting for external editors

Release Notes

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.