org.harctoolbox.IrpMaster

Class ExchangeIR

java.lang.Object

org.harctoolbox.IrpMaster.ExchangeIR

public class ExchangeIR
extends Object

This class interfaces to the ExchangeIR library. It consists entirely of of static functions, using the IrpMaster classes IrSignal, IrSequence as arguments or results.

Field Summary

Fields

Modifier and Type	Field and Description
static int	errLimit The errlimit parameter in ExchangeIR.
static int	ueiLearnedCharsInDigit Number of characters in the hexadecimal representation of UEI learned signals.

Method Summary

Modifier and Type	Method and Description
static IrSignal	interpretIrSequence(int[] data, boolean invokeRepeatFinder)
static IrSignal	interpretIrSequence(int[] data, boolean invokeRepeatFinder, boolean invokeAnalyzer) By applying a RepeatFinder, tries to identify intro, repeat, and ending; thus constructing an IrSignal.
static IrSignal	interpretIrSequence(int[] data, double frequency, boolean invokeRepeatFinder, boolean invokeAnalyzer) By applying a RepeatFinder, tries to identify intro, repeat, and ending; thus constructing an IrSignal.
static IrSignal	interpretIrSequence(IrSequence irSequence, boolean invokeRepeatFinder)
static IrSignal	interpretIrSequence(IrSequence irSequence, boolean invokeRepeatFinder, boolean invokeAnalyzer) By applying a RepeatFinder, tries to identify intro, repeat, and ending; thus constructing an IrSignal.
static IrSignal	interpretIrSequence(IrSequence irSequence, double frequency, boolean invokeRepeatFinder)
static IrSignal	interpretIrSequence(IrSequence irSequence, double frequency, boolean invokeRepeatFinder, boolean invokeAnalyzer) If invokeRepeatFinder is true, tries to identify intro, repeat, and ending applying a RepeatFinder.
static IrSignal	interpretString(String str) Tries to interpret the string argument as one of our known formats, and return an IrSignal.
static IrSignal	interpretString(String str, boolean invokeRepeatFinder)
static IrSignal	interpretString(String str, boolean invokeRepeatFinder, boolean invokeAnalyzer) Tries to interpret the string argument as one of our known formats, and return an IrSignal.
static IrSignal	interpretString(String str, double fallbackFrequency, boolean invokeRepeatFinder, boolean invokeAnalyzer) Tries to interpret the string argument as one of our known formats, and return an IrSignal.
static void	main(String[] args) The main routine is mainly for testing and demonstration.
static com.hifiremote.exchangeir.Analyzer	newAnalyzer(IrSequence irSequence, double frequency) Returns a new Analyzer, constructed from an IrSequence and a frequency.
static com.hifiremote.exchangeir.Analyzer	newAnalyzer(IrSignal irSignal) Returns a new Analyzer, constructed from an IrSignal.
static com.hifiremote.exchangeir.Analyzer	newAnalyzer(ModulatedIrSequence irSequence) Returns a new Analyzer, constructed from a ModulatedIrSequene.
static com.hifiremote.exchangeir.RepeatFinder	newRepeatFinder(IrSequence irSequence) Constructs a RepeatFinder from an IrSequence.
static com.hifiremote.exchangeir.UeiLearned	newUeiLearned(IrSignal irSignal) Constructs a UEI learned signal from an IrSignal.
static IrSignal	parseUeiLearned(int[] array) Parses a string containing an UEI learned signal into an IrSignal.
static IrSignal	parseUeiLearned(String str) Parses a string containing an UEI learned signal into an IrSignal.
static void	setAnalyzerBasis(int basis)

Methods inherited from class java.lang.Object

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

Field Detail

errLimit

public static final int errLimit

The errlimit parameter in ExchangeIR. Amounts to allowed difference im microseconds.

See Also:

Constant Field Values

ueiLearnedCharsInDigit

public static final int ueiLearnedCharsInDigit

Number of characters in the hexadecimal representation of UEI learned signals.

See Also:

Constant Field Values

Method Detail

setAnalyzerBasis

public static void setAnalyzerBasis(int basis)

newAnalyzer

public static com.hifiremote.exchangeir.Analyzer newAnalyzer(IrSignal irSignal)

Returns a new Analyzer, constructed from an IrSignal.

Parameters:

irSignal - input IrSignal

Returns:

Analyzer

newAnalyzer

public static com.hifiremote.exchangeir.Analyzer newAnalyzer(IrSequence irSequence,
                                                             double frequency)

Returns a new Analyzer, constructed from an IrSequence and a frequency.

Parameters:

irSequence -

frequency -

Returns:

Analyzer, null if irSequence has zero length.

newAnalyzer

public static com.hifiremote.exchangeir.Analyzer newAnalyzer(ModulatedIrSequence irSequence)

Returns a new Analyzer, constructed from a ModulatedIrSequene.

Parameters:

irSequence -

Returns:

Analyzer

newRepeatFinder

public static com.hifiremote.exchangeir.RepeatFinder newRepeatFinder(IrSequence irSequence)

Constructs a RepeatFinder from an IrSequence.

Parameters:

irSequence -

Returns:

RepeatFinder

newUeiLearned

public static com.hifiremote.exchangeir.UeiLearned newUeiLearned(IrSignal irSignal)

Constructs a UEI learned signal from an IrSignal.

Parameters:

irSignal -

Returns:

UEI learned signal

parseUeiLearned

public static IrSignal parseUeiLearned(String str)

Parses a string containing an UEI learned signal into an IrSignal.

Parameters:

str -

Returns:

IrSignal

parseUeiLearned

public static IrSignal parseUeiLearned(int[] array)

