openhab-docs/_addons_bindings/lirc
Yannick Schaus c0eef8b525
Partial merge final -> final-stable (#1569)
This performs a selective merge of the current docs into the "stable" branch
that will hold the default docs for the 3.0.2 release (until they're
replaced with the current ones once 3.1 is released).

* Backport bindings docs that looked applicable to 3.0
* Revert UI components changes not in stable

Signed-off-by: Yannick Schaus <github@schaus.net>

Co-authored-by: openHAB Build Server <infrastructure@openhab.org>
Co-authored-by: stefan-hoehn <stefan.hoehn@aoe.com>
Co-authored-by: jimtng <2554958+jimtng@users.noreply.github.com>
Co-authored-by: Matt <lawrence.matt@gmail.com>
Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
Co-authored-by: Kai Kreuzer <kai@openhab.org>
Co-authored-by: Felix Schneider <45742226+Trysupe@users.noreply.github.com>
Co-authored-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
Co-authored-by: J-N-K <J-N-K@users.noreply.github.com>
Co-authored-by: Eiko Wagenknecht <eiko.wagenknecht@web.de>
Co-authored-by: Alexander Behring <github.com@alexander-behring.eu>
Co-authored-by: Matthew Skinner <matt@pcmus.com>
Co-authored-by: Christoph Weitkamp <github@christophweitkamp.de>
Co-authored-by: Patrick Fink <mail@pfink.de>
Co-authored-by: Gifford47 <49484063+Gifford47@users.noreply.github.com>
Co-authored-by: Seganku <seganku@users.noreply.github.com>
Co-authored-by: digitlength <62958838+digitlength@users.noreply.github.com>
Co-authored-by: Ross Kennedy <rossko@culzean.clara.co.uk>
Co-authored-by: Fabian Wolter <github@fabian-wolter.de>
Co-authored-by: Arjan Mels <43108771+arjanmels@users.noreply.github.com>
Co-authored-by: Jonathan Gilbert <github.10.jgilbert@xoxy.net>
Co-authored-by: Richard Koshak <rkoshak@users.noreply.github.com>
Co-authored-by: Wolfgang Schueschen <76775650+WolfgangSn@users.noreply.github.com>
Co-authored-by: Gareth Western <gareth@garethwestern.com>
Co-authored-by: Bob A <bobadair@users.noreply.github.com>
Co-authored-by: Sami Salonen <ssalonen@gmail.com>
Co-authored-by: Peter Schraffl <p.schraffl@gmx.at>
Co-authored-by: Georgios Moutsos <50378548+jossuar@users.noreply.github.com>
Co-authored-by: Markus Storm <markus.storm@gmx.net>
Co-authored-by: JensHoRi <47488279+JensHoRi@users.noreply.github.com>
Co-authored-by: Felix <24674809+fex01@users.noreply.github.com>
Co-authored-by: Koen Schockaert <54985218+QbusKoen@users.noreply.github.com>
Co-authored-by: Ethan Dye <mrtops03@gmail.com>
Co-authored-by: Senne Croughs <38940112+sencro@users.noreply.github.com>
Co-authored-by: Ben Clark <ben@benjyc.uk>
Co-authored-by: Sam Spencer <43712250+samsp99@users.noreply.github.com>
Co-authored-by: chingon007 <76529461+chingon007@users.noreply.github.com>
Co-authored-by: Wouter Born <github@maindrain.net>
Co-authored-by: mueller-ma <mueller-ma@users.noreply.github.com>
Co-authored-by: aurelio1 <aurelio@caliaro.net>
Co-authored-by: Bernd Weymann <bernd.weymann@gmail.com>
Co-authored-by: Martin Hogg <hoggm2@hotmail.co.uk>
2021-05-15 15:11:12 +02:00
..
readme.md Partial merge final -> final-stable (#1569) 2021-05-15 15:11:12 +02:00

readme.md

id label title type description since logo install
lirc LIRC LIRC - Bindings binding This binding integrates infrared transceivers through [LIRC](https://www.lirc.org) or [WinLIRC](http://winlirc.sourceforge.net). 3x images/addons/lirc.png auto

{% include base.html %}

LIRC Binding

This binding integrates infrared transceivers through LIRC or WinLIRC.

A list of remote configuration files for LIRC is available here.

Supported Things

This binding supports LIRC and WinLIRC as bridges for accessing the configured remotes.

LIRC must be started with TCP enabled. On systemd based systems, TCP can be enabled by editing the file /usr/lib/systemd/system/lirc.service and adding --listen to the end of the ExecStart line. An example systemd service file for LIRC is shown below.

[Unit]
Description=Linux Infrared Remote Control
After=network.target

[Service]
RuntimeDirectory=lirc
ExecStart=/usr/sbin/lircd --nodaemon --driver=default --device=/dev/lirc0 --listen

[Install]
WantedBy=multi-user.target

By default, LIRC will listen on IP address 0.0.0.0 (any available IP address) and port 8765. If you would rather run LIRC on a specific port or IP address, you can use --listen=192.168.1.100:9001 instead.

Discovery

Discovery of the LIRC bridge is not supported. However, remotes will be automatically discovered once a bridge is configured.

Example Configuration

Things

Bridge lirc:bridge:local [ host="192.168.1.120", portNumber="9001" ] {
    Thing remote Onkyo_RC_799M [ remote="Onkyo_RC-799M" ]
    Thing remote Samsung [ remote="Samsung" ]
}

Bridge:

  • host: IP address or hostname of the LIRC server. Defaults to localhost
  • port: The port number the LIRC server is listening on. Defaults to 8765

Remote:

  • remote: The name of the remote as known by LIRC

Items

String Remote_AVReceiver { channel="lirc:remote:local:Onkyo_RC_799M:transmit" }
String Remote_TV { channel="lirc:remote:local:Samsung:transmit" }

Rules

rule "LIRC Test"
when
    Channel 'lirc:remote:local:Samsung:event' triggered KEY_DVD
then
    // Toggle base boost on the AV Receiver
    Remote_AVReceiver.sendCommand("KEY_BASEBOOST")
    // Increase the volume by 5.
    Remote_AVReceiver.sendCommand("KEY_VOLUMEUP 5")
end

Channels

This binding currently supports following channels:

Channel Type ID Item Type Description
event Trigger Triggers when a button is pressed.
transmit String Used to transmit IR commands to LIRC.