WinLIRC

[ Configuration File Format | Registry Keys]

Configuration File Format

Normally it is not necessary to know anything about the configuration file format. But if you're trying to improve the reliability of your transmitter, or add some codes that don't exist on your remote, it can be nice to know this. If you're writing an application which translates the configuration from say Pronto or Slinke or another format to LIRC format, this is essential. In this section pulses refer to the times during which a sequence of infrared bursts at the appropriate carrier frequency is being sent and spaces refer to times in the idle state.

Basic Structure

The files may contain an unlimited number of comments and remote blocks. Whitespace and line breaks are used as delimiters.

Comments

If the comment character (#) appears as the first character on a line the rest of the line is ignored.

Remote Blocks

Remote blocks begin with begin remote and end with end remote. The first part of this section describes the basic properties of the remote. Following this is a codes section, which is delimited by begin codes and end codes or by begin raw_codes and end raw_codes depending on whether they represent the decoded signals or the raw signals.

Remote description section

Each line in this section contains a parameter followed by the value or values that should be assigned to that parameter. Most of these parameters are optional except for name. You may not assign the same name to two different remotes in the same configuration file. See the Remote Parameters section for more details.

Codes Section

Each line in this section contains the name of a button on the remote followed by its hexidecimal data value. You may not assign the same name to two buttons in the same remote section

Raw Codes Section

A button description begins with the parameter name and followed by the name of the button. The button description ends with the next button description or the end of the raw_codes block. The lines in between consist of a list of decimal numbers describing the signal sent by that button. The first number indicates the duration of the first pulse in microseconds. The second number indicates the duration of the space which follows it. Pulse and space durations alternate for as long as is necessary. The last duration should represent a pulse.

Remote Parameters

All values are decimal integers that are either dimensionless or have units of microseconds unless otherwise stated. Hexidecimal numbers should be prefixed by 0x. If the remote does not have a particular "feature," then the line may be omitted. The button code is sent just after the pre signal and just before the post signal.

Fields

name <remote name>
The unique name assigned to the remote control (may not contain whitespace).
bits <number of data bits>
This is the number of data bits in the hexidecimal codes which describe each button (decimal integer).
flags <flag1><|flag2>. . . etc.
Flags are special text strings which describe various properties of the remote, and determine the meaning of some of the following fields. Multiple flags are allowed if separated by the pipe(|) symbol.
eps <relative error tolerance>
The relative error tolerance for received signals in percent (decimal integer).
aeps <absolute error tolerance>
The absolute error tolerance for received signals in microseconds.
header <phead> <shead>
The initial pulse and space sent.
three <pthree> <sthree>
Only used by RC-MM remotes
two <ptwo> <stwo>
Only used by RC-MM remotes
one <pone> <sone>
The pulse and space lengths representing a one.
zero <pzero> <szero>
The pulse and space lengths representing a zero.
ptrail <trailing pulse>
A trailing pulse, immediately following the post_data.
plead <leading pulse>
A leading pulse, immediately after the header.
foot <pfoot> <sfoot>
A pulse and space, immediately following the trailing pulse.
repeat <prepeat> <srepeat>
A pulse and space that replaces everything between leading pulse and the trailing pulse, whenever a signal is repeated. The foot is not sent, and the header is not sent unless the REPEAT_HEADER flag is present.
pre_data_bits <number of pre_data_bits>
The number of bits in the pre_data code.
pre_data <hexidecimal number>
Hexidecimal code indicating the sequence of ones and zeros immediately following the leading pulse.
post_data_bits <number of post data bits>
The number of bits in the post_data code.
post_data <hexidecimal number>
Hexidecimal code indicating the sequence of ones and zeros immediately following the post signal.
pre <ppre> <spre>
A pulse and space immediately following the pre_data.
post <ppost> <spost>
A pulse and space immediately following the button code.
gap <gap length>
A (typically long) space which follows the trailing pulse.
repeat_gap <repeat_gap length>
A gap immediately following the trailing pulse, and preceding a repetition of the same code that's due to a the same press of the button.
min_repeat <minimum number of repetitions>
The minimum times a signal is repeated each time a button is pressed. Note that 0 means the signal is send only one time.
toggle_bit <bit to toggle>
A bit of the pre_data, code, or post_data that is toggled between one and zero each time a button is pressed.
frequency <hertz>
The carrier frequency of the remote (default is 38000).
duty_cycle <on time>
The percentage of time during a pulse that infrared light is being sent (default is 50).
transmitter <hexidecimal number>
The number specified is the same as the transmitter type value that appears in the registry. (Not supported by LIRC). The default is DTR with a software carrier. Note WinLIRC will never place this field into a configuration file that it writes.

Flags Description

RC5
The remote uses the RC5 protocol.
RC6
The remote uses the RC6 protocol.
RCMM
The remote uses the RC-MM protocol (transmitting not supported).
SHIFT_ENC
Obsolete flag, now a synonym for RC5. The position of the pulse (before or after the space) determines whether the bit is a one or a zero.
SPACE_ENC
A one and a zero can be distinguished by the length of the spaces.
REVERSE
Reverses the bit order of the pre_data, the post_data and the codes (e.g., 0x123 becomes 0xC48). If this flag is present, the least significant bit is sent first.
NO_HEAD_REP
The header is not sent when a signal (the button is held down) is repeated even though there is no special repeat code.
NO_FOOT_REP
The foot is not sent when a signal is repeated (the button is held down) even though there is no special repeat code .
CONST_LENGTH
The total signal length is always constant. The gap length now represents the length of the entire signal, and the actual gap at the end of the signal is adjusted accordingly.
RAW_CODES
The codes are in raw format.
REPEAT_HEADER
Send the header when the signal is repeated even though the remote has a special repeat code.
SPECIAL_TRANSMITTER
Use the transmitter type specified for this remote. (Not supported by LIRC).

Protocol Description

In this section complement means 1's are replaced by 0's and 0's are replaced by 1's (e.g., the complement of 0xA2 is 0x5D).

Pioneer SR

Typical Header:

  bits           16
  flags SPACE_ENC|REVERSE|CONST_LENGTH|SPECIAL_TRANSMITTER

  header       9000  4000
  one           700  1400
  zero          700   350
  ptrail        700
  pre_data_bits  16
  gap          100000
  transmitter   0x05 	# DTR hardware carrier (no carrier frequency for control by wire)

The value for pre_data should be the device code (8 bits) preceded by its complement. Known device codes are A1, A2, A4, A5, A8, and AB. They stand for tape, cd-player, tuner, receiver, laserdisc, and VCR respectively. The button code values should be the data code (8 bits) preceded by its complement. Most of this information was derived from Kai Fett's webpage, who indicates support from pioneer. The control by wire seems to be capable of any "full logic" (i.e., not mechanical) function available from the front panel of a device. And not merely the codes listed on that website.

Yamaha

Typical Header:

 bits           16
 flags SPACE_ENC|REVERSE

 header       9067  4393
 one           642   470
 zero          642  1600
 ptrail        642
 repeat       9065  2139
 pre_data_bits   16
 gap          39597

The value for pre_data should be the "custom code" (8 bits) followed by its complement. The button code values should be the "data code" (8 bits) followed by its complement. Custom codes and data codes for Yamaha's current productline are available in the Infrared codes section of yamaha's website. Their latest home theater equipment supports "extended" codes not found on the remote control.

RCA/Proscan

Typical Header:

  bits           24
  flags SPACE_ENC|CONST_LENGTH

  header       4141  3819
  one           679  1757
  zero          679   785
  ptrail        679
  gap          62910
  frequency     57600

The button code values seem to be the device code (4 bits) followed by the data code (8 bits), then the complement of the device code, and the complement of the data code.

Registry Keys

The registry keys are placed (and sought) in HKLM\software\LIRC if possible, otherwise HKCU is used.

animax DWORD
If 1, DTR is set high. The animax receiver uses this pin for power.
conf STRING
The full pathname for the configuration file
devicetype DWORD
1 for DCD device, 0 for RX device.
notrayicon DWORD
If 1, the tray icon is not displayed.
password STRING
The command (sent via the TCP/IP interface) used to send an IR signal. If this key does not exist sending is disabled. This command should not contain whitespace. Set to SEND_ONCE for compatibility with LIRC.
port STRING
The port where the receiver is attached.
sense DWORD
0 for active low receivers, 1 for active high receivers, 2 for autosense.
speed DWORD
The serial port bit rate for RX receivers.
transmittertype DWORD
The default type of transmitter.
virtpulse DWORD
The pulse length for RX receivers (RX receivers cannot detect the actual pulse length, so a fake one is used).

Copyright (C) 2002 Scott Baily <baily@uiuc.edu>.
Last update: Thursday, June 13, 2013 at 08:27 PM
Hits (since May 21, 2001):