Debian Codegraph @

README

raw
1 README file for libirman v0.5.0
2 by Tom Wheeley <[email protected]>
3
4 v0.5.2 maintenance release by Alec Leamas
5 - Plugin: Fix logging issues.
6 - Configure the sys/file.h header (Debian #436563).
7 - Build: Fix parallel make glitch.
8
9 v0.5.1 maintenance release by Alec Leamas
10 - Fix FTBS bug for --enable-swtest
11 - Clean up plugin installation.
12
13 v0.5.0 maintenance release by Alec Leamas
14
15 - Always build the irman.test* tools.
16 - If compiled with lirc > 0.9.3, builds the irman lirc plugin (i. e., driver).
17 Disable using the new --without-plugin configure option.
18 - Update autotools setup to current standards.
19 - Added pkg-config support (libirman.pc).
20 - Added VPATH build support.
21
22 Copyright and Licensing
23
24
25 libirman v0.4.5, Copyright (C) 1998,1999 Tom Wheeley <[email protected]>
26
27 The files which make up the library are covered under the GNU Library
28 General Public License, which is in the file COPYING.lib.
29
30 The files which make up the test programs and the documentation are covered
31 under the GNU General Public License, which is in the file COPYING.
32
33
34
35 Introduction
36
37
38 libirman is a library for accessing the IRMAN hardware from Linux
39 and other Unix systems.
40
41 Currently the package is mainly for advanced users and developers; this
42 does not mean that less experienced users will not be able to use it, but
43 that there are not a lot of applications for libirman at the moment, and
44 that if you run into problems you may have difficulty fixing things.
45
46 Read the file TECHNICAL to see how libirman works, and how to use it in your
47 applications.
48
49
50 Use with LIRC
51
52 For general applications programming, the preferred interface for infra-red
53 control is `lirc', as lirc supports multiple programs sharing the same
54 infra-red receiver. It does this by providing a socket based interface to
55 which several programs can connect.
56
57 lirc uses libirman to interface with the Irman hardware, so in single use
58 applications directly using libirman is simpler and uses less system
59 resources. Currently, lirc only works on Linux systems, so programs written
60 using libirman directly are more portable.
61
62 Prior to lirc 0.9.4 lirc depended on libirman to build the libirman support.
63 From lirc 0.9.4 and libirman 0.5.0 lirc does not depend on libirman. Instead,
64 the libirman package can build the required lirc plugin with the new
65 --with-plugin configure option.
66
67
68
69 Other Information
70
71 my homepage
72 http://www.tsys.demon.co.uk
73
74 libirman homepage
75 http://www.evation.com/libirman/
76
77 Irman hompage
78 http://www.evation.com/irman/
79
80 LIRC homepage
81 http://www.lirc.org/
82
83 Infra red remotes (technical information)
84 http://falcon.arts.cornell.edu/~dnegro/IR/IR.html
85
86 Universal Infra Red Receiver (build your own Irman)
87 http://www.geocities.com/SiliconValley/Sector/3863/infrared.html
88
89
90
91 Installation
92
93
94 To build libirman, run
95
96 autoreconf -fi
97 ./configure
98 make
99 make install
100
101 The autoreconf step is optional, but recommended. You can also build
102 without cluttering the sources:
103
104 autoreconf -fi
105 mkdir _build; cd _build
106 ../configure
107 make
108 make install
109
110 You may well like to check the available options to configure by typing
111
112 ./configure --help
113
114 the most important are: --prefix ,--enable-swtest and without-plugin.
115
116 This will create the following important files:
117
118 libirman.a The static library which talks to the irman and
119 manages the results
120 libirman.so.* Equivalent dynamic libraries.
121
122 test_io Test program for the low level functions in libirman
123 test_func Test program for the mid-level functions in libirman
124 test_name test program for the name functions.
125
126 workmanir Program to control workman via infra red
127
128 irman.so LIRC irman plugin
129
130 By default they are installed in /usr/local besides the LIRC plugin which is
131 installed as defined by LIRC. If you do not use the --prefix option to
132 `configure' then you will need to be root to run `make install'; installing
133 the LIRC plugin typically also requires root permissions.
134
135
136 Using libirman
137
138
139 Firstly, you should test that the system works. Run `test_io' with the
140 hardware plugged in and see if code numbers appear on the screen when you
141 press buttons on your remote control.
142
143 Once the basic hardware works, you should run `test_func' to help you set up
144 libirman for your remote control. Make sure you have available virtual
145 consoles, or are running either `screen' or `X' or some other similar
146 multi-tasking aid.
147
148 The file `irman.conf' should be copied to /usr/local/etc/irman.conf. You may
149 want to copy this to `~/.irmanrc'. libirman searches first for ~/.irmanrc,
150 and if that is not found reads /usr/local/etc/irman.conf.
151
152 Press each button on your remote control, and note down the number printed -
153 you need to add a `bind' line to your irmanrc file, noting the naming
154 convention used:
155
156 bind manufacturer-device-button code
157
158 once you have entered in the data for your remote control, you should change
159 the workman-* alias lines to point to your remote control's entries.
160
161 You may also like to specify the default port in the config file.
162
163 Once you have entered in names into your irman config file, try running
164 `test_name' to see if the bindings have worked. (You should see the names
165 you gave on the `bind' lines appear as you press the buttons).
166
167 To see if `workmanir' works, make sure you are already running `workman', then
168 start `workmanir' and try pressing buttons. Make sure you have changed the
169 `alias' lines in your irman.conf.
170
171
172 Testing
173
174
175 If you want to test libirman without using the irman hardware, you can run:
176
177 `./configure --enable-swtest; make'
178
179 which will create libirman_sw.a and programs *_sw (except test_io). These
180 will ask you to enter a twelve digit hex code to represent a code instead of
181 querying the hardware.
182
183 If you compile libirman with the define -DDEBUG_COMM then every byte
184 read/written from the serial port is printed to stdout.
185 (to do this run: CPPFLAGS=-DDEBUG_COMM ./configure; make clean; make)
186
187
188
189 Credits
190
191
192 Thankyou to the following:
193
194 Christoph Bartelmus <[email protected]>
195 maintainer of LIRC project.
196
197 Bill Ryder <[email protected]>
198 fix to make it work on SGI Indy's (and other Unix boxes)
199
200 MiniDisc, http://www.minidisc.org
201 for being just so damn cool.