org.harctoolbox.IrpMaster

Class Pronto

java.lang.Object

org.harctoolbox.IrpMaster.Pronto

public class Pronto
extends Object

This class allows for the creation of integer arrays and strings containing Pronto (CCF) form of the signal. There are also some static members that can possibly be used in other contexts. Immutable.

Field Summary

Fields

Modifier and Type	Field and Description
static int	charsInDigit Number of characters in the hexadecimal digits of Pronto strings.
static String	formattingCode Format code used to format integers in the Pronto Hex.
static double	prontoConstant Constant used for computing the frequency code from the frequency

Constructor Summary

Constructors

Constructor and Description
Pronto(IrSignal irSignal) Constructor from IrSignal.

Method Summary

Modifier and Type	Method and Description
static IrSignal	ccfSignal(int[] ccf) Creates a new IrSignals by interpreting its argument as CCF signal.
static IrSignal	ccfSignal(String ccfString) Creates a new IrSignals by interpreting its argument as CCF string.
static IrSignal	ccfSignal(String[] array, int begin) Creates a new IrSignals by interpreting its argument as CCF string.
static String	formatInteger(int n) Formats an integer like seen in CCF strings, in printf-ish, using "%04X".
double	getFrequency() Computes the carrier frequency in Hz.
static double	getFrequency(int code) Computes the carrier frequency in Hz.
static int	getProntoCode(double f) Returns frequency code from frequency in Hz (the second number in the CCF).
static double	getPulseTime(int code) Computes pulse time.
int[]	initArray() CCF array of initial sequence
static void	main(String[] args)
static int[]	parseString(String ccfString) Tries to parse the string as argument.
static int[]	parseStringArray(String[] array, int begin) Tries to parse the strings as argument.
static int	pulses(double us, double frequency) Computes number of cycles of the carrier the first argument will require.
int[]	repeatArray() CCF array of repeat sequence
static int[]	shortCCF(String protocolName, int device, int subdevice, int command) Computes the "short" Pronto form of some signals, given by protocol number and parameter values.
static String	shortCCFString(String protocolName, int device, int subdevice, int command) The string version of shortCCF(...).
int[]	toArray() CCF array of complete signal, i.e.
static int[]	toArray(double frequency, double[] sequence) Computes a ccf array, without header.
static int[]	toArray(double frequency, double[] intro, double[] repetition) CCF array of complete signal, i.e.
String	toPrintString() Computes the ("long", raw) CCF string
static String	toPrintString(int[] array) Formats a CCF as string.
static String	toPrintString(IrSignal irSignal) Computes the ("long", raw) CCF string

Methods inherited from class java.lang.Object

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

Field Detail

charsInDigit

public static final int charsInDigit

Number of characters in the hexadecimal digits of Pronto strings.

See Also:

Constant Field Values

prontoConstant

public static final double prontoConstant

Constant used for computing the frequency code from the frequency

See Also:

Constant Field Values

formattingCode

public static final String formattingCode

Format code used to format integers in the Pronto Hex.

See Also:

Constant Field Values

Constructor Detail

Pronto

public Pronto(IrSignal irSignal)
       throws IncompatibleArgumentException

Constructor from IrSignal.

Parameters:

irSignal -

Throws:

IncompatibleArgumentException

Method Detail

formatInteger

public static final 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

getProntoCode

public static final int getProntoCode(double f)

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

Parameters:

f - Frequency in Hz.

Returns:

code for the frequency.

getFrequency

public static final double getFrequency(int code)

Computes the carrier frequency in Hz.

Parameters:

code - Pronto frequency code

Returns:

Frequency in Hz.

getFrequency

public final double getFrequency()

Computes the carrier frequency in Hz.

Returns:

Frequency in Hz.

getPulseTime

public static final double getPulseTime(int code)

Computes pulse time.

Parameters:

code - Pronto frequency code

Returns:

Duration of one pulse of the carrier in microseconds

pulses

public static final int pulses(double us,
                               double frequency)

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

Parameters:

us - duration in microseconds

frequency -

Returns:

number of pulses

toArray

public static final int[] toArray(double frequency,
                                  double[] sequence)

Computes a ccf array, without header.

Parameters:

frequency -

sequence -

Returns:

CCF array

ccfSignal

public static final IrSignal ccfSignal(int[] ccf)
                                throws ParseException,
                                       IncompatibleArgumentException,
                                       UnassignedException,
                                       DomainViolationException,
                                       InvalidRepeatException

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

Parameters:

ccf - CCF signal

Returns:

IrSignal

Throws:

ParseException

IncompatibleArgumentException

UnassignedException

DomainViolationException

InvalidRepeatException

ccfSignal

public static final IrSignal ccfSignal(String ccfString)
                                throws IrpMasterException

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

Parameters:

ccfString - CCF signal

Returns:

IrSignal

Throws:

IncompatibleArgumentException

IrpMasterException

ccfSignal

public static final IrSignal ccfSignal(String[] array,
                                       int begin)
                                throws IrpMasterException

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

Parameters:

array - Strings representing hexadecimal numbers

begin - Starting index

Returns:

IrSignal

Throws:

IrpMasterException

parseString

public static final int[] parseString(String ccfString)
                               throws NumberFormatException

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:

NumberFormatException

parseStringArray

public static final int[] parseStringArray(String[] array,
                                           int begin)

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.

initArray

public final int[] initArray()

CCF array of initial sequence

Returns:

CCF array

repeatArray

public final int[] repeatArray()

CCF array of repeat sequence

Returns:

CCF array

toArray

public static final int[] toArray(double frequency,
                                  double[] intro,
                                  double[] repetition)

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

Parameters:

frequency -

intro -

repetition -

Returns:

CCF array

toArray

public final int[] toArray()

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

Returns:

CCF array

toPrintString

public String toPrintString()

Computes the ("long", raw) CCF string

Returns:

CCF string

toPrintString

public static String toPrintString(int[] array)

Formats a CCF as string.

Parameters:

array - CCF in form of an integer array.

Returns:

CCF string.

toPrintString

public static String toPrintString(IrSignal irSignal)

Computes the ("long", raw) CCF string

Parameters:

irSignal -

Returns:

CCF string

shortCCFString

public static final String shortCCFString(String protocolName,
                                          int device,
                                          int subdevice,
                                          int command)
                                   throws IncompatibleArgumentException

The string version of shortCCF(...).

Parameters:

protocolName -

device -

subdevice -

command -

Returns:

CCF as string, or null on failure.

Throws:

IncompatibleArgumentException

shortCCF

public static final int[] shortCCF(String protocolName,
                                   int device,
                                   int subdevice,
                                   int command)
                            throws IncompatibleArgumentException

Computes the "short" Pronto form of some signals, given by protocol number and parameter values.

Parameters:

protocolName - Name of protcol, presently "rc5", "rc5x", "rc6", and "nec1".

device -

subdevice -

command -

Returns:

integer array of short CCF, or null om failure.

Throws:

IncompatibleArgumentException - for paramters outside of its allowed domain.

main

public static void main(String[] args)