Parses a string containing an UEI learned signal into an IrSignal.

Parameters:

array - Integer array representing signal.

Returns:

IrSignal

interpretString

public static IrSignal interpretString(String str,
                                       double fallbackFrequency,
                                       boolean invokeRepeatFinder,
                                       boolean invokeAnalyzer)
                                throws ParseException,
                                       IncompatibleArgumentException,
                                       UnassignedException,
                                       DomainViolationException,
                                       InvalidRepeatException

Tries to interpret the string argument as one of our known formats, and return an IrSignal. If the string starts with "+", take it as raw. Then, if it contains more than on line, assume that the caller has split it into intro, repeat, and ending sequences already. Otherwise invoke ExchangeIR to split it into constituents. If it does not start with "+", try to interpret as Pronto CCF and UEI learned.

Parameters:

str - String to be interpreted.

fallbackFrequency - Modulation frequency to use, if it cannot be inferred from the first parameter.

invokeRepeatFinder -

invokeAnalyzer -

Returns:

IrSignal, or null on failure.

Throws:

ParseException

IncompatibleArgumentException

UnassignedException

DomainViolationException

InvalidRepeatException

interpretString

public static IrSignal interpretString(String str,
                                       boolean invokeRepeatFinder,
                                       boolean invokeAnalyzer)
                                throws IncompatibleArgumentException,
                                       UnassignedException,
                                       DomainViolationException,
                                       InvalidRepeatException,
                                       ParseException

Tries to interpret the string argument as one of our known formats, and return an IrSignal. If the string starts with "+", take it as raw. Then, if it contains more than one line, assume that the caller has split it into intro, repeat, and ending sequences already. Otherwise invoke ExchangeIR to split it into constituents. If it does not start with "+", try to interpret as Pronto CCF and UEI learned.

Parameters:

str - String to be interpreted.

invokeRepeatFinder -

invokeAnalyzer -

Returns:

IrSignal

Throws:

IncompatibleArgumentException

UnassignedException

DomainViolationException

InvalidRepeatException

ParseException

interpretString

public static IrSignal interpretString(String str,
                                       boolean invokeRepeatFinder)
                                throws IncompatibleArgumentException,
                                       UnassignedException,
                                       DomainViolationException,
                                       InvalidRepeatException,
                                       ParseException

Throws:

IncompatibleArgumentException

UnassignedException

DomainViolationException

InvalidRepeatException

ParseException

interpretString

public static IrSignal interpretString(String str)
                                throws IncompatibleArgumentException,
                                       UnassignedException,
                                       DomainViolationException,
                                       InvalidRepeatException,
                                       ParseException

Tries to interpret the string argument as one of our known formats, and return an IrSignal. If the string starts with "+", take it as raw. Then, if it contains more than one line, assume that the caller has split it into intro, repeat, and ending sequences already. Otherwise invoke ExchangeIR to split it into constituents. If it does not start with "+", try to interpret as Pronto CCF and UEI learned.

Parameters:

str - String to be interpreted.

Returns:

IrSignal

Throws:

IncompatibleArgumentException

UnassignedException

DomainViolationException

InvalidRepeatException

ParseException

interpretIrSequence

public static IrSignal interpretIrSequence(IrSequence irSequence,
                                           double frequency,
                                           boolean invokeRepeatFinder,
                                           boolean invokeAnalyzer)

If invokeRepeatFinder is true, tries to identify intro, repeat, and ending applying a RepeatFinder. If not, the sequence is used as intro on the returned signal. In this case, if invokeAnalyzer is true, an analyzer is first used to clean the signal.

Parameters:

irSequence -

frequency -

invokeRepeatFinder - If the repeat finder is invoked. This alse uses the analyzer.

invokeAnalyzer - If the analyzer is invoked for cleaning the signals.

Returns:

IrSignal signal constructed according to rules above.

interpretIrSequence

public static IrSignal interpretIrSequence(IrSequence irSequence,
                                           double frequency,
                                           boolean invokeRepeatFinder)

interpretIrSequence

public static IrSignal interpretIrSequence(IrSequence irSequence,
                                           boolean invokeRepeatFinder,
                                           boolean invokeAnalyzer)

By applying a RepeatFinder, tries to identify intro, repeat, and ending; thus constructing an IrSignal. If the first argument happens to be of the subclass ModulatedIrSequence, the information of the modulation frequency is taken into account, otherwise a default value of the modulation frequency is used.

Parameters:

irSequence -

invokeRepeatFinder -

invokeAnalyzer -

Returns:

IrSignal

interpretIrSequence

public static IrSignal interpretIrSequence(IrSequence irSequence,
                                           boolean invokeRepeatFinder)

interpretIrSequence

public static IrSignal interpretIrSequence(int[] data,
                                           double frequency,
                                           boolean invokeRepeatFinder,
                                           boolean invokeAnalyzer)

By applying a RepeatFinder, tries to identify intro, repeat, and ending; thus constructing an IrSignal.

Parameters:

data -

frequency -

invokeRepeatFinder -

invokeAnalyzer -

Returns:

IrSignal

interpretIrSequence

public static IrSignal interpretIrSequence(int[] data,
                                           boolean invokeRepeatFinder,
                                           boolean invokeAnalyzer)

By applying a RepeatFinder, tries to identify intro, repeat, and ending; thus constructing an IrSignal.

Parameters:

data -

invokeRepeatFinder -

invokeAnalyzer -

Returns:

IrSignal

interpretIrSequence

public static IrSignal interpretIrSequence(int[] data,
                                           boolean invokeRepeatFinder)

main

public static void main(String[] args)

The main routine is mainly for testing and demonstration.

Parameters:

args - UEI learned signal.