Added lirc.
[irreco.git] / lirc-0.8.4a / doc / html / help.html
blobac70f3bcab76b1c6ca0a5d33005197a8ea93765a
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
3 <HTML>
4 <HEAD>
5 <TITLE>LIRC - Linux Infrared Remote Control</TITLE>
6 <LINK REL=stylesheet TYPE="text/css" HREF="../lirc.css">
7 <LINK REL="shortcut icon" HREF="../favicon.ico">
8 <META NAME="description" CONTENT="LIRC - Linux Infra-red Remote Control">
9 <META NAME="keywords" CONTENT="linux, kernel module, remote control, animax, multimedia">
10 </HEAD>
12 <BODY BACKGROUND="../images/marb18.jpg"
13 BGCOLOR="#FFFFFF" TEXT="#000000" ALINK="#8080FF">
14 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0">
15 <TR>
16 <TD CLASS="menu" WIDTH="100%" HEIGHT="150">
17 <IMG SRC="../images/diode.gif" ALT=""
18 WIDTH="300" HEIGHT="150" BORDER="0" HSPACE="20"
19 VSPACE="0" ALIGN="LEFT">
20 <IMG SRC="../images/lirc.gif" ALT=""
21 WIDTH="300" HEIGHT="150" BORDER="0" HSPACE="20"
22 VSPACE="0" ALIGN="RIGHT">
23 </TD>
24 </TR>
25 <TR>
26 <TD WIDTH="100%">&#160;<BR>
27 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0">
28 <TR>
29 <TD WIDTH="15%">&#160;<BR></TD>
30 <TD WIDTH="70%" ALIGN="LEFT" VALIGN="TOP">&#160;<BR>
32 <!-- Text ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
34 <!-- FAQ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
36 <A NAME="faq"></A><HR>
37 <H1 ALIGN="CENTER">FAQ</H1>
38 <HR WIDTH="70%">
40 <P>
41 There are various sources of information you should check before
42 writing mails directly to <A
43 HREF="mailto:lirc@bartelmus.de">me</A>. Please read the <A
44 HREF="http://www.lirc.org/">LIRC homepage</A> carefully and have
45 a look at the <A HREF="http://www.lirc.org/faq.html">FAQ</A>.
46 </P>
47 <P>
48 If your question is not answered there try the <A
49 HREF="http://lists.sourceforge.net/mailman/listinfo/lirc-list">LIRC
50 mailing list</A>. Before posting to the list check the <A
51 HREF="http://sourceforge.net/mailarchive/forum.php?forum_id=5339">mailing list archive</A> for an answer.
52 </P>
54 <!-- BUGS ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
56 <A NAME="bugs"></A><HR>
57 <H1 ALIGN="CENTER">Reporting bugs</H1>
58 <HR WIDTH="70%">
60 <P>
61 If you believe that you have found a bug in LIRC your bug report
62 should contain the following information:
63 </P>
64 <UL>
65 <LI>LIRC version, versions of all other packages involved</LI>
66 <LI>description of the IR hardware you are using</LI>
67 <LI>Are you using a SMP machine?</LI>
68 <LI>output of <em>ls -l /dev/lirc*</em></LI>
69 <LI>output of <em>lsmod</em></LI>
70 <LI>relevant passages from <em>/var/log/messages</em></LI>
71 <LI>contents of lircd's logfile <em>/var/log/lircd</em><BR> Compile
72 LIRC in debug mode. A new command line option
73 (<em>-d[debug_level]</em>) will become available for
74 <em>lircd</em>. The debug level (0 to 5) will control how much
75 additional debug output will be displayed. But be careful with
76 this. After some extensive debug sessions I once discovered that my
77 logfile was using 110 MBytes of disk space. :-)</LI>
78 <LI>a description of the problem so I can reproduce it</LI>
79 <LI>a patch that solves the problem (this one is optional)</LI>
80 <LI>the config files you are using (<em>lircd.conf</em>,
81 <em>lircmd.conf</em>, <em>.lircrc</em>)</LI>
82 <LI>If you have problems with a config file try to find the
83 shortest example that does not work as one would expect and
84 include it.</LI>
85 </UL>
86 <P>
87 If you have problems with one of the TV card drivers you should
88 write to the according authors directly. You will find their
89 email addresses in the source code and at the <A
90 HREF="http://www.lirc.org/developers.html">developers page</A>.
91 </P>
93 <!-- New remotes++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
95 <A NAME="new_remote"></A><HR>
96 <H1 ALIGN="CENTER">Adding new remote controls</H1>
97 <HR WIDTH="70%">
99 <P>
100 The following description was written having receivers in mind
101 that deliver IR signals as pulses and spaces. So some of this
102 will not be relevant for receivers that work at a higher
103 abstraction layer as <NOBR>e.g.</NOBR> the Irman or TV card
104 receivers.
105 </P>
108 There already is a growing database of config files for remote
109 controls available at the LIRC homepage. But if your remote
110 control is not available yet you can use <em>irrecord</em> to
111 create a config file for your remote control. If you want to
112 use more than one remote control you have to create a separate
113 file for each remote. If your remote control is able to control
114 different devices it is often wise to create separate config
115 files for each functional unit of the remote control. You can
116 later use a single config file for <em>lircd</em> by simply
117 merging the config files with <NOBR><em>cat config1 config2
118 &gt;lircd.conf</em></NOBR>.
119 </P>
122 Before using <em>irrecord</em> you should start <em>mode2</em>
123 and have a look at the signals that your receiver supplies. If
124 you can see random pulses without pushing any buttons of your
125 remote control your receiver is picking up ambient light. So if
126 your receiver has no ambient light filter try to add one. A good
127 strategy might also be to create a config file in a dark room
128 and to turn off all fluorescent lamps or any other devices that
129 may cause IR noise.
130 </P>
133 If decoding of IR commands does not work reliably you can try to
134 modify the <em>eps</em> and <em>aeps</em> values in the lircd
135 config file to adjust the tolerance of signal
136 lengths. <em>aeps</em> is an absolute value while <em>eps</em>
137 is a relative value expressed in percent. Also if repeats do not
138 work you should complain. I.e. if you hold down a button the
139 output of <em>irw</em> should look like this.
140 </P>
141 <PRE>
142 0000000000f40bf0 00 1_DOWN ANIMAX
143 0000000000f40bf0 01 1_DOWN ANIMAX
144 0000000000f40bf0 02 1_DOWN ANIMAX
145 0000000000f40bf0 03 1_DOWN ANIMAX
146 0000000000f40bf0 04 1_DOWN ANIMAX
147 0000000000f40bf0 05 1_DOWN ANIMAX</PRE>
149 Note how the second field gets incremented. Many people don't
150 even notice if this does not work correctly.
151 </P>
154 If you want to use a config file to send IR commands you should
155 try to vary the modulation frequency of the signals. The default
156 frequency is <NOBR>38000 Hz</NOBR>. It cannot be detected
157 automatically because the receiver hardware only gives us the
158 demodulated signals. Using the correct modulation frequency will
159 increase range significantly. You can set the modulation
160 frequency for a remote control by adding the line
161 <PRE>
162 frequency &lt;freq&gt;</PRE>
164 to the according section of the config file where <em>freq</em>
165 stands for the modulation frequency in Hertz. Usually values
166 from 34000 to 44000 are good choices.
167 </P>
170 As creating new config files is difficult sometimes and irrecord
171 often cannot detect all features of the remote control please
172 send new config files to <A
173 HREF="mailto:lirc@bartelmus.de">lirc@bartelmus.de</A>. Other
174 people will appreciate this very much. Sometimes they cannot
175 create such a config file themselves because their original
176 remote control is broken or has been lost. Some devices that are
177 capable of IR come without a remote control. Some people also
178 only want to build a transmitter and if you make a config file
179 available for them they won't need to build a receiver,
180 too. Please add all information you can get concerning the
181 remote control as a comment to the config file.
182 </P>
185 If you still have difficulties to create a working config file
186 send the following information to <A
187 HREF="mailto:lirc@bartelmus.de">lirc@bartelmus.de</A>:
188 </P>
189 <UL>
190 <LI>version of LIRC that you are using<BR>
191 Check if you are using the current version and if there
192 already is a config file for your remote control.</LI>
193 <LI>description of your problem</LI>
194 <LI>config file created by irrecord, if available</LI>
195 <LI>
196 output of irrecord in <em>DEBUG mode</em> (you can compile
197 LIRC in DEBUG mode by selecting this feature in the
198 <em>Software configuration</em> section of the setup program
199 or by adding <em>--enable-debug</em> to the configure script
200 command line)</LI> <LI>output of mode2<BR>
202 Make sure you hold down some buttons for a while so that
203 repeat codes will be visible. Do NOT edit this output. Just
204 send it to me!</LI>
205 </UL>
207 I won't be able to answer any emails that do not contain the
208 necessary information!
209 </P>
211 <!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
213 <BR><BR>
214 <CENTER>[<A HREF="http://www.lirc.org/">LIRC homepage</A>]<BR>
215 <I>The LIRC Manual, last update: 12-Oct-2008</I></CENTER>
216 <BR><BR>
217 </TD>
218 <TD WIDTH="15%">&#160;<BR></TD>
219 </TR>
220 </TABLE>
221 </TD>
222 </TR>
223 <TR>
224 <TD CLASS="menu" WIDTH="100%">&#160;<BR>
225 </TD>
226 </TR>
227 </TABLE>
228 </BODY>
229 </HTML>