Difference between revisions of "LIRC"

From ArchWiki
Jump to: navigation, search
m (merged the conf.d/alternate service file sections, cleaned up language)
(reword into 3rd person and cleanup)
 
(137 intermediate revisions by 24 users not shown)
Line 1: Line 1:
 
[[Category:Other hardware]]
 
[[Category:Other hardware]]
[[Category:Audio/Video]]
+
[[ja:LIRC]]
{{Article summary start}}
+
{{Article summary text|This article covers using LIRC with serial or USB infrared devices.}}
+
{{Article summary end}}
+
  
[http://lirc.org/ LIRC] stands for "Linux Infrared Remote Control", a program to use infrared devices (like your remote control from your TV) with linux.
+
This article covers setup and usage of [http://lirc.org/ LIRC] "Linux Infrared Remote Control" with serial or USB infrared devices.
  
==Supported hardware==
+
LIRC is a daemon that can translate key presses on a supported remote into program specific commands.  In this context, the term, "program specific" means that a key press can do different things depending on which program is running and taking commands from LIRC.
  
First of all, check the [http://lirc.org/html/table.html official list of supported hardware]. Check the table to know, which LIRC kernel modules and lircd driver required for your infrared receiver.
+
The Central Dogma of LIRC (an allusion to the [http://www.ncbi.nlm.nih.gov/Class/MLACourse/Modules/MolBioReview/central_dogma.html flow of information] in biological systems) is summarized below wherein the flow of information from the remote to the application is summarized with LIRC at the center of it all:
  
==Installation==
+
* User hits a button on the remote causing it to transmit an IR or RF signal.
 +
* The signal is received by the receiver connected to the Linux box.
 +
* The kernel (via the correct module) use presents pulse data from the remote on a device like /dev/lirc0, /dev/input/eventX, /dev/ttyUSBX or /dev/ttyS0.
 +
* {{ic|/usr/bin/lircd}} uses the information from {{ic|/etc/lirc/lircd.conf.d/foo.conf}} to convert the pulse data into button press information.
 +
* Programs that use LIRC translate the button press info from {{ic|/usr/bin/lircd}} into user-defined actions according to {{ic|~/.lircrc}} or to program-specific mappings.
  
[[pacman|Install]] the {{Pkg|lirc-utils}} package, which is available in the [[Official Repositories|official repositories]].
+
== Installation ==
  
The most of LIRC kernel drivers are already included in the mainline kernel. You need to install {{Pkg|lirc}} package only, if your hardware requires lirc_atiusb, lirc_i2c or lirc_wpc8769l modules.
+
[[Install]] the {{Pkg|lirc}} package.
  
==Serial receivers==
+
== Configuration ==
  
===Serial receivers that depend on lirc_serial===
+
{{Note|This section is a quick summary. Complete documentation is available [http://lirc.sourceforge.net/lirc.org/html/index.html upstream].}}
  
Make sure that your serial port is activated in the BIOS. There you can also set and lookup I/O address and IRQ settings of your ports.
+
{{ic|/etc/lirc/lircd.conf.d/foo.conf}} is the system-wide configuration translating scancodes --> keys. This directory may contain multiple conf files and each one is specific to each remote control/receiver on the system. These files are user-created config files and not directly supplied by {{Pkg|lirc}}.
  
Now there might be a problem: the module lirc_serial is build to use ttyS0 (COM1), if your device is not connected to ttyS0, you will have to either change the module-options or [[LIRC#Building_the_LIRC_serial_module_for_another_ttySx|rebuild the LIRC module]]If your device is connected to ttyS0, you can [[LIRC#Loading|skip this step]]
+
The definition of scancodes to keymaps is required to allow LIRC to manage a remoteUsers have several options to obtain one.
  
To change the options for the lirc_serial module, you edit {{ic|/etc/modprobe.d/modprobe.conf}} and add this line:
+
=== Upstream provided ===
  
  options lirc_serial io=0x2f8 irq=3
+
Identify which remote/receiver is to be used and see if there is a known config for it. One can use {{ic|irdb-get}} to search the [http://lirc-remotes.sourceforge.net/remotes-table.html remotes database] or simply browse to the URL and do the same.
  
You should change the values after io and irq to reflect you serial port settings, the values above may work for you if you are using ttyS1 (COM2) to connect your IR-device. But you will find the correct values by checking dmesg:
+
An example using {{ic|irdb-get}} to find a config file for a Streamzap remote:
  
  $ dmesg | grep ttyS
+
  $ irdb-get find stream
 +
atiusb/atiusb.lircd.conf
 +
digital_stream/DTX9900.lircd.conf
 +
snapstream/Firefly-Mini.lircd.conf
 +
streamzap/PC_Remote.lircd.conf
 +
streamzap/streamzap.lircd.conf
 +
x10/atiusb.lircd.conf
 +
 +
$ irdb-get download streamzap/streamzap.lircd.conf
 +
Downloaded sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/streamzap/streamzap.lircd.conf as streamzap.lircd.conf
  
===Other serial receivers===
+
Once identified, copy the needed conf to {{ic|/etc/lirc/lircd.conf.d/}} to allow the daemon to initialize support for it.
  
See [[LIRC#Other_receivers]]
+
# cp streamzap.lircd.conf /etc/lirc/lircd.conf.d/
  
===Building the lirc_serial module for another ttySx===
+
=== User created ===
  
Update abs
+
Users with unsupported hardware will need to either find a config file someone else has created (i.e. google) or create one.  Creating one is fairly straightforward using {{ic|/usr/bin/irrecord}} which guides users along the needed process.  If using a detected remote, invoke it like so:
  
  # abs
+
  # irrecord --device=/dev/lirc0 MyRemote
  
Copy the LIRC files to a directory you choose yourself:
+
The program will instruct users to begin hitting keys on the remote in an attempt to learn it, ultimately mapping out every button and its corresponding scancode.  The process should take no more than 10 minutes.  When finished, save the resulting file to {{ic|/etc/lirc/lircd.conf.d/foo.conf}} and proceed.
  
$ cp /var/abs/extra/system/lirc /some/dir
+
{{Note|Consider sending the finished config file to the email address mentioned in the program so it can be made available to others.}}
  
$ cd /some/dir
+
=== Optional files ===
  
Edit the PKGBUILD in that directory.
+
Depending on the application using LIRC, the following are optional.  For example, {{Pkg|mplayer}} and {{Pkg|mythtv}} use the these files to define key maps and actions.  Some other programs such as {{Pkg|kodi}} for example do not make use of this at all but do have an internal system to achieve these mappings.  Users should consult the documentation for the specific application to know if modifications to {{ic|~/.lircrc}} are needed.
  
Replace the line:
+
* {{ic|~/.lircrc}} - File containing an '''include''' statement pointing to each program's lirc map, i.e., {{ic|~/.lirc/foo}}, {{ic|~/.lirc/bar}}, etc.
 +
* {{ic|~/.lirc/foo}} - User-level config translating of keys --> actions.  Is specific to each remote and to application foo.
  
./configure --enable-sandboxed --prefix=/usr \
+
== Usage ==
    --with-driver=all \\
+
    return 1[/code]
+
  
with:
+
[[Start]] {{ic|lircd.service}} and [[enable]] it to run at boot time/shutdown (recommended).
  
./configure --enable-sandboxed --prefix=/usr \
+
Test the remote using {{ic|/usr/bin/irw}}, which simply echos anything received by LIRC when users push buttons on the remote to stdout.
    --with-driver=com2 \
+
    || return 1[/code]
+
  
Where you replace com2 with the com-port you need.
+
Example:
 
+
Build and install the package:
+
 
+
$ makepkg
+
# pacman -U lirc-version.pkg.tar.gz
+
 
+
===Loading===
+
 
+
Now try to load the serial module:
+
 
+
# modprobe lirc_serial
+
 
+
If this produces an error which says your serial port is not ready, you have the problem that your serial port support is build into the kernel and not as a module (in the default arch kernel it is build into the kernel)
+
 
+
If it is built into the kernel you will have to do the following (remember that it is built into the kernel, you will need to make some changes later too)
+
 
+
You will have to release the serial port:
+
 
+
# setserial /dev/ttySx uart none
+
 
+
(Replace x with your port number)
+
 
+
Load the module again:
+
 
+
# modprobe lirc_serial
+
 
+
Now it should not show any errors, and the modules lirc_serial should be listed in lsmod
+
 
+
==USB receivers including most onboard devices==
+
This outlines the general procedure, the mceusb module which is used by many devices is used as an example.
+
 
+
# modprobe mceusb
+
 
+
Start the LIRC daemon:
+
 
+
$ /etc/rc.d/lircd start
+
 
+
Test it with irw, it will output the commands received by the IR receiver that match your {{ic|lircd.conf}} file. So start irw, point your remote and start pressing buttons.
+
  
 
  $ irw
 
  $ irw
Line 110: Line 79:
 
  000000037ff07bf2 01 Home mceusb
 
  000000037ff07bf2 01 Home mceusb
  
The above procedure however has been simplified and may not work that easily. One of the reasons the lircd daemon may not be working is because it expects to be run at startup and needs root permissions because it will create device nodes in {{ic|/dev}}. Try "man lircd" for more information.
+
If {{ic|irw}} gives no output, double check the config files in {{ic|/etc/lirc/lircd.conf.d/}} for errors.
  
Continue with [[#Making a configuration file]]
+
== Program Specific Configuration ==
  
=== Setup a HID device with LIRC ===
+
{{Merge|LIRC#Optional|or the other way around}}
Some remotes are supported in the kernel where they are treated as a keyboard and mouse.  Every button on the device is recognized as keyboard or mouse events which can be used even without LIRC.  LIRC can still be used with these devices to gain greater control over the events raised and integrate with programs that expect a LIRC remote rather than a keyboard.  As drivers are migrated to the kernel, devices which use to only be useable through LIRC with their own {{ic|lirc.conf}} files become standard HID devices.
+
  
Some HID remotes actually simulate a USB infrared keyboard and mouseThese remotes show up as two devices so you need to add two LIRC devices to {{ic|lircd.conf}}.
+
LIRC has the ability to allow for different programs to use the same keypress and result in unique commandsIn other words, one can setup different programs to respond differently to a given key press.
  
First we need the {{ic|/dev/input}} device for our remote:
+
* Decide which programs are to use LIRC commands.
  
  $ ls /sys/class/rc/rc0
+
{{Note|Common programs include: {{Pkg|mplayer}}, {{Pkg|mythtv}}, {{Pkg|totem}}, {{Pkg|vlc}}, and {{Pkg|kodi}} but not all programs will use this particular method to map keys.  {{Pkg|kodi}} for example, implements LIRC in a non-standard way.  Users must edit {{ic|~/.xbmc/userdata/Lircmap.xml}} which is a unique xml file, rather than the LIRC standard files the rest of the programs use.  Interested users should consult [[Kodi#Using a remote control]].}}
  
One of the files should be input''#'', where the number matches the event''#'' of the device.  (To clarify you can check that directory, it will have an event''#'' file.
+
* Create the expected files showing LIRC where the various program-specific maps reside:
  
{{Note|If you have more than one ir device then there may be multiple directories under {{ic|/sys/class/rc}}Under event''#'' {{ic|cat name}} to verify which device you are looking at.}}
+
$ mkdir ~/.lirc
 +
  $ touch ~/.lircrc
  
then go to {{ic|/dev/input/by-id}}
+
* Populate {{ic|~/.lirc}} with the program specific config files named for each program.
  
  $ ls -l /dev/input/by-id
+
Example:
  
You should find a file that symlinks to the input''#'' above, and possibly others with a similar names for mouse events.
+
$ ls ~/.lirc
 +
mplayer
 +
mythtv
 +
vlc
  
  lrwxrwxrwx 1 root root  9 10月 14 06:43 usb-3353_3713-event-if00 -> ../event9
+
{{Tip|Many pre-made files unique to each remote/program are available via googling. Providing an exhaustive listing of keymaps for each program is beyond the scope of this article.}}
  lrwxrwxrwx 1 root root 10 10月 14 06:43 usb-3353_3713-event-if01 -> ../event10
+
  
Here 'usb-3353_3713-event-if00' and 'usb-3353_3713-event-if01' are the Linux input device event for our HID device, one for the keyboard, another for the mouse.
+
* Edit {{ic|~/.lircrc}} to contain an '''include''' statement pointing to {{ic|~/.lirc/foo}} and repeat for each program that is to be controlled by LIRC.
  
Then, we need to edit {{ic|/etc/conf.d/lircd.conf}}.  This file contains the parameters for LIRC daemon
+
Example:
 
+
{{hc|~/.lircrc|
  #
+
include "~/.lirc/mplayer"
  #Parameters for daemon
+
include "~/.lirc/mythtv"
  #
+
include "~/.lirc/vlc"
 
+
  LIRC_DEVICE="/dev/input/by-id/usb-3353_3713-event-if00"
+
  LIRC_DRIVER="devinput"
+
  LIRC_EXTRAOPS=""
+
  LIRC_CONFIGFILE="/etc/lirc/lircd.conf"
+
 
+
{{Note|Here we set up a LIRC device with the id 3353_3713, you should replace it with your own device input event name, whatever it is.}}
+
 
+
The latest version of the config file for HID remotes exists in the LIRC git repository [http://lirc.git.sourceforge.net/git/gitweb.cgi?p=lirc/lirc;a=blob_plain;f=remotes/devinput/lircd.conf.devinput;hb=HEAD].  Simply save it as {{ic|/etc/lirc/lircd.conf}}.
+
 
+
In order to launch the LIRC daemon for HID remote, You must enable evdev module first
+
# modprobe evdev
+
 
+
{{Note|LIRC 0.8.6 has changed the default socket location from {{ic|/dev/lircd}} to {{ic|/var/run/lirc/lircd}}, but many applications still look for the socket in the old location. Since lirc-utils 0.8.6-3 the {{ic|/etc/rc.d/lircd}} script creates a symlink from {{ic|/dev/lircd}} to the {{ic|/var/run/lirc/lircd}} socket when it starts the lircd daemon and removes the link when the daemon is stopped.}}
+
 
+
==Other receivers==
+
 
+
There are many receivers that do not need any kernel module at all. This applies to any type of receiver, including serial receivers and usb receivers. Check the next link to see what kernel modules you need to load, if any:
+
 
+
[http://www.lirc.org/html/table.html LIRC supported devices]
+
 
+
==Checking module based receivers==
+
 
+
''NOTE: This section only applies if your device requires a lirc_[driver] kernel module.''
+
 
+
Before you start using lirc, you should check if your receiver is working, and if there is IR interference. Possible sources of interference include monitors/televisions (especially plasma displays), fluorescent lamps and direct or ambient sunlight. Start the following command to display raw receiver input.
+
 
+
# mode2 -d /dev/lirc0
+
 
+
If you press buttons on any IR remote, you should see a series of pulses and spaces. If there is very frequent output without pressing buttons on your remote, your receiver suffers from interference. You want to avoid such interference, e.g. by placing the receiver behind or under your plasma tv.
+
 
+
If you can't make out where the interference is coming from, you can try to put a cardboard roll right in front of the receiving diode, so that it only gets light from a specific direction. Invoke mode2 as above. Then point at different locations till you receive IR noise.
+
 
+
==LIRC daemon configuration==
+
 
+
The lircd configuration lives under /etc/conf.d/lircd.conf, and it is all you need to setup your device if it does not require any special kernel module.
+
 
+
{{Box|IMPORTANT:|lirc-utils package on ArchLinux has a bug. You will have to create your own systemd unit or find another workaround. See [https://bugs.archlinux.org/task/31890 bug#31890] |#DF0000|#FFDFDF}}
+
 
+
==Making a configuration file==
+
 
+
You need a configuration file for your remote control copied or symlinked to {{ic|/etc/lirc/lircd.conf}}. A number of devices have already been included with the lirc package, they can be found in {{ic|/usr/share/lirc}}. If your specific device is not included, the LIRC site offers configuration files for a large number of extra [http://lirc.sourceforge.net/remotes/ devices].
+
 
+
If your device does not already have a config file, you can create it yourself with the following command. You should avoid interference (see above) while creating the config file.
+
 
+
# irrecord -d /dev/lirc0 /tmp/my_remote
+
 
+
Just follow the instructions. To get a list of valid button names, refer to the output of
+
# irrecord --list-namespace
+
The resulting file, {{ic|/tmp/my_remote}}, should then be copied to {{ic|/etc/lirc/lircd.conf}}. If you want to use several remotes, you repeat the irrecord step with each remote and different filenames, and then concatenate all the resulting files into {{ic|/etc/lirc/lircd.conf}}:
+
 
+
# cat /tmp/my_remote /tmp/my_remote2 /tmp/my_remote3 > /etc/lirc/lircd.conf
+
 
+
{{Note|As of lirc-0.8.6 the default location of lircd, lircmd and lircrcd config files was moved to {{ic|/etc/lirc/lircd.conf}}, {{ic|/etc/lirc/lircmd.conf}} and {{ic|/etc/lirc/lircrc}}. If the config files are not found in that location, they are still searched at the old location in {{ic|/etc/.}}}}
+
 
+
===Testing===
+
 
+
First start the lircd daemon:
+
 
+
# /etc/rc.d/lircd start
+
 
+
A good way to see if LIRC is running is to run irw.
+
 
+
$ irw
+
 
+
When you press a button, you should see something like this:
+
 
+
0000000000000001 00 play sony2
+
0000000000000001 01 play sony2
+
0000000000000001 02 play sony2
+
0000000000000001 03 play sony2
+
 
+
In this case the remote is called sony2, the button is called play, and LIRC has seen it 4 times.
+
 
+
==Run LIRC at bootup==
+
 
+
Remember if you had to execute the setserial command while [[LIRC#Loading|loading]] the module?
+
 
+
If so, [[LIRC#Your serial port support is compiled into the kernel|your serial port support is compiled into the kernel]]
+
 
+
===Your serial port support is compiled as a module in the kernel===
+
 
+
This is rather easy: you will just have to add lirc_serial to the modules list and lircd to the daemons list in {{ic|/etc/rc.conf}}
+
 
+
===Your serial port support is compiled into the kernel===
+
 
+
This is more complicated, you cannot just add the lirc_serial to the modules list in {{ic|/etc/rc.conf}}, as the serial port should be released first.
+
 
+
So I created a custom startup script to fix this problem.
+
 
+
{{hc|/etc/rc.d/start_lirc|<nowiki>
+
#!/bin/bash
+
#/etc/rc.d/start_lirc
+
#releases ttySx and loads lirc_serial module
+
+
. /etc/rc.conf
+
. /etc/rc.d/functions
+
+
case "$1" in
+
  start)
+
    stat_busy "release ttySx"
+
    setserial /dev/ttySx uart none
+
    #load lirc module
+
    modprobe lirc_serial
+
    stat_done
+
    ;;
+
  stop)
+
    stat_busy "unload lirc module"
+
    rmmod lirc_serial
+
    stat_done
+
    ;;
+
  restart)
+
    $0 stop
+
    $0 start
+
    ;;
+
  *)
+
    echo "usage: $0 {start|stop|restart}"
+
esac
+
exit 0
+
</nowiki>}}
+
 
+
Now load the daemons: add "start_lirc" and "lircd" to the daemons list in {{ic|/etc/rc.conf}}
+
 
+
==Program specific configuration==
+
 
+
===Generate your own lircrc with Mythbuntu's lircrc-generator===
+
 
+
'''mythbuntu-lircrc-generator''' is intended to be started from a system with LIRC installed. It requires that you  choose a remote via the LIRC package or have a {{ic|lircd.conf}} handy prior to running. It will then produce a sane {{ic|.lircrc}} for the current user.
+
 
+
[https://aur.archlinux.org/packages.php?ID=33849 Mythbuntu's Lirc/Lircrc Generator is available on AUR]<br/>
+
[http://manpages.ubuntu.com/manpages/intrepid/man1/mythbuntu-lirc-generator.1.html Man page]
+
 
+
===Enable LIRC support in xine===
+
 
+
Now LIRC works, but you have no program that can communicate with LIRC.  This section will explain how to make xine work, but you can use xmms and mplayer (and probably a lot of other programs too) to work with LIRC.
+
 
+
====Compile xine with LIRC support====
+
Download the xine-ui PKGBUILD with [https://wiki.archlinux.org/index.php/Arch_Build_System ABS].
+
 
+
Add " --enable-lirc" to the {{ic|./configure}} line
+
 
+
Compile:
+
 
+
$ makepkg
+
 
+
Uninstall old xine-ui and install the new one
+
 
+
# pacman -R xine-ui
+
# pacman -U xine-filename.pkg.tar.gz
+
 
+
====Configure xine to use LIRC====
+
 
+
Let xine produce a default {{ic|.lircrc}} file.  In your home directory, type:
+
+
$ xine --keymap=lirc>.lircrc
+
 
+
Now, in order to have a functioning xine+lirc, edit the {{ic|.lircrc}} file to your preferences.
+
 
+
However, you may choose to configure LIRC to control more than just xine. If this is the case, you will need to manually edit the {{ic|.lircrc}} file, and add elements.
+
 
+
Xine-ui
+
Mplayer
+
Totem
+
Vlc
+
Rhythmbox
+
 
+
All work with LIRC, but you must enable LIRC support in the program in some cases, such as VLC. Simply copy the vlc packagebuild and edit it so that "--enable-lirc" is one of the compile options for VLC not FFMPEG!
+
 
+
===Configure Amarok2 to use LIRC===
+
 
+
Depending on your controller model, the following configuration works with Amarok2-svn. This configuration file will work with the MCEUSB controller.
+
 
+
{{hc|~/.lircrc|2=##amarok2
+
 
+
begin
+
button = Play
+
prog  = irexec
+
repeat = 0
+
config = qdbus org.mpris.amarok /Player Play
+
end
+
 
+
begin
+
button = Pause
+
prog  = irexec
+
repeat = 0
+
config = qdbus org.mpris.amarok /Player Pause
+
end
+
 
+
begin
+
button = Stop
+
prog  = irexec
+
repeat = 0
+
config = qdbus org.mpris.amarok /Player Stop
+
end
+
 
+
begin
+
button = Skip
+
prog  = irexec
+
repeat = 0
+
config = qdbus org.mpris.amarok /Player Next
+
end
+
 
+
begin
+
button = Replay
+
prog  = irexec
+
repeat = 0
+
config = qdbus org.mpris.amarok /Player Prev
+
end}}
+
 
+
===Configure Audacious(2) to use LIRC===
+
Depending on your controller model, the following configuration works with all versions of Audacious, including the mercurial builds. This configuration file will work with the MCEUSB controller.
+
 
+
{{hc|~/.lircrc|2=##audacious
+
 
+
begin
+
    prog = audacious
+
    button = Play
+
    config = PLAY
+
    repeat = 0
+
end
+
 
+
begin
+
    prog = audacious
+
    button = Pause
+
    config = PAUSE
+
    repeat = 0
+
end
+
 
+
begin
+
    prog = audacious
+
    button = Stop
+
    config = STOP
+
    repeat = 0
+
end
+
 
+
begin
+
    prog = audacious
+
    button = Skip
+
    config = NEXT
+
    repeat = 0
+
end
+
 
+
begin
+
    prog = audacious
+
    button = Replay
+
    config = PREV
+
    repeat = 0
+
end
+
 
+
begin
+
    prog = audacious
+
    button = VolUp
+
    config = VOL_UP
+
    repeat = 1
+
end
+
 
+
begin
+
    prog = audacious
+
    button = VolDown
+
    config = VOL_DOWN
+
    repeat = 1
+
end}}
+
 
+
Additionally, there are other values that may be set according to the model set forth above. This was taken from the lirc.c file from audacious-plugins source code:
+
 
+
{{hc|lirc.c|PLAY
+
STOP
+
PAUSE
+
PLAYPAUSE
+
NEXT
+
PREV
+
SHUFFLE
+
REPEAT
+
FWD
+
BWD
+
VOL_UP
+
VOL_DOWN
+
QUIT
+
MUTE
+
BAL_LEFT
+
BAL_RIGHT
+
BAL_CENTER
+
LIST
+
PLAYLIST_CLEAR
+
PLAYLIST_ADD}}
+
 
+
===Configure Mplayer to use LIRC===
+
 
+
{{hc|~/.lircrc|2=##mplayer
+
 
+
begin
+
    button = PLAY/PAUSE
+
    prog = mplayer
+
    config = pause
+
    repeat = 1
+
end
+
begin
+
    button = FWD
+
    prog = mplayer
+
    config = seek 5
+
end
+
begin
+
    button = REV
+
    prog = mplayer
+
    config = seek -5
+
end
+
begin
+
    button = MAXIMIZE
+
    prog = mplayer
+
    config = vo_fullscreen
+
end
+
 
}}
 
}}
  
only change PLAY/PAUSE, FWD etc. on keys from your /etc/lircd.conf
+
== Troubleshooting ==
  
==Device Specific Examples==
+
=== Remote functions as a keyboard ===
=== X10 ===
+
==== When using Xorg ====
There is a dedicated wiki page with information about [[X10]]
+
  
===Asus DH Deluxe series motherboard===
+
Xorg detects some remotes, such as the Streamzap USB PC Remote, as a Human Interface Device (HID) which means some or all of the keys will show up as  key strokes as if entered from the physical keyboard.  This behavior will present problems if LIRC is to be used to manage the device. 
Check the output of:
+
To disable, create the following file and restart X:
{{bc|$ cat /dev/usb/hiddevX}}
+
  
where X is 0,1 or bigger, and press some buttons on remote.
+
{{hc|/etc/X11/xorg.conf.d/90-streamzap.conf|
If you can see reply, device works fine, follow steps:<br>
+
Section "InputClass"
 
+
1. In file {{ic|/etc/conf.d/lircd.conf}} add:<br>
+
{{bc|1=LIRC_DRIVER="dvico"}}
+
2. Reload LIRC:
+
{{bc|/etc/rc.d/lircd restart}}
+
 
+
===ASRock ION series (Nuvoton) quickstart===
+
 
+
$ ln -s /usr/share/lirc/remotes/lirc_wb677/lircd.conf.wb677 /etc/lirc/lircd.conf
+
$ /etc/rc.d/lircd restart
+
 
+
===Streamzap PC Remote (USB)===
+
{{Note|Xorg now auto recognizes this remote as a keybaord!}}
+
To disable this behavior, add the following to {{ic|/etc/X11/xorg.conf.d/90-streamzap.conf}}:
+
{{bc|Section "InputClass"
+
 
   Identifier "Ignore Streamzap IR"
 
   Identifier "Ignore Streamzap IR"
 
   MatchProduct "Streamzap"
 
   MatchProduct "Streamzap"
Line 489: Line 132:
 
EndSection}}
 
EndSection}}
  
#Install both packages (lirc lirc-utils)
+
Do not forget to alter the {{ic|MatchProduct}} property according to one shown in {{ic|Name}} from output of
#Modprobe both kernel mods (lirc_dev and streamzap). To have modules autoload at boot create the following file
+
  $ cat /proc/bus/input/devices | grep -e IR
{{hc|/etc/modules-load.d/lirc_streamzap.conf|#modules for streamzap remote
+
For example {{ic|WinFast}} for {{ic|<nowiki>N: Name="cx88 IR (WinFast DTV2000 H rev."</nowiki>}}
lirc_dev
+
streamzap
+
}}
+
#Create your {{ic|/etc/lirc/lircd.conf}} (for this remote, copy {{ic|/usr/share/lirc/streamzap/lircd.conf.streamzap}} to {{ic|/etc/lirc/lircd.conf}})
+
#Fix the broken lirc.service file:
+
 
+
{{hc|/usr/lib/systemd/system/lirc.service|[Unit]
+
Description&#61;Linux Infrared Remote Control
+
   
+
[Service]
+
EnvironmentFile&#61;/etc/lirc/lircd.conf
+
ExecStartPre&#61;/usr/bin/ln -sf /run/lirc/lircd /dev/lircd
+
ExecStart&#61;/usr/bin/lircd --pidfile&#61;/run/lirc/lircd.pid -d /dev/lirc0
+
Type&#61;forking
+
PIDFile&#61;/run/lirc/lircd.pid
+
+
[Install]
+
WantedBy&#61;multi-user.target
+
}}
+
 
+
You might have to play around with lircd and irw to find your remote. In the above example, it's /dev/lirc0.
+
 
+
Use {{ic|lircd -d /dev/...}} to start lircd with a certain device. Run {{ic|irw}} and test it out. When you find the right device, modify {{ic|/usr/lib/systemd/system/lirc.service}} accordingly.
+
 
+
#Start lircd via {{ic|# systemctl start lirc}} to survive a reboot use {{ic|# systemctl enable lirc}}
+
#Test the remote/lirc with irw
+
 
+
$ irw
+
00000000000028cc 00 CH_UP Streamzap_PC_Remote
+
00000000000028ce 00 CH_DOWN Streamzap_PC_Remote
+
00000000000028c8 00 8 Streamzap_PC_Remote
+
00000000000028c5 00 5 Streamzap_PC_Remote
+
00000000000028d2 00 OK Streamzap_PC_Remote
+
00000000000028d1 00 LEFT Streamzap_PC_Remote
+
00000000000028d1 01 LEFT Streamzap_PC_Remote
+
00000000000028d1 00 LEFT Streamzap_PC_Remote
+
00000000000028d3 00 RIGHT Streamzap_PC_Remote
+
00000000000028d3 00 RIGHT Streamzap_PC_Remote
+
00000000000028d3 00 RIGHT Streamzap_PC_Remote
+
00000000000028d3 00 RIGHT Streamzap_PC_Remote
+
00000000000028d4 00 DOWN Streamzap_PC_Remote
+
00000000000028d4 00 DOWN Streamzap_PC_Remote
+
00000000000028d4 00 DOWN Streamzap_PC_Remote
+
 
+
{{Note|When the batteries in this remote are low, it may stop working even though the red LED on the received still flashes when you hit buttons!}}
+
 
+
=== Serial Port "Home Brew" IR Receiver ===
+
Here's how to get a "Home Brew" serial port IR receiver working:
+
 
+
1. Create a udev rule to give non-privleged users read/write access to the serial port. I will be using ttyS0 in my example.
+
{{hc|/etc/udev/rules.d/z98-serial.rules|
+
# For serial port ttyS0 and LIRC
+
KERNEL&#61;&#61;"ttyS0",SUBSYSTEM&#61;&#61;"tty",DRIVERS&#61;&#61;"serial",MODE&#61;"0666"}}
+
 
+
2. Create the needed modprobe configs
+
{{hc|/etc/modules-load.d/lirc_serial.conf|lirc_serial}}
+
{{hc|/etc/modprobe.d/lirc_serial.conf|install lirc_serial /usr/bin/setserial /dev/ttyS0 uart none && /sbin/modprobe --first-time --ignore-install lirc_serial
+
options lirc_serial type&#61;0
+
remove lirc_serial /sbin/modprobe -r --first-time --ignore-remove lirc_serial && /sbin/modprobe -r lirc_dev}}
+
{{Note|Using [[udev]] rules to run the setserial command does not work in my experience because lirc_serial gets loaded before the serial port rules are applied.}}
+
 
+
3. Install your systemd service file.
+
{{hc|/etc/systemd/system/lirc.service|[Unit]
+
Description&#61;Linux Infrared Remote Control
+
After&#61;network.target
+
 
+
[Service]
+
Type&#61;simple
+
PIDFile&#61;/run/lirc/lircd.pid
+
ExecStartPre&#61;/bin/rm -f /dev/lirc /dev/lircd /var/run/lirc/lircd
+
ExecStart&#61;/usr/sbin/lircd -n -r -P /run/lirc/lircd.pid -d /dev/lirc0 -o /run/lirc/lircd
+
ExecStartPost&#61;/usr/bin/ln -sf /run/lirc/lircd /dev/lircd
+
ExecStartPost&#61;/usr/bin/ln -sf /dev/lirc0 /dev/lirc
+
ExecReload&#61;/bin/kill -SIGHUP $MAINPID
+
 
+
[Install]
+
WantedBy&#61;multi-user.target}}
+
 
+
4. We still need the default tmpfiles to be created, so copy that config file to {{ic|/etc/tmpfiles.d/lirc.conf}}.
+
{{bc|# cp -a /usr/lib/tmpfiles.d/lirc.conf /etc/tmpfiles.d/lirc.conf}}
+
 
+
5. Create a {{ic|.lircrc}} file in your home directory for your user or a {{ic|/etc/lirc/lircrc}} file for system wide use.
+
 
+
6. Have your service start at boot and then test with a reboot
+
{{bc|1=# systemctl enable lirc.service
+
# systemctl reboot}}
+
 
+
or load the module and start the lirc.service.
+
{{bc|# modprobe lirc_serial
+
# systemctl start lirc.service}}
+
 
+
=== Receivers that do not depend on a kernel module ===
+
 
+
Usually, you only need to specify your the device where the receiver is plugged in and the lirc driver. This is an example for pinnacle or miro serial receivers):
+
 
+
  LIRC_DEVICE="/dev/ttySX"
+
  LIRC_DRIVER="pinsys"
+
 
+
Then, start lircd daemon and create the remote/s configuration (/etc/lirc/lircd.conf), either by copying one of the configured defaults that comes with lirc-utils or by using irrecord. Even if you find your remote in the list of preconfigured remotes it might not work so you will have to use irrecord anyway.
+
 
+
After this you can use irw to check the remote, create your ~/.lircrc to assign remote buttons to actions and start irexec if you need to run arbitrary commands.
+
 
+
==Troubleshooting==
+
 
+
===Buttons processed several times when pressed===
+
Problem in module ir_core which processes IR commands with LIRC at the same time. Simply blacklist it by creating the following file:
+
 
+
{{hc|/etc/modprobe.d/remote_blacklist.conf|
+
# Prevent processing button several times when pressed
+
blacklist ir_core
+
}}
+
 
+
===After upgrading or installing Arch, an existing configuration stopped working===
+
====Kernel module change====
+
As of kernel 2.6.36, LIRC modules have been included in the kernel. Arch's ''lirc'' package has included the older kernel modules, which work with ''lircd'' without any additional configuration. However, a recent update removed those older modules, which results in the stock kernel modules being used. Unfortunately, these kernel modules treat the remote as a keyboard by default, which is incompatible for lircd. To correct this, put the following line to {{ic|/etc/rc.local}}:
+
{{hc|/etc/rc.local|echo lirc > /sys/class/rc/rc0/protocols}}
+
 
+
You may also run that command as root to enable LIRC for your current session.
+
 
+
Systemd has moved away from {{ic|rc.local}}. It is possible to use tmpfiles.d (read "man tmpfiles.d") to run the command {{ic|echo lirc > /sys/class/rc/rc0/protocols}}. Create the file {{ic|/etc/tmpfiles.d/lirc-protocols.conf}}:
+
{{hc|/etc/tmpfiles.d/lirc-protocols.conf|<nowiki>
+
w /sys/class/rc/rc0/protocols - - - - lirc
+
</nowiki>}}
+
 
+
{{Note|It is also a good idea to remove the old LIRC kernel module from your MODULES array in {{ic|/etc/rc.conf}}, as it is no longer present.}}
+
 
+
=== Problems using default systemd lirc.service file ===
+
  
The lirc service used to use a conf.d file for configuring command-line parameters, but the functionality was removed for systemd since the default configuration tends to work for the majority of use cases after kernel support for lirc was introduced.  See {{bug|31890}}.
+
==== On an ARM device not using Xorg ====
 +
Blacklist the offending modules by creating {{ic|/etc/modprobed.d/streamzap.conf}} to suppress this behavior. An example is provided for the Streamzap remote.
 +
install ir_sharp_decoder /bin/false
 +
install ir_xmp_decoder /bin/false
 +
install ir_rc5_decoder /bin/false
 +
install ir_nec_decoder /bin/false
 +
install ir_sony_decoder /bin/false
 +
install ir_mce_kbd_decoder /bin/false
 +
install ir_jvc_decoder /bin/false
 +
install ir_rc6_decoder /bin/false
 +
install ir_sanyo_decoder /bin/false
  
As the bug report states, the "correct" way to fix this issue is to use a drop-in service file; however, the workaround below can be a quick fix for a particular common problem.
+
=== Changing default configuration ===
  
==== Workaround ====
+
Users not getting any output from {{ic|irw}} may have the default configuration in {{ic|/etc/lirc/lirc_options.conf}} incorrectly setup (or might have been overwritten by an update).
  
How to know you might need the workaround -- {{ic|/var/log/lirc}} shows error finding {{ic|/dev/lirc}}:
+
First, check if {{ic|/dev/lirc0}} is present:
{{bc|lircd: could not get file information for /dev/lirc}}
+
  
Workaround: make a symbolic link for {{ic|/dev/lirc}} that points to {{ic|/dev/lirc0}} with file {{hc|/etc/tmpfiles.d/lirc-dev.conf|<nowiki>
+
$ mode2 --driver default --device /dev/lirc0
L /dev/lirc - - - - /dev/lirc0
+
</nowiki>}}
+
  
==== Replacing/overriding the existing service file ====
+
Watch the output while pressing buttons on the remote. If output is present, edit {{ic|/etc/lirc/lirc_options.conf}} changing the '''driver''' and '''device''' appropriately.
  
{{hc|/etc/systemd/system/multi-user.target.wants/lirc.service|<nowiki>
+
If no output is presented, the task becomes locating the correct driver/device combination. First check what combination lirc detected by default. Run {{ic|ir-keytable}} and check the output. It will look similar to this:
  
[Unit]
+
  Found /sys/class/rc/rc0/ (/dev/input/event5) with:
Description=Linux Infrared Remote Control
+
        Driver ite-cir, table rc-rc6-mce
[Service]
+
        Supported protocols: unknown other lirc rc-5 jvc sony nec sanyo mce-kbd rc-6 sharp xmp
EnvironmentFile=/etc/conf.d/lircd.conf
+
        Enabled protocols: lirc
ExecStartPre=/usr/bin/ln -sf /run/lirc/lircd /dev/lircd
+
        Extra capabilities: <access denied>
ExecStart=/usr/bin/lircd --pidfile=/run/lirc/lircd.pid --device=${LIRC_DEVICE} --driver=${LIRC_DRIVER} $LIRC_EXTRAOPTS ${LIRC_CONFIGFILE}
+
Type=forking
+
PIDFile=/run/lirc/lircd.pid
+
[Install]
+
WantedBy=multi-user.target</nowiki>}}
+
  
{{hc|/etc/conf.d/lircd.conf|<nowiki>
+
In this case, lirc automatically detected {{ic|/dev/input/event5}} as the IR device, which uses the {{ic|devinput}} driver. Check if this combination is working by running:
  
#
+
$ mode2 --driver devinput --device /dev/input/event5
# Parameters for lirc daemon
+
#
+
LIRC_DEVICE="YOUR DEVICE"
+
LIRC_DRIVER="YOUR DRIVER"
+
LIRC_EXTRAOPTS=""
+
LIRC_CONFIGFILE="/etc/lircd.conf"</nowiki>}}
+
  
With these you can start the daemon with preferred parameters from the config file.
+
Now try pressing buttons on the remote. If there is no output, try different driver and device combinations.  Once a working combination has been identified, change '''driver''' and '''device''' in {{ic|/etc/lirc/lirc_options.conf}} appropriately.
  
{{ic|<nowiki>EnvironmentFile=</nowiki> }} in the service file specifies the file with service parameters.
+
== See also ==
{{ic|<nowiki>–device=${LIRC_DEVICE} –driver=${LIRC_DRIVER} $LIRC_EXTRAOPTS ${LIRC_CONFIG}</nowiki> }}
+
uses the created variables from file as parameters to the daemon.
+
  
==See also==
+
* [http://lirc.sourceforge.net/lirc.org/html/index.html Upstream documentation]
* http://www.mythtv.org/wiki/Category:Remote_Controls -- MythTV wiki main LIRC article
+
* [http://lirc-remotes.sourceforge.net/remotes-table.html Remotes database]
* http://www.mythtv.org/wiki/MCE_Remote -- MythTV wiki on MCE remotes
+
* [http://sf.net/p/lirc Project site]
* http://en.gentoo-wiki.com/wiki/LIRC -- Gentoo wiki LIRC how-to
+
* [http://lirc.org/html/configuration-guide.html Upstream Configuration Guide]
* https://aur.archlinux.org/packages.php?ID=33849 -- Lirc/Lircrc Configuration Generator
+
* [http://www.mythtv.org/wiki/Category:Remote_Controls MythTV Wiki:Remotes article]
 +
* [http://lirc-remotes.sourceforge.net/remotes-table.html Official list of supported hardware]
 +
* [https://github.com/graysky2/streamzap Linux Streamzap config files]

Latest revision as of 10:54, 4 December 2016


This article covers setup and usage of LIRC "Linux Infrared Remote Control" with serial or USB infrared devices.

LIRC is a daemon that can translate key presses on a supported remote into program specific commands. In this context, the term, "program specific" means that a key press can do different things depending on which program is running and taking commands from LIRC.

The Central Dogma of LIRC (an allusion to the flow of information in biological systems) is summarized below wherein the flow of information from the remote to the application is summarized with LIRC at the center of it all:

  • User hits a button on the remote causing it to transmit an IR or RF signal.
  • The signal is received by the receiver connected to the Linux box.
  • The kernel (via the correct module) use presents pulse data from the remote on a device like /dev/lirc0, /dev/input/eventX, /dev/ttyUSBX or /dev/ttyS0.
  • /usr/bin/lircd uses the information from /etc/lirc/lircd.conf.d/foo.conf to convert the pulse data into button press information.
  • Programs that use LIRC translate the button press info from /usr/bin/lircd into user-defined actions according to ~/.lircrc or to program-specific mappings.

Installation

Install the lirc package.

Configuration

Note: This section is a quick summary. Complete documentation is available upstream.

/etc/lirc/lircd.conf.d/foo.conf is the system-wide configuration translating scancodes --> keys. This directory may contain multiple conf files and each one is specific to each remote control/receiver on the system. These files are user-created config files and not directly supplied by lirc.

The definition of scancodes to keymaps is required to allow LIRC to manage a remote. Users have several options to obtain one.

Upstream provided

Identify which remote/receiver is to be used and see if there is a known config for it. One can use irdb-get to search the remotes database or simply browse to the URL and do the same.

An example using irdb-get to find a config file for a Streamzap remote:

$ irdb-get find stream
atiusb/atiusb.lircd.conf
digital_stream/DTX9900.lircd.conf
snapstream/Firefly-Mini.lircd.conf
streamzap/PC_Remote.lircd.conf
streamzap/streamzap.lircd.conf
x10/atiusb.lircd.conf

$ irdb-get download streamzap/streamzap.lircd.conf 
Downloaded sourceforge.net/p/lirc-remotes/code/ci/master/tree/remotes/streamzap/streamzap.lircd.conf as streamzap.lircd.conf

Once identified, copy the needed conf to /etc/lirc/lircd.conf.d/ to allow the daemon to initialize support for it.

# cp streamzap.lircd.conf /etc/lirc/lircd.conf.d/

User created

Users with unsupported hardware will need to either find a config file someone else has created (i.e. google) or create one. Creating one is fairly straightforward using /usr/bin/irrecord which guides users along the needed process. If using a detected remote, invoke it like so:

# irrecord --device=/dev/lirc0 MyRemote

The program will instruct users to begin hitting keys on the remote in an attempt to learn it, ultimately mapping out every button and its corresponding scancode. The process should take no more than 10 minutes. When finished, save the resulting file to /etc/lirc/lircd.conf.d/foo.conf and proceed.

Note: Consider sending the finished config file to the email address mentioned in the program so it can be made available to others.

Optional files

Depending on the application using LIRC, the following are optional. For example, mplayer and mythtv use the these files to define key maps and actions. Some other programs such as kodi for example do not make use of this at all but do have an internal system to achieve these mappings. Users should consult the documentation for the specific application to know if modifications to ~/.lircrc are needed.

  • ~/.lircrc - File containing an include statement pointing to each program's lirc map, i.e., ~/.lirc/foo, ~/.lirc/bar, etc.
  • ~/.lirc/foo - User-level config translating of keys --> actions. Is specific to each remote and to application foo.

Usage

Start lircd.service and enable it to run at boot time/shutdown (recommended).

Test the remote using /usr/bin/irw, which simply echos anything received by LIRC when users push buttons on the remote to stdout.

Example:

$ irw
000000037ff07bfe 00 One mceusb
000000037ff07bfd 00 Two mceusb
000000037ff07bfd 01 Two mceusb
000000037ff07bf2 00 Home mceusb
000000037ff07bf2 01 Home mceusb

If irw gives no output, double check the config files in /etc/lirc/lircd.conf.d/ for errors.

Program Specific Configuration

Merge-arrows-2.pngThis article or section is a candidate for merging with LIRC#Optional.Merge-arrows-2.png

Notes: or the other way around (Discuss in Talk:LIRC#)

LIRC has the ability to allow for different programs to use the same keypress and result in unique commands. In other words, one can setup different programs to respond differently to a given key press.

  • Decide which programs are to use LIRC commands.
Note: Common programs include: mplayer, mythtv, totem, vlc, and kodi but not all programs will use this particular method to map keys. kodi for example, implements LIRC in a non-standard way. Users must edit ~/.xbmc/userdata/Lircmap.xml which is a unique xml file, rather than the LIRC standard files the rest of the programs use. Interested users should consult Kodi#Using a remote control.
  • Create the expected files showing LIRC where the various program-specific maps reside:
$ mkdir ~/.lirc
$ touch ~/.lircrc
  • Populate ~/.lirc with the program specific config files named for each program.

Example:

$ ls ~/.lirc
mplayer
mythtv
vlc
Tip: Many pre-made files unique to each remote/program are available via googling. Providing an exhaustive listing of keymaps for each program is beyond the scope of this article.
  • Edit ~/.lircrc to contain an include statement pointing to ~/.lirc/foo and repeat for each program that is to be controlled by LIRC.

Example:

~/.lircrc
include "~/.lirc/mplayer"
include "~/.lirc/mythtv"
include "~/.lirc/vlc"

Troubleshooting

Remote functions as a keyboard

When using Xorg

Xorg detects some remotes, such as the Streamzap USB PC Remote, as a Human Interface Device (HID) which means some or all of the keys will show up as key strokes as if entered from the physical keyboard. This behavior will present problems if LIRC is to be used to manage the device. To disable, create the following file and restart X:

/etc/X11/xorg.conf.d/90-streamzap.conf
Section "InputClass"
  Identifier "Ignore Streamzap IR"
  MatchProduct "Streamzap"
  MatchIsKeyboard "true"
  Option "Ignore" "true"
EndSection

Do not forget to alter the MatchProduct property according to one shown in Name from output of

$ cat /proc/bus/input/devices | grep -e IR

For example WinFast for N: Name="cx88 IR (WinFast DTV2000 H rev."

On an ARM device not using Xorg

Blacklist the offending modules by creating /etc/modprobed.d/streamzap.conf to suppress this behavior. An example is provided for the Streamzap remote.

install ir_sharp_decoder /bin/false
install ir_xmp_decoder /bin/false
install ir_rc5_decoder /bin/false
install ir_nec_decoder /bin/false
install ir_sony_decoder /bin/false
install ir_mce_kbd_decoder /bin/false
install ir_jvc_decoder /bin/false
install ir_rc6_decoder /bin/false
install ir_sanyo_decoder /bin/false

Changing default configuration

Users not getting any output from irw may have the default configuration in /etc/lirc/lirc_options.conf incorrectly setup (or might have been overwritten by an update).

First, check if /dev/lirc0 is present:

$ mode2 --driver default --device /dev/lirc0

Watch the output while pressing buttons on the remote. If output is present, edit /etc/lirc/lirc_options.conf changing the driver and device appropriately.

If no output is presented, the task becomes locating the correct driver/device combination. First check what combination lirc detected by default. Run ir-keytable and check the output. It will look similar to this:

 Found /sys/class/rc/rc0/ (/dev/input/event5) with:
       Driver ite-cir, table rc-rc6-mce
       Supported protocols: unknown other lirc rc-5 jvc sony nec sanyo mce-kbd rc-6 sharp xmp
       Enabled protocols: lirc
       Extra capabilities: <access denied>

In this case, lirc automatically detected /dev/input/event5 as the IR device, which uses the devinput driver. Check if this combination is working by running:

$ mode2 --driver devinput --device /dev/input/event5

Now try pressing buttons on the remote. If there is no output, try different driver and device combinations. Once a working combination has been identified, change driver and device in /etc/lirc/lirc_options.conf appropriately.

See also