| blob | 7c3501361647b2ff00b583de9ae097629685f64f |
3 <HTML>
4 <HEAD>
10 </HEAD>
15 <TR>
23 </TD>
24 </TR>
25 <TR>
28 <TR>
32 <!-- Text ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
34 <!-- Dependencies +++++++++++++++++++++++++++++++++++++++++++++++++++ -->
40 <P>
42 package. It already should be installed on most systems. The
43 setup.sh script makes configuration of LIRC much easier but
44 using it is not obligatory.
45 </P>
47 <P>
48 If you want to compile and use all tools, you also need an
53 ftp://sunsite.unc.edu/pub/Linux/libs/graphics/</A>. The
54 configure script will notify you if some necessary files are
55 missing and the according tools won't be compiled.
56 </P>
58 <P>
62 the current libirman version was 0.4.3. Former versions won't
65 </P>
69 <P>
71 will need the properly configured kernel sources being available
72 somewhere in /usr/src/. During the build process of this package
73 the kernel Makefile and the current kernel configuration will be
74 used to work around some other problems that would arise if we
75 used our own Makefile. That means that you might have to build
76 your own kernel which is a good idea anyway. Make sure you use
77 the standard kernel which you can download at <A
79 kernel sources that have been modified for your
80 distribution. For example you won't be able to compile some
81 modules for kernels that come with S.u.S.E. 7.0. Please refer to
82 the documentation of your distribution or read the
84 information on how to compile and set up an own kernel. More
85 documentation is available at the <A
87 Project</A>.
88 </P>
89 <P>
90 If you are still running a stock kernel that came with your
91 distribution and don't want to compile a new kernel you can try
92 the following. Install the kernel sources package of the
93 currently running kernel. Most distributions provide rpm/deb
94 packages of their stock kernels. Double-check that you selected
95 the correct kernel sources. Now make sure that there is a file
96 called .config in the root directory of the kernel source
97 tree. This file holds the configuration used to compile this
98 kernel. If it is not available and you can't get it from a
100 /proc/config.gz (SuSE) or
102 places to look into) you are out of luck and will have to
103 configure and compile your own kernel. Otherwise call <em>make
105 the kernel source tree. After that you should be able to compile
106 the LIRC modules without problems. Just make sure that the
107 configure script for the LIRC package picked the correct kernel
108 source directory. But be aware that there might still be some
109 problems due to incompatible extensions of the distribution
110 kernels as mentioned in the last paragraph. There are even more
111 pitfalls. The modules should be compiled with the same compiler
112 version. Otherwise you might see strange lockups and kernel
113 oopses. Another problem might be that some distribution vendors
114 also modify the kernel version variables inside the Makefile of
116 EXTRAVERSION variable. This will result in the modules being
117 installed in the wrong directory. In such cases it is common
119 with kernel compilation. This has been only a list of known
120 problems. If you run into such problems I won't be able to help
121 you, so don't even ask.
122 </P>
123 <P>
124 If you want to use a home-brew receiver, an Anir Multimedia
125 Magic, a Packard Bell receiver, the IRdeo or if you want to use
126 the SIR IrDA driver, I suggest that you compile the Linux kernel
127 serial port driver as a module (however, you can choose not to
128 do so if you use setserial properly, see below). The according
133 devices</em> section of the kernel configuration
134 dialogue. Usually the serial port driver grabs all ports it
135 auto-detects as soon as it is loaded and the LIRC modules won't
136 be able to use any of them.
137 </P>
139 <P>
140 There are two solutions for this problem. Either you load the
141 LIRC module before the kernel serial port driver is loaded
142 (that's why you have to compile it as a module) or you call
144 port. setserial usually is already called during boot-up in some
145 init script whose location depends on the distribution you
146 use. Be aware that setserial might also be the cause of
147 trouble. The reason for this is a kernel bug (known to be true
148 for 2.2.20, patches are on the way). If you tell setserial to
149 configure a port that is already claimed by a LIRC module, the
150 kernel serial driver will steal the port from the LIRC module
151 and LIRC will stop working. So check your setserial
152 configuration to only configure available ports. Debian users
154 </P>
156 <P>
158 directly to a bttv based TV card you will need a working bttv
159 setup in your kernel. For most TV cards we rely on bttv
160 autodetection. That way you don't have to give any parameters to
161 the module as they are selected internally depending on the
162 information the bttv module gives us. This means that you should
163 pay attention that your TV card is detected correctly by bttv.
164 </P>
165 <P>
168 card.
169 </P>
171 <!-- Supported Hardware ++++++++++++++++++++++++++++++++++++++++++++++ -->
177 <P>
178 Generally speaking everything that can receive or send infrared
179 signals can be supported by LIRC. The project began with support
180 for home-brew receivers and transmitters for the serial port and
181 later support for analogous hardware for the parallel port was
182 added. At that time the focus of the project was to provide an
183 infrared solution that is both very cheap and easy to
184 assemble. The following links point to instructions how to build
185 your own receiver/transmitter.
186 </P>
188 <UL>
190 Building a serial port receiver</A></LI>
192 Building a serial port transmitter</A></LI>
194 Building a parallel port transceiver</A></LI>
195 </UL>
197 <P>
198 Current versions of LIRC now support many more commercially
199 available solutions. Examples are the Irman, built-in IrDA ports
200 or TV cards. Drivers for even more hardware are likely to appear
201 in the future. If you are a programmer who wants to maintain
202 such a driver you are welcome to join the project.
203 </P>
204 <P>
206 of supported devices</A> and see if there is additional
207 information available regarding the setup of your device.
208 </P>
210 <!-- Compiling +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
216 <P>
217 Before compiling the binaries you have to choose which driver to
220 prompt. After selecting your driver you can exit the setup with
222 </P>
224 <P>
226 it the hard way and give the correct parameters to the configure
228 description of the possible parameters. You will have to at
230 option.
231 </P>
234 <DL>
236 <DD>
237 will build multiple drivers into lircd and runtime selection
239 not all drivers are included, so in some cases you will have
241 option will also compile all available kernel modules. Some
242 kernel modules are only supported with recent kernel
243 versions. That means that compilation of these drivers might
244 fail with older kernel versions. If this happens for you, you
246 below and only compile the kernel modules that you need
247 separately.
248 </DD>
251 <DD>
252 will only let lircd talk to other lircd's though the network and
253 not to any local hardware.
254 </DD>
257 <DD>
259 kernel modules will be built.
260 </DD>
261 </DL>
263 <P>
264 When running the configure script, please pay attention at its
265 output. At the end of the configuration checks, it will tell you
266 which kernel module (if any) will be required for your
267 hardware. You can also look up this information in the <A
270 </P>
272 <P>
274 version of LIRC. You will have to generate it first by executing
277 </P>
279 <!-- Install LIRC ++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
285 <P>
286 Installing the compiled programs is really easy, just type
288 installed at the usual places. The necessary devices should be
290 files should be copied to its proper destination if you happen
291 to use some hardware where configuration files are already
292 available.
293 </P>
295 <P>
297 kernel, the /dev/lirc device node will disappear again once you
298 reboot your machine. In that case the LIRC kernel module will
299 generate the required entry every time it is loaded. But the
300 device node won't be visible as /dev/lirc, but might be located
301 in a different location like e.g. /dev/lirc/0. Please be aware
302 of this fact when starting programs that access the device node
303 like mode2 or lircd. You will have to use the --device command
304 line option of these programs to point them to the correct
305 location. When using sysfs together with the udev daemon you
307 directory of the source package to
309 node will be created.
310 </P>
312 <P>
314 daemon that does all of the decoding of infrared signals. LIRC
316 depends on lircd and translates remote control activity to mouse
317 movements. Just like all other daemons both lircd and lircmd
318 should be started at system boot time and do their work in
319 background. If you want to start them automatically at boot time
320 you will have to add an init script for them to your
321 system. Unfortunately the syntax and location of this init
322 script is highly dependent on the distribution you use so you
323 will have to figure it out yourself how this works on your
324 system. Good news is that there already are some init scripts
326 package.
327 </P>
329 <P>
331 daemonize" turned on and place them in some init script
332 unless you have a rescue disc nearby...
333 </P>
335 <P>
336 Now you should adjust the file permissions of
339 connect to lircd.</P>
340 <PRE>
342 <P>
343 should do. You can also create a special group for this purpose.
344 </P>
346 <P>
347 If your hardware requires a kernel module you should make sure
348 that the kernel will find the correct module if a program tries
352 </P>
353 <PRE>
355 <P>
357 driver you are using (serial, parallel, etc.).
358 </P>
360 <P>
361 If your driver requires some special parameters to work you can
362 specify them at the same place. For example you can set the IRQ
363 and I/O base the serial port drivers shall use by adding the
365 <PRE>
367 <P>
368 This will override the default values you have selected during setup.
369 The configure script will tell you which kernel module you need.
370 </P>
372 <P>
375 found by the run-time linker. Don't forget to call
377 </P>
379 <!-- Testing +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
385 <P>
386 If you have build the infrared hardware yourself you are
387 probably eager to find out if it really works. If you have not
388 build the hardware yourself you can skip the first test. For
389 most receivers it even won't work because it makes no
390 sense.
391 </P>
393 <P>
396 your video card to a vesa mode using the vesa bios
397 calls...). This should load the kernel module into the kernel
398 and display the infrared signals. Hold your remote control to
399 your infrared receiver and press some buttons. You should see an
400 output like this (the values of your remote will probably be
401 different):
402 </P>
404 <PRE>
405 pulse 93
406 space 4965
407 pulse 108
408 space 4969
409 pulse 93
410 space 7496
411 pulse 93
412 space 7489
413 pulse 93
414 space 47915
415 pulse 138
416 space 7475
417 pulse 93
418 space 7494
420 <P>
421 If you don't see anything, try to find out: (a) if you selected
422 the correct driver with the correct settings (I/O base address,
423 IRQ), (b) if you use a remote which works and (c) if your
424 hardware works. The voltage input of the infrared receiver
426 about 0.5V less than the input voltage.
427 </P>
429 <P>
431 can see very long pulses this usually means that sense auto
432 detection of your serial port IR receiver circuit has
433 failed. You can override sense auto detection by loading the
434 device driver with the following option:</P>
436 <P>
438 high or<BR>
441 low.
442 </P>
444 <P>
445 Well, the driver seems to work, now let's test if lircd also
446 does its job. This only works, if lircd uses a <A
448 your remote control. Use <A
450 distribution doesn't provide a config file suitable for your
451 remote and it still is not available at the LIRC homepage. A
452 more detailed discussion of creating new config files is
453 available in the section about, you guess it: <A
455 </P>
457 <P>
458 Then start the decoder daemon with (make sure it is in your
460 </P>
462 <P>
463 The following program dumps the decoded key codes from lircd to
465 </P>
467 <P>
468 This looks like this (depending on your remote):
469 </P>
470 <PRE>
481 <P>
482 If the driver test did work, but you now see nothing, then check
484 compile lircd in DEBUG mode and look at the log file again. In
485 debug mode lircd has an additional command line option that lets
486 you choose the detail level of debug information.
487 </P>
493 <P>
495 sending infrared signals to e.g. your TV or CD player. For
496 reliable transmission a good config file is even more important
497 than for receiving. A discussion of all the infrared protocols
498 is way beyond the scope of this manual but when creating a
499 config file at least read the <A
501 manual. You can find exact timing specifications for most common
502 inside the remotes/generic/ directory of the LIRC package.
503 </P>
504 <P>
505 If you want a graphical interface for controlling your devices
506 using LIRC, you should have a look at xrc. You can download the
507 xrc package from the LIRC homepage. xrc is a Qt based
508 program. Setting up xrc and Qt is a bit tricky so if you don't
509 manage to compile it you can still use irsend. It has the full
510 functionality you need.
511 </P>
513 <!-- Uninstall LIRC ++++++++++++++++++++++++++++++++++++++++++++++++++ -->
519 <UL>
521 <BR>
523 <BR>
524 </LI>
526 <BR>
528 <BR>
529 </LI>
530 </UL>
532 <!-- Module specific information +++++++++++++++++++++++++++++++++++++ -->
540 <P>
542 chips using polling or interrupts if the card supports this. It is a
545 loaded yet.<BR>
546 </P>
548 <P>
549 The following gives a list of parameters for the module. If your
550 TV card is already listed as supported than you don't need to
552 because all other are set to the correct values
553 automatically. Setting the values manually only makes sense
554 while adding support for a new TV card so that you don't have to
555 recompile the module each time you try a different value.
556 </P>
557 <UL>
559 printing more log messages</LI>
561 codes</LI>
563 /dev/lirc device</LI>
566 the module tries to autodetect the TV card and the remaining
567 parameters are ignored.</LI>
569 with GPIO value is non zero than it indicates that scan code
570 is not ready (value of 0 of this parameter disables
571 checking)</LI>
573 operation) to GPIO value before lock_mask is checked</LI>
579 some cards are translated to match original codes</LI>
580 </UL>
581 <P>
582 Usage example would be e.g:
583 </P>
584 <em>modprobe lirc_gpio gpio_mask=0x1f00 gpio_lock_mask=0x8000 gpio_xor_mask=0 soft_gap=400 sample_rate=12</em>
585 <P>
588 recognize the card type the remote control won't work.
589 </P>
591 <!-- Updating from lirc-0.5.4 ++++++++++++++++++++++++++++++++++++++++ -->
597 <P>
598 This section only describes changes that break compatibility
600 about all new features of this release.
601 </P>
602 <P>
607 </P>
608 <P>
611 you are using. Therefore you might have to edit your
613 </P>
614 <PRE>
616 <P>
617 to whatever you need.
618 </P>
619 <P>
621 longer necessary. Before installing this version you should call
625 </P>
631 <P>
632 The lirc_gpio_p has been renamed to lirc_gpio. It now also
633 contains support for TV cards that are able to generate
634 interrupts if infra-red commands are received. The lirc_gpio_i
635 driver that implemented this has been removed. The lirc_fly98
636 also has been removed as it is now supported by the lirc_gpio
637 driver.
638 </P>
640 <P>
642 </P>
644 <P>
646 slightly. If you have problems transmitting decrease the
647 frequency value in the lircd config file by approximately 2000.
648 </P>
650 <P>
651 There have been major changes to the SIR driver. If you used
652 this driver before you may have to generate new config files for
653 your remotes. Transmitting is now more likely to work.
654 </P>
656 <P>
657 The config file for the old AVerMedia TVCapture and TVPhone
658 cards (pre 98) has changed. Please use the new config file that
660 </P>
668 <P>
669 Two independend bugs were fixed in the IRdeo and home-brew
670 transmitter code that affected correct pulse/space timings in
671 some situations. This might break config files that did work
672 with previous versions.
673 </P>
679 <P>
681 finally work with the provided config files. That means they
682 will no longer work with the config files you have created
683 yourself.
684 </P>
685 <P>
686 The I/O base address for some modules now is set with the
688 and lirc_parallel = port).
689 </P>
695 <P>
696 The config file for the Pixelview PlayTV pro and compatible TV
697 cards has changed. Please use the config file in
699 </P>
700 <P>
701 The config file for the Winfast TV2000 and compatible TV cards
702 has changed. Please use the config file in
704 </P>
710 <P>
711 The config files for all FlyVideo TV cards have changed. Please
712 use the config file in
714 </P>
715 <P>
716 The config file for the Winfast TV2000 TV card has
717 changed. Please use the config file in
719 </P>
720 <P>
721 The lirc_sir now should generate better signals for some
722 remotes. Due to the change some old config files generated with
723 previous versions of the driver might stop working. In this case
724 you should just create a new config file using the new
725 driver. If you want to get the old behaviour of the driver
726 (deprecated) you can insert the module using the
729 higher values.
730 </P>
731 <P>
733 driver, make sure that your config file contains the following
734 line in its header:
735 </P>
736 <pre>
737 bits 32
738 </pre>
739 <P>
740 Otherwise lircd will not recoginise any events.
741 </P>
748 <P>
749 There is a new program that you probably want to use: <A
751 and synchronises the mode that the LIRC clients using this
752 config file (irexec, irxevent, etc.) are in. Using lircrcd has
753 to be explicitly enabled in the config file by adding the
754 following line at the beginning of the file:
755 <pre>
756 #! lircrcd
757 </pre>
758 </P>
765 <P>
766 The config file for the Pinnacle Systems PCTV (pro) receiver has
767 changed. Please use the config file in
769 </P>
770 <P>
771 The config file for the Creative Infra Receiver/CIMR100 has
772 changed. Please use the config file in
774 </P>
776 <!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
778 <BR><BR>
781 <BR><BR>
782 </TD>
784 </TR>
785 </TABLE>
786 </TD>
787 </TR>
788 <TR>
790 </TD>
791 </TR>
792 </TABLE>
793 </BODY>
794 </HTML>