Difference between revisions of "LIRC"

From ArchWiki
Jump to: navigation, search
(Setup a HID device with LIRC: remove extraneous startup at boot information)
(Setup a HID device with LIRC: remove extraneous Testing section)
Line 167: Line 167:
 
In order to launch the LIRC daemon for HID remote, You must enable evdev module first
 
In order to launch the LIRC daemon for HID remote, You must enable evdev module first
 
  # modprobe evdev
 
  # modprobe evdev
{{Note|This step may not be necessary}}
 
 
Then you can launch the LIRC daemon.
 
 
# rc.d start lircd
 
 
You can test the setting with irw command
 
 
$ irw
 
 
You should see something like this on you screen when you click the remote button.
 
 
  0000000000010067 00 UP linux-input-layer
 
  000000000001006c 00 DOWN linux-input-layer
 
  0000000000010069 00 LEFT linux-input-layer
 
  000000000001006a 00 RIGHT linux-input-layer
 
  000000000001001c 00 ENTER linux-input-layer
 
  000000000001009e 00 BACK linux-input-layer
 
  000000000001000f 00 TAB linux-input-layer
 
  
 
{{Note|LIRC 0.8.6 has changed the default socket location from {{filename|/dev/lircd}} to {{filename|/var/run/lirc/lircd}}, but many applications still look for the socket in the old location.  Since lirc-utils 0.8.6-3 the {{filename|/etc/rc.d/lircd}} script creates a symlink from {{filename|/dev/lircd}} to the {{filename|/var/run/lirc/lircd}} socket when it starts the lircd daemon and removes the link when the daemon is stopped.}}
 
{{Note|LIRC 0.8.6 has changed the default socket location from {{filename|/dev/lircd}} to {{filename|/var/run/lirc/lircd}}, but many applications still look for the socket in the old location.  Since lirc-utils 0.8.6-3 the {{filename|/etc/rc.d/lircd}} script creates a symlink from {{filename|/dev/lircd}} to the {{filename|/var/run/lirc/lircd}} socket when it starts the lircd daemon and removes the link when the daemon is stopped.}}

Revision as of 16:43, 30 July 2011

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 using LIRC with serial or USB infrared devices.

Installation

First install LIRC with pacman:

# pacman -S lirc

This will also install the lirc-utils package as a dependency.

Serial receivers

Now there might be a problem: the module lirc_serial is build to use ttyS0 (COM1), if your device isn't connected to ttyS0, you'll have to either change the module-options or rebuild the LIRC module. If your device is connected to ttyS0, you can skip this step

To change the options for the lirc_serial module, you edit Template:Filename and add this line:

options lirc_serial io=0x2f8 irq=3

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:

$ dmesg | grep ttyS

Building the lirc_serial module for another ttySx

Update abs

# abs

Copy the LIRC files to a directory you choose yourself:

$ cp /var/abs/extra/system/lirc /some/dir
$ cd /some/dir

Edit the PKGBUILD in that directory.

Replace the line:

./configure --enable-sandboxed --prefix=/usr \
    --with-driver=all \\
    return 1[/code]

with:

./configure --enable-sandboxed --prefix=/usr \
    --with-driver=com2 \
    || return 1[/code]

Where you replace com2 with the com-port you need.

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's build into the kernel you'll have to do the following (remember that it is build into the kernel, you will need to make some changes later too)

You'll 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 shouldn't show any errors, and the modules lirc_serial should be listed in lsmod

USB devices

To manually load the USB receiver:

# modprobe mceusb

then load LIRC

$ lircd

Test it with irw. irw will output the commands received by the IR receiver that match your Template:Filename file. So start irw, point your remote and start pressing buttons.

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

The above procedure however has been simplified and probably won't work that easily. If you get errors in the above try the following:

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 Template:Filename. Try "man lircd" for more information.

To run lircd at startup, add it to the DAEMONS line in Template:Filename. eg:

DAEMONS=(syslog-ng network netfs crond lircd)

Also, if needed add your receivers kernel module to the MODULES line of Template:Filename eg (for the MCE Remote control):

MODULES=(mceusb)

Next, you need to put your remotes .conf file into Template:Filename. These files can be found either in your directory Template:Filename or you may be able to find them here http://lirc.sourceforge.net/remotes/

If you're copying it locally here's an example of what you would do for the mceusb remote

# cp /usr/share/lirc/remotes/mceusb/lircd.conf.mceusb /etc/lirc/lircd.conf

upon rebooting the remote should work. Test it with irw. irw will output the commands received by the IR receiver that match your Template:Filename file. So start irw, point your remote and start pressing buttons

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

Setup a HID device with LIRC

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 Template:Filename files become standard HID devices.

Some HID remotes actually simulate a USB infrared keyboard and mouse. These remotes show up as two devices so you need to add two LIRC devices to Template:Filename.

First we need the Template:Filename device for our remote:

 $ cat /sys/class/rc/rc0

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.

