Package org.harctoolbox.ircore

Class Pronto

java.lang.Object

org.harctoolbox.ircore.Pronto

Direct Known Subclasses:

ShortPronto

public abstract class Pronto
extends Object

This class, containing only static functions, allows for the creation of integer arrays and strings containing Pronto (CCF) form of the signal. It cannot be instantiated, since there are no "Pronto"s, it is just IrSignals in "another coordinates".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Pronto.NonProntoFormatException

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CHARS_IN_DIGIT	Number of characters in the hexadecimal digits of Pronto strings.
static final double	FREQUENCY_CONSTANT	Constant used for computing the frequency code from the frequency
protected static final int	FREQUENCY_INDEX
static final String	HEX_STRING_FORMAT	Format code used to format integers in the Pronto Hex.
protected static final int	INTRO_LENGTH_INDEX
protected static final int	LEARNED_CODE	Constant denoting "learned", modulated signals.
protected static final int	LEARNED_UNMODULATED_CODE	Constant denoting "learned", non-modulated signals.
protected static final int	MIN_CCF_LENGTH
protected static final int	NUMBER_METADATA
protected static final int	REPEAT_LENGTH_INDEX
protected static final int	TYPE_INDEX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Pronto()

Method Summary

Modifier and Type	Method	Description
static String	formatInteger(int n)	Formats an integer like seen in CCF strings, in printf-ish, using "%04X".
static double	frequency(int code)	Computes the carrier frequency in Hz.
static int	frequencyCode(double frequency)	Returns frequency code from frequency in Hz (the second number in the CCF).
static void	main(String[] args)
static IrSignal	parse(int[] ccf)	Creates a new IrSignals by interpreting its argument as CCF signal.
static IrSignal	parse(String ccfString)	Creates a new IrSignals by interpreting its argument as CCF string.
static IrSignal	parse(String[] array)	Creates a new IrSignals by interpreting its argument as CCF string.
static IrSignal	parse(String[] array, int begin)	Creates a new IrSignals by interpreting its argument as CCF string.
static IrSignal	parse(List<String> list)	Creates a new IrSignals by interpreting its argument as CCF string.
protected static int[]	parseAsInts(String ccfString)	Tries to parse the string as argument.
static int[]	parseAsInts(String[] array, int begin)	Tries to parse the strings as argument.
protected static int[]	parseAsInts(List<String> list)
static IrSignal	parseLoose(String ccfString)
static int	pulses(double time, double frequency)	Computes number of cycles of the carrier the first argument will require.
static int	pulsesMicroSeconds(double time, double frequency)	Computes number of cycles of the carrier the first argument will require.
static double	pulseTime(int code)	Computes pulse time in seconds.
static int[]	toArray(IrSignal irSignal)	CCF array of complete signal, i.e.
static String	toString(int[] array)	Formats a CCF as string.
static String	toString(IrSignal irSignal)	Computes the ("long", raw) CCF string, if possible.

Methods inherited from class java.lang.Object

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

Field Details

CHARS_IN_DIGIT

public static final int CHARS_IN_DIGIT

Number of characters in the hexadecimal digits of Pronto strings.

See Also:

• Constant Field Values

FREQUENCY_CONSTANT

public static final double FREQUENCY_CONSTANT

Constant used for computing the frequency code from the frequency

See Also:

• Constant Field Values

HEX_STRING_FORMAT

public static final String HEX_STRING_FORMAT

Format code used to format integers in the Pronto Hex.

See Also:

• Constant Field Values

LEARNED_CODE

protected static final int LEARNED_CODE

Constant denoting "learned", modulated signals.

See Also:

• Constant Field Values

LEARNED_UNMODULATED_CODE

protected static final int LEARNED_UNMODULATED_CODE

Constant denoting "learned", non-modulated signals.

See Also:

• Constant Field Values

TYPE_INDEX

protected static final int TYPE_INDEX

See Also:

• Constant Field Values

FREQUENCY_INDEX

protected static final int FREQUENCY_INDEX

See Also:

• Constant Field Values

INTRO_LENGTH_INDEX

protected static final int INTRO_LENGTH_INDEX

See Also:

• Constant Field Values

REPEAT_LENGTH_INDEX

protected static final int REPEAT_LENGTH_INDEX

See Also:

• Constant Field Values

NUMBER_METADATA

protected static final int NUMBER_METADATA

See Also:

• Constant Field Values

MIN_CCF_LENGTH

protected static final int MIN_CCF_LENGTH

See Also:

• Constant Field Values

Constructor Details

Pronto

protected Pronto()

Method Details

formatInteger

public static String formatInteger(int n)

Formats an integer like seen in CCF strings, in printf-ish, using "%04X".

Parameters:

n - Integer to be formatted.

Returns:

Formatted string

frequencyCode

public static int frequencyCode(double frequency)

Returns frequency code from frequency in Hz (the second number in the CCF).

Parameters:

