org.harctoolbox.jirc

Class IrRemote

java.lang.Object

org.harctoolbox.jirc.IrRemote

public final class IrRemote
extends Object

This class represents a remote in Lirc, with all its parameters. It should preferably not be used outside of the package, and may be package private in a future version.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	IrRemote.XY

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	aeps detecing _very short_ pulses is difficult with relative tolerance for some remotes, this is an _absolute_ tolerance to solve this problem usually you can say 0 here
(package private) int	baud
(package private) int	bits bits (length of code)
(package private) static int	BO encoding found on Bang & Olufsen remote
(package private) static int	COMPAT_REVERSE compatibility mode for REVERSE flag
(package private) static int	CONST_LENGTH signal length+gap is always constant
(package private) static int	DEFAULT_FREQ
(package private) int	duty_cycle 0 < duty cycle ≤ 100
(package private) int	eps eps (_relative_ tolerance)
(package private) int	flags flags
(package private) int	freq modulation frequency
(package private) int	gap time between signals in usecs
(package private) int	gap2 time between signals in usecs
(package private) static int	GOLDSTAR encoding found on Goldstar remote
(package private) static int	GRUNDIG encoding found on Grundig remote
(package private) long	ignore_mask mask defines which bits can be ignored when matching a code
(package private) static int	IR_PROTOCOL_MASK definitions for flags
(package private) IrNCode	last_code code received or sent last
(package private) Date	last_send time last_code was received or sent
(package private) int	max_gap_length how long is the longest gap
(package private) int	max_pulse_length
(package private) int	max_remaining_gap gap range
(package private) int	max_space_length
(package private) int	min_code_repeat meaningful only if remote sends a repeat code: in this case this value indicates how often the real code is repeated before the repeat code is being sent
(package private) int	min_gap_length how long is the shortest gap
(package private) int	min_pulse_length
(package private) int	min_remaining_gap remember gap for CONST_LENGTH remotes
(package private) int	min_repeat code is repeated at least x times code sent once .
(package private) int	min_space_length
(package private) int	min_total_signal_length how long is the shortest signal including gap
(package private) IrRemote	next
(package private) static int	NO_FOOT_REP no foot for key repeats
(package private) static int	NO_HEAD_REP additional flags: can be or-red together with protocol flag
(package private) int	pfoot foot
(package private) int	phead pulse and space lengths of: header
(package private) int	plead leading pulse
(package private) int	pone 1
(package private) long	post_data data which the remote sends after actual keycode
(package private) int	post_data_bits length of post_data
(package private) int	post_p signal between keycode and post_code
(package private) int	post_s
(package private) long	pre_data data which the remote sends before actual keycode
(package private) int	pre_data_bits length of pre_data
(package private) int	pre_p signal between pre_data and keycode
(package private) int	pre_s
(package private) int	prepeat indicate repeating
(package private) int	pthree 3 (only used for RC-MM)
(package private) int	ptrail trailing pulse
(package private) int	ptwo 2 (only used for RC-MM)
(package private) int	pzero 0
(package private) static int	RAW_CODES for internal use only
(package private) static int	RC5
(package private) static int	RC6 IR data follows RC6 protocol
(package private) long	rc6_mask RC-6 doubles signal length of some bits
(package private) static int	RCMM IR data follows RC-MM protocol
(package private) boolean	release_detected set by release generator
(package private) int	repeat_countdown
(package private) int	repeat_gap time between two repeat codes if different from gap
(package private) static int	REPEAT_HEADER header is also sent before repeat code
(package private) static int	REPEAT_MAX_DEFAULT stop repeating after 600 signals (approx.
(package private) int	reps
(package private) static int	REVERSE
(package private) int	sfoot
(package private) int	shead
(package private) static int	SHIFT_ENC IR data is shift encoded (name obsolete) Hm, RC6 protocols seem to have changed the biphase semantics so that lircd will calculate the bit-wise complement of the codes.
(package private) int	sone
(package private) static int	SPACE_ENC IR data is space encoded
(package private) static int	SPACE_FIRST bits are encoded as space+pulse
(package private) int	srepeat
(package private) int	sthree
(package private) int	stwo
(package private) int	suppress_repeat suppress unwanted repeats
(package private) int	szero
(package private) int	toggle_bit obsolete
(package private) long	toggle_bit_mask previously only one bit called toggle_bit
(package private) long	toggle_bit_mask_state
(package private) IrNCode	toggle_code toggle code received or sent last
(package private) long	toggle_mask Sharp (?) error detection scheme
(package private) int	toggle_mask_state
(package private) static int	XMP XMP protocol

Constructor Summary

Constructors

Constructor and Description
IrRemote(String name, String driver, List<String> flags, Map<String,Long> unaryParameters, Map<String,IrRemote.XY> binaryParameters, List<IrNCode> codes)

Method Summary

Modifier and Type	Method and Description
int	bit_count()
(package private) static int	bit_count(IrRemote remote)
(package private) static int	bits_set(long data)
(package private) static long	gen_mask(int bits)
Map<String,String>	getApplicationData()
(package private) List<IrNCode>	getCodes()
int	getDutyCycle()
int	getFreq()
String	getName()
static IrRemote	getRepeat_remote()
String	getSource()
(package private) boolean	has_foot()
(package private) static boolean	has_foot(IrRemote remote)
boolean	has_header()
static boolean	has_header(IrRemote remote)
(package private) static boolean	has_ignore_mask(IrRemote remote)
boolean	has_post()
(package private) static boolean	has_post(IrRemote remote)
boolean	has_pre()
(package private) static boolean	has_pre(IrRemote remote)
boolean	has_repeat_gap()
(package private) static boolean	has_repeat_gap(IrRemote remote)
boolean	has_repeat()
(package private) static boolean	has_repeat(IrRemote remote)
boolean	has_toggle_bit_mask()
(package private) static boolean	has_toggle_bit_mask(IrRemote remote)
(package private) boolean	has_toggle_mask()
(package private) static boolean	has_toggle_mask(IrRemote remote)
(package private) boolean	is_biphase()
(package private) static boolean	is_biphase(IrRemote remote)
boolean	is_bo()
static boolean	is_bo(IrRemote remote)
boolean	is_const()
(package private) static boolean	is_const(IrRemote remote)
boolean	is_goldstar()
static boolean	is_goldstar(IrRemote remote)
boolean	is_grundig()
static boolean	is_grundig(IrRemote remote)
(package private) static boolean	is_pulse(int data)
boolean	is_raw()
static boolean	is_raw(IrRemote remote)
boolean	is_rc5()
static boolean	is_rc5(IrRemote remote)
boolean	is_rc6()
static boolean	is_rc6(IrRemote remote)
boolean	is_rcmm()
static boolean	is_rcmm(IrRemote remote)
boolean	is_space_enc()
(package private) static boolean	is_space_enc(IrRemote remote)
boolean	is_space_first()
static boolean	is_space_first(IrRemote remote)
(package private) static boolean	is_space(int data)
boolean	is_xmp()
static boolean	is_xmp(IrRemote remote)
boolean	isTimingInfo()
String	lircProtocolType()
int	max_gap()
(package private) static int	max_gap(IrRemote remote)
int	min_gap()
(package private) static int	min_gap(IrRemote remote)
static org.harctoolbox.girr.RemoteSet	newRemoteSet(Collection<IrRemote> remotes, String configFilename, String creatingUser, boolean alternatingSigns, int debug)
(package private) org.harctoolbox.ircore.IrSequence	render(IrNCode code, boolean useSignsInRawSequences, boolean repeat, int debug)
(package private) static long	reverse(long data, int bits)
void	set_protocol(int protocol)
(package private) static void	set_protocol(IrRemote remote, int protocol)
static void	setRepeat_remote(IrRemote remote)
void	setSource(String source)
(package private) org.harctoolbox.girr.Command	toCommand(IrNCode code, boolean alternatingSigns, int debug)
(package private) org.harctoolbox.ircore.IrSignal	toIrSignal(IrNCode code, boolean alternatingSigns, int debug)
(package private) org.harctoolbox.girr.Command	toLircCodeCommand(IrNCode code)
org.harctoolbox.girr.Remote	toRemote(boolean alternatingSigns, int debug)
org.harctoolbox.ircore.ModulatedIrSequence	toSequence(int[] array, boolean alternatingSigns)
org.harctoolbox.ircore.ModulatedIrSequence	toSequence(List<Integer> signals, boolean alternatingSigns)
(package private) org.harctoolbox.girr.Command	toTimedCommand(IrNCode code, boolean alternatingSigns, int debug)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IR_PROTOCOL_MASK

static final int IR_PROTOCOL_MASK

definitions for flags

See Also:

Constant Field Values

RAW_CODES

static final int RAW_CODES

for internal use only

See Also:

Constant Field Values

RC5

static final int RC5

See Also:

Constant Field Values

SHIFT_ENC

static final int SHIFT_ENC

IR data is shift encoded (name obsolete) Hm, RC6 protocols seem to have changed the biphase semantics so that lircd will calculate the bit-wise complement of the codes. But this is only a guess as I did not have a datasheet...

See Also:

Constant Field Values

RC6

static final int RC6

IR data follows RC6 protocol

See Also:

Constant Field Values

RCMM

static final int RCMM

IR data follows RC-MM protocol

See Also:

Constant Field Values

SPACE_ENC

static final int SPACE_ENC

IR data is space encoded

See Also:

Constant Field Values

SPACE_FIRST

static final int SPACE_FIRST

bits are encoded as space+pulse

See Also:

Constant Field Values

GOLDSTAR

static final int GOLDSTAR

encoding found on Goldstar remote

See Also:

Constant Field Values

GRUNDIG

static final int GRUNDIG

encoding found on Grundig remote

See Also:

Constant Field Values

BO

static final int BO

encoding found on Bang & Olufsen remote

See Also:

Constant Field Values

XMP

static final int XMP

XMP protocol

See Also:

Constant Field Values

REVERSE

static final int REVERSE

See Also:

Constant Field Values

NO_HEAD_REP

static final int NO_HEAD_REP

additional flags: can be or-red together with protocol flag

See Also:

Constant Field Values

NO_FOOT_REP

static final int NO_FOOT_REP

no foot for key repeats

See Also:

Constant Field Values

CONST_LENGTH

static final int CONST_LENGTH

signal length+gap is always constant

See Also:

Constant Field Values

REPEAT_HEADER

static final int REPEAT_HEADER

header is also sent before repeat code

See Also:

Constant Field Values

COMPAT_REVERSE

static final int COMPAT_REVERSE

compatibility mode for REVERSE flag

See Also:

Constant Field Values

REPEAT_MAX_DEFAULT

static final int REPEAT_MAX_DEFAULT

stop repeating after 600 signals (approx. 1 minute). update technical.html when changing this value

See Also:

Constant Field Values

DEFAULT_FREQ

static final int DEFAULT_FREQ

See Also:

Constant Field Values

bits

int bits

bits (length of code)

flags

int flags

flags

eps

int eps

eps (_relative_ tolerance)

aeps

int aeps

detecing _very short_ pulses is difficult with relative tolerance for some remotes, this is an _absolute_ tolerance to solve this problem usually you can say 0 here

phead

int phead

pulse and space lengths of: header

shead

int shead

pthree

int pthree

3 (only used for RC-MM)

sthree

int sthree

ptwo

int ptwo

2 (only used for RC-MM)

stwo

int stwo

pone

int pone

1

sone

int sone

pzero

int pzero

0

szero

int szero

plead

int plead

leading pulse

ptrail

int ptrail

trailing pulse

pfoot

int pfoot

foot

sfoot

int sfoot

prepeat

int prepeat

indicate repeating

srepeat

int srepeat

pre_data_bits

int pre_data_bits

length of pre_data

pre_data

long pre_data

data which the remote sends before actual keycode

post_data_bits

int post_data_bits

length of post_data

post_data

long post_data

data which the remote sends after actual keycode

pre_p

int pre_p

signal between pre_data and keycode

pre_s

int pre_s

post_p

int post_p

signal between keycode and post_code

post_s

int post_s

gap

int gap

time between signals in usecs

gap2

int gap2

time between signals in usecs

repeat_gap

int repeat_gap

time between two repeat codes if different from gap

toggle_bit

int toggle_bit

obsolete

toggle_bit_mask

long toggle_bit_mask

previously only one bit called toggle_bit

suppress_repeat

int suppress_repeat

suppress unwanted repeats

min_repeat

int min_repeat

code is repeated at least x times code sent once . min_repeat=0

min_code_repeat

int min_code_repeat

meaningful only if remote sends a repeat code: in this case this value indicates how often the real code is repeated before the repeat code is being sent

freq

int freq

modulation frequency

duty_cycle

int duty_cycle

0 < duty cycle ≤ 100

baud

int baud

toggle_mask

long toggle_mask

Sharp (?) error detection scheme

rc6_mask

long rc6_mask

RC-6 doubles signal length of some bits

ignore_mask

long ignore_mask

mask defines which bits can be ignored when matching a code

toggle_bit_mask_state

long toggle_bit_mask_state

toggle_mask_state

int toggle_mask_state

repeat_countdown

int repeat_countdown

last_code

IrNCode last_code

code received or sent last

toggle_code

IrNCode toggle_code

toggle code received or sent last

reps

int reps

last_send

Date last_send

time last_code was received or sent

min_remaining_gap

int min_remaining_gap

remember gap for CONST_LENGTH remotes

max_remaining_gap

int max_remaining_gap

gap range

min_total_signal_length

int min_total_signal_length

how long is the shortest signal including gap

min_gap_length

int min_gap_length

how long is the shortest gap

max_gap_length

int max_gap_length

how long is the longest gap

min_pulse_length

int min_pulse_length

max_pulse_length

int max_pulse_length

min_space_length

int min_space_length

max_space_length

int max_space_length

release_detected

boolean release_detected

set by release generator

next

IrRemote next

Constructor Detail

IrRemote

IrRemote(String name,
         String driver,
         List<String> flags,
         Map<String,Long> unaryParameters,
         Map<String,IrRemote.XY> binaryParameters,
         List<IrNCode> codes)

Method Detail

getRepeat_remote

public static IrRemote getRepeat_remote()

setRepeat_remote

public static void setRepeat_remote(IrRemote remote)

newRemoteSet

public static org.harctoolbox.girr.RemoteSet newRemoteSet(Collection<IrRemote> remotes,
                                                          String configFilename,
                                                          String creatingUser,
                                                          boolean alternatingSigns,
                                                          int debug)

bit_count

static int bit_count(IrRemote remote)

bits_set

static int bits_set(long data)

reverse

static long reverse(long data,
                    int bits)

is_pulse

static boolean is_pulse(int data)

is_space

static boolean is_space(int data)

has_repeat

static boolean has_repeat(IrRemote remote)

set_protocol

static void set_protocol(IrRemote remote,
                         int protocol)

is_raw

public static boolean is_raw(IrRemote remote)

is_space_enc

static boolean is_space_enc(IrRemote remote)

is_space_first

public static boolean is_space_first(IrRemote remote)

is_rc5

public static boolean is_rc5(IrRemote remote)

is_rc6

public static boolean is_rc6(IrRemote remote)

is_biphase

static boolean is_biphase(IrRemote remote)

is_rcmm

public static boolean is_rcmm(IrRemote remote)

is_goldstar

public static boolean is_goldstar(IrRemote remote)

is_grundig

public static boolean is_grundig(IrRemote remote)

is_bo

public static boolean is_bo(IrRemote remote)

is_xmp

public static boolean is_xmp(IrRemote remote)

is_const

static boolean is_const(IrRemote remote)

has_repeat_gap

static boolean has_repeat_gap(IrRemote remote)

has_pre

static boolean has_pre(IrRemote remote)

has_post

static boolean has_post(IrRemote remote)

has_header

public static boolean has_header(IrRemote remote)

has_foot

static boolean has_foot(IrRemote remote)

has_toggle_bit_mask

static boolean has_toggle_bit_mask(IrRemote remote)

has_ignore_mask

static boolean has_ignore_mask(IrRemote remote)

has_toggle_mask

static boolean has_toggle_mask(IrRemote remote)

min_gap

static int min_gap(IrRemote remote)

max_gap

static int max_gap(IrRemote remote)

gen_mask

static long gen_mask(int bits)

getApplicationData

public Map<String,String> getApplicationData()

toRemote

public org.harctoolbox.girr.Remote toRemote(boolean alternatingSigns,
                                            int debug)

toCommand

org.harctoolbox.girr.Command toCommand(IrNCode code,
                                       boolean alternatingSigns,
                                       int debug)

toLircCodeCommand

org.harctoolbox.girr.Command toLircCodeCommand(IrNCode code)

toTimedCommand

org.harctoolbox.girr.Command toTimedCommand(IrNCode code,
                                            boolean alternatingSigns,
                                            int debug)

toIrSignal

org.harctoolbox.ircore.IrSignal toIrSignal(IrNCode code,
                                           boolean alternatingSigns,
                                           int debug)

getName

public String getName()

isTimingInfo

public boolean isTimingInfo()

getSource

public String getSource()

setSource

public void setSource(String source)

getCodes

List<IrNCode> getCodes()

getFreq

public int getFreq()

getDutyCycle

public int getDutyCycle()

bit_count

public int bit_count()

has_repeat

public boolean has_repeat()

set_protocol

public void set_protocol(int protocol)

is_raw

public boolean is_raw()

is_space_enc

public boolean is_space_enc()

is_space_first

public boolean is_space_first()

is_rc5

public boolean is_rc5()

is_rc6

public boolean is_rc6()

is_biphase

boolean is_biphase()

is_rcmm

public boolean is_rcmm()

is_goldstar

public boolean is_goldstar()

is_grundig

public boolean is_grundig()

is_bo

public boolean is_bo()

is_xmp

public boolean is_xmp()

is_const

public boolean is_const()

has_repeat_gap

public boolean has_repeat_gap()

has_pre

public boolean has_pre()

has_post

public boolean has_post()

has_header

public boolean has_header()

has_foot

boolean has_foot()

has_toggle_bit_mask

public boolean has_toggle_bit_mask()

has_toggle_mask

boolean has_toggle_mask()

min_gap

public int min_gap()

max_gap

public int max_gap()

lircProtocolType

public String lircProtocolType()

toSequence

public org.harctoolbox.ircore.ModulatedIrSequence toSequence(int[] array,
                                                             boolean alternatingSigns)

toSequence

public org.harctoolbox.ircore.ModulatedIrSequence toSequence(List<Integer> signals,
                                                             boolean alternatingSigns)

render

org.harctoolbox.ircore.IrSequence render(IrNCode code,
                                         boolean useSignsInRawSequences,
                                         boolean repeat,
                                         int debug)