Note: If you have more than one ir device then there may be multiple directories under Template:Filename. Under event# cat name to verify which device you are looking at.

then go to Template:Filename

 $ ls -l /dev/input/by-id

You should find a file that symlinks to the input# above, and possibly others with a similar names for mouse events.

 lrwxrwxrwx 1 root root  9 10月 14 06:43 usb-3353_3713-event-if00 -> ../event9
 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.

Then, we need to edit Template:Filename. This file contains the parameters for LIRC daemon

 #
 #Parameters for daemon
 #
 
 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 [1]. Simply save it as Template:Filename.

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 Template:Filename to Template:Filename, but many applications still look for the socket in the old location. Since lirc-utils 0.8.6-3 the Template:Filename script creates a symlink from Template:Filename to the Template:Filename socket when it starts the lircd daemon and removes the link when the daemon is stopped.

Using a X10

X10

Making a configuration file

You'll need a configuration file for your remote control. The easiest way is to look on the LIRC site and hope your device has already a config file: list of remotes on the LIRC site

If so, download your file and save it as Template:Filename

If your device doesn't have already a config file, you'll have to create the file yourself with the command:

# irrecord -d /dev/lirc0 /tmp/my_remote

Just follow the instructions. The resulting file, Template:Filename, should then be copied to Template:Filename. 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 Template:Filename:

# 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 Template:Filename, Template:Filename and Template:Filename. If the config files are not found in that location, they are still searched at the old location in Template:Filename

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 get something like this:

0000000000000001 00 play sony2
0000000000000001 01 play sony2
0000000000000001 02 play sony2
0000000000000001 03 play sony2

In this case my 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 loading the module?

If so, 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'll just have to add lirc_serial to the modules list and lircd to the daemons list in Template:Filename

Your serial port support is compiled into the kernel

This is more complicated, you can't just add the lirc_serial to the modules list in Template:Filename, as the serial port should be released first.

So I created a custom startup script to fix this problem.

Template:File

Now load the daemons: add "start_lirc" and "lircd" to the daemons list in Template:Filename

Program specific

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 Template:Filename handy prior to running. It will then produce a sane Template:Filename for the current user.

Mythbuntu's Lirc/Lircrc Generator is available on AUR
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 from the cvs tree.

Add " --enable-lirc" to the Template:Filename 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 Template:Filename file. In your home directory, type:

$ xine --keymap=lirc>.lircrc

Now, in order to have a functioning xine+lirc, edit the Template:Filename 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 Template:Filename 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.

Template:File

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.

Template:File

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:

Template:File

Device Specific Examples

Asus DH Deluxe series motherboard

Check the output of:

$ cat /dev/usb/hiddevX

where X is 0,1 or bigger, and press some buttons on remote. If you can see reply, device works fine, follow steps:

1. In file Template:Filename add:

LIRC_DRIVER="dvico"

2. Reload LIRC:

/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)

  1. Install both packages (lirc lirc-utils)
  2. Modprobe both kernel mods (lirc_dev and lirc_streamzap) (add these to your MODULES array in Template:Filename to survive a reboot)
  3. Create your Template:Filename (for this remote, copy Template:Filename to Template:Filename)
  4. Start lircd via /etc/rc.d/lircd start (add lircd to your DAEMONS array in Template:Filename to survive a reboot)
  5. 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!

Running LIRC on a non-standard Arch-Kernel

Update abs

# abs

Copy the lirc files to a directory you choose yourself:

$ cp /var/abs/extra/system/lirc /some/dir
$ cd /some/dir

Edit the PKGBUILD in that directory.

Replace the line:

_kernelver=2.6.35-ARCH

with:

_kernelver=YOUR_KERNEL_VERSION

Where you replace YOUR_KERNEL_VERSION with the kernel you installed (for example: 2.6.35-ck).

Build and install the package:

$ makepkg -s
# pacman -U lirc-version.pkg.tar.gz

After that, you can modprobe your needed modules.

Troubleshooting

Buttons processed several times when pressed

Problem in module ir_core which processes IR commands with LIRC at the same time. Simple blacklist it by creating the following file:

Template:File

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 Template:Filename: Template:File You may also run that command as root to enable LIRC for your current session.

Note: It is also a good idea to remove the old LIRC kernel module from your MODULES array in Template:Filename, as it is no longer present.

Configuration change

With a recent update, the configuration file for mceusb uses different names for the buttons. Existing lircrc configurations will fail as they are expecting different file names. If you don't want to change your button mappings in lircrc, then simply replace the contents of Template:Filename with the following configuration: Template:File

External Resources

http://www.mythtv.org/wiki/Category:Remote_Controls -- MythTV wiki main LIRC article

http://www.mythtv.org/wiki/MCE_Remote -- MythTV wiki on MCE remotes

http://en.gentoo-wiki.com/wiki/LIRC -- Gentoo wiki LIRC how-to

http://aur.archlinux.org/packages.php?ID=33849 -- Lirc/Lircrc Configuration Generator