frequency - Frequency in Hz.

Returns:

code for the frequency.

frequency

public static double frequency(int code)
                        throws InvalidArgumentException

Computes the carrier frequency in Hz.

Parameters:

code - Pronto frequency code

Returns:

Frequency in Hz.

Throws:

InvalidArgumentException

pulseTime

public static double pulseTime(int code)
                        throws InvalidArgumentException

Computes pulse time in seconds.

Parameters:

code - Pronto frequency code.

Returns:

Duration of one pulse of the carrier in seconds.

Throws:

InvalidArgumentException

pulses

public static int pulses(double time,
 double frequency)
                  throws InvalidArgumentException

Computes number of cycles of the carrier the first argument will require. For frequency == 0, use 414514 as substitute.

Parameters:

time - duration in seconds

frequency -

Returns:

number of pulses

Throws:

InvalidArgumentException - if frequency <= 0.

pulsesMicroSeconds

public static int pulsesMicroSeconds(double time,
 double frequency)
                              throws InvalidArgumentException

Computes number of cycles of the carrier the first argument will require.

Parameters:

time - duration in micro seconds

frequency -

Returns:

number of pulses

Throws:

InvalidArgumentException - if frequency <= 0.

parse

public static IrSignal parse(int[] ccf)
                      throws OddSequenceLengthException,
InvalidArgumentException

Creates a new IrSignals by interpreting its argument as CCF signal.

Parameters:

ccf - CCF signal

Returns:

IrSignal

Throws:

OddSequenceLengthException

InvalidArgumentException

parse

public static IrSignal parse(String ccfString)
                      throws Pronto.NonProntoFormatException,
InvalidArgumentException

Creates a new IrSignals by interpreting its argument as CCF string.

Parameters:

ccfString - CCF signal

Returns:

IrSignal

Throws:

InvalidArgumentException

Pronto.NonProntoFormatException

parseLoose

public static IrSignal parseLoose(String ccfString)
                           throws Pronto.NonProntoFormatException,
InvalidArgumentException

Throws:

Pronto.NonProntoFormatException

InvalidArgumentException

parse

public static IrSignal parse(String[] array,
 int begin)
                      throws Pronto.NonProntoFormatException,
InvalidArgumentException

Creates a new IrSignals by interpreting its argument as CCF string.

Parameters:

array - Strings representing hexadecimal numbers

begin - Starting index

Returns:

IrSignal

Throws:

Pronto.NonProntoFormatException

InvalidArgumentException

parse

public static IrSignal parse(String[] array)
                      throws InvalidArgumentException,
Pronto.NonProntoFormatException

Creates a new IrSignals by interpreting its argument as CCF string.

Parameters:

array - Strings representing hexadecimal numbers

Returns:

IrSignal

Throws:

InvalidArgumentException

Pronto.NonProntoFormatException

parse

public static IrSignal parse(List<String> list)
                      throws InvalidArgumentException,
Pronto.NonProntoFormatException

Creates a new IrSignals by interpreting its argument as CCF string.

Parameters:

list - Strings representing hexadecimal numbers

Returns:

IrSignal

Throws:

InvalidArgumentException

Pronto.NonProntoFormatException

parseAsInts

protected static int[] parseAsInts(String ccfString)
                            throws Pronto.NonProntoFormatException

Tries to parse the string as argument. Can be used to test "Proto-ness" of an unknown string.

Parameters:

ccfString - Input string, to be parsed/tested.

Returns:

Integer array of numbers if successful, null if unsuccessful.

Throws:

Pronto.NonProntoFormatException

parseAsInts

public static int[] parseAsInts(String[] array,
 int begin)
                         throws Pronto.NonProntoFormatException

Tries to parse the strings as argument. Can be used to test "Proto-ness" of an unknown array of strings.

Parameters:

array - Input strings, to be parsed/tested.

begin - Starting index

Returns:

Integer array of numbers if successful, null if unsuccessful (e.g. by NumberFormatException).

Throws:

Pronto.NonProntoFormatException

parseAsInts

protected static int[] parseAsInts(List<String> list)
                            throws Pronto.NonProntoFormatException

Throws:

Pronto.NonProntoFormatException

toArray

public static int[] toArray(IrSignal irSignal)
                     throws OddSequenceLengthException,
InvalidArgumentException

CCF array of complete signal, i.e. the CCF string before formatting, including the header.

Parameters:

irSignal -

Returns:

CCF array

Throws:

OddSequenceLengthException

InvalidArgumentException

toString

public static String toString(IrSignal irSignal)

Computes the ("long", raw) CCF string, if possible. Since a CCF does not have an ending sequence, a nonempty ending sequence will be ignored.

Parameters:

irSignal -

Returns:

CCF string

toString

public static String toString(int[] array)

Formats a CCF as string.

Parameters:

array - CCF in form of an integer array.

Returns:

CCF string.

main

public static void main(String[] args)

Parameters:

args -