diff options
| -rw-r--r-- | doc/irbox.5 | 120 | ||||
| -rw-r--r-- | doc/irbox.8 | 128 |
2 files changed, 248 insertions, 0 deletions
diff --git a/doc/irbox.5 b/doc/irbox.5 new file mode 100644 index 0000000..c672c0e --- /dev/null +++ b/doc/irbox.5 @@ -0,0 +1,120 @@ +.\" +.\" +.\" IRBOX, an Ivy driver for infra-red remote controls +.\" +.\" Copyright 1998-1999 +.\" Centre d'Etudes de la Navigation Aerienne +.\" +.\" man page for irbox tables +.\" +.\" Authors: Stephane Chatty <chatty@cena.dgac.fr> +.\" +.\" $Id$ +.\" +.\" Please refer to file version.h for the +.\" copyright notice regarding this software +.\" +.TH irbox 5 "17 Dec 1999" +.ds )H CENA, France. +.ds ]W V1.2 +.SH NAME +irbox \- format of the remote control tables +.SH "DESCRIPTION" +When a key is pressed on a remote control aimed at an IRMAN receiver, the +receiver emits a series of 6 bytes. It happens that with very few exceptions +every series of 6 bytes is unique and corresponds to a given key of a given +remote control type. + +For each type of infra-red remote control you want your IRMAN receiver to deal +with there should be a table indicating that tells +.B irbox +how to map the bytes it receives to keys on the remote control. + +Tables are read when +.B irbox +is launched, or when it receives a +.B SIGHUP +signal. + +.SH "FORMAT" +Tables are text files structured in lines. A table can contain the following lines: + +.SS name <table_name> +specifies the name that will be used to characterize this type of remote control +in Ivy events when a key described in the table is detected. + +.SS type: <appliance_kind> +specifies the type of device the remote control is normally used for (TV, VCR, cable, +etc.). For programmable remote controls, it specifies in which mode they should +be set to use this table. This information is ignored by +.B irbox +. + +.SS brand: <remote_control_ reference> +specifies what remote control can be associated to this table. The reference can +be that of the control itself or that of the appliance it controls. In the case of +a programmable remote control, this line can be used to remember how it should +be programmed to trigger this table. This information is ignored by +.B irbox +. +There can be more than one such line: there can be several remote control +references that have the same behaviour. + +.SS <key>: <byte1> <byte2> <byte3> <byte4> <byte5> <byte6> +tells +.B irbox +to associate this series of 6 bytes to +.I +key +. + +Comments start with '#'. + +.SH EXAMPLE +The following table describes the remote control for Aiko VCRs. It was obtained +from a RCA programmable remote control in the Aiko VCR mode. +.sp +.RS +.4i +.ta 1.5i +.nf +name AikoVCR +type: VCR + +brand: Aiko +brand: RCA SystemLink 3 [mode 027] + +# obtained on an RCA SystemLink 3 in VCR mode 027 + +power: 168 212 000 000 000 000 +channel up: 168 244 000 000 000 000 +channel down: 168 140 000 000 000 000 +rew: 168 132 000 000 000 000 +play: 168 184 000 000 000 000 +ff: 168 248 000 000 000 000 +rec: 168 164 000 000 000 000 +stop: 168 216 000 000 000 000 +pause: 168 196 000 000 000 000 +.fi +.RE +.sp + +If the user depresses the +.I power +key of an Aiko VCR remote control, +.B +irbox +will emit the following event on its Ivy bus: +.IP +.B localhost:IRBOX Down control=AikoVCR button=power + +.SH "FILES" +Tables are usually found in +.BR /usr/lib/irbox/*.ir + +.SH "SEE ALSO" +.BR irbox (8) + +.SH AUTHOR +This manual page was written by Stéphane Chatty <chatty@cena.dgac.fr> +for the GNU/Linux system. + diff --git a/doc/irbox.8 b/doc/irbox.8 new file mode 100644 index 0000000..ec5c461 --- /dev/null +++ b/doc/irbox.8 @@ -0,0 +1,128 @@ +.\" +.\" +.\" IRBOX, an Ivy driver for infra-red remote controls +.\" +.\" Copyright 1998-1999 +.\" Centre d'Etudes de la Navigation Aerienne +.\" +.\" man page for irbox +.\" +.\" Authors: Stephane Chatty <chatty@cena.dgac.fr> +.\" +.\" $Id$ +.\" +.\" Please refer to file version.h for the +.\" copyright notice regarding this software +.\" + +.TH irbox 8 "17 Dec 1999" +.ds )H CENA, France. +.ds ]W V1.2 +.SH NAME +irbox - an Ivy agent that manages an IRMAN infra-red receiver +.SH SYNOPSIS +.B "irbox [-b bus] [-s serial_device] [-n agent_name] [-p table_dir]" +.SH DESCRIPTION +.B irbox +is an Ivy agent that decodes signals received on a serial link from an IRMAN +infra-red receiver (see http://www.evation.com/irman/) and emits the +corresponding events on an Ivy bus. This can be used to write Ivy agents that +react to an infra-red remote control. + +Thanks to the quasi-uniqueness of the codes emitted by an IRMAN receiver and to +translation tables provided for many types of remote controls, +.B irbox +is able to distinguish and decode key presses from many different remote controls. + +.SH OPTIONS +.RS +.TP +.B -s serial_device +Use the device connected to the serial link defined by +.I serial_device. +If this option is not used, the value of the environment variable +.B IRBOX_DEVICE +is used. The default value is /dev/ttyS0. + +.TP +.B -p table_dir +Retrieve translation tables from directory +.I table_dir. +If this option is not used, the value of the environment variable +.B IRBOX_DIR +is used. The default value is /usr/lib/irbox. + +.TP +.B -b bus +Emit events on the Ivy bus defined by the address +.I bus. +The syntax of bus addresses is +.I [network[,network]][:port], +where +.I port +is the UDP port used to broadcast information on the Ivy bus, and +.I network[,network] +is a set of network addresses on which information is +broadcast. Examples of bus adresses are 192.75:2000, :2001 or 192.75,192.76. +The default port is +.I 2010, +and the default network is +.I 127, +ie. loopback on the +local host. + +.TP +.B -n agent_name +Use +.I agent_name +as the application name in the events emitted. + +.SH EXAMPLE +.LP +This example connects +.B irbox +to an IRMAN receiver plugged into the /dev/ttyS0 port, and remits events on the +bus :2010 (port 2010 on local host). + +.IP +.B irbox \-b +.I :2010 +.B \-s +.I /dev/ttyS0 +.LP +If the user aims an Aiko VCR control at the IRMAN receiver and depresses the +.I power +key, the following event will be emitted: +.IP +.B localhost:IRBOX Down control=AikoVCR button=power + +.SH ENVIRONMENT VARIABLES +The variable +.B IRBOX_DEVICE +can be used to specify the serial link to be used instead of using the -s option. +The variable +.B IRBOX_DIR +can be used to specify the data directory for translation tables instead of using the -p option. + +.SH SIGNALS + +Upon a +.B SIGHUP +signal, +.B irbox +rereads all the translation tables present in the data directory. + +.SH LAUNCH AT BOOT TIME +.B irman +can be launched at boot time like many daemons. It comes with launch files +for Debian and RedHat Linux. + +.SH ERRORS +If it gets no response from the IRMAN receiver at launch time, +.B irbox +exits after a few seconds. + +.SH SEE ALSO +.PP +irbox(5), +Ivy(1) |