org.harctoolbox.harchardware.ir

Class IrWidget

java.lang.Object

org.harctoolbox.harchardware.ir.IrWidget

All Implemented Interfaces:

Closeable, AutoCloseable, IHarcHardware, ICapture

public class IrWidget
extends Object
implements IHarcHardware, ICapture

This class implements support for Kevin Timmerman's Ir Widget. It uses the RXTX library, which encapsulates all system dependencies. Although it duplicates some functionality found in Kevin's program IrScope (file widget.cpp), it is not derived.

See Also:

http://www.compendiumarcana.com/irwidget/

Field Summary

Fields

Modifier and Type	Field and Description
static int	defaultEndTimeout
static String	defaultPortName
static int	defaultRunTimeout
static int	defaultStartTimeout
static int	msPerTick Number of micro seconds in a count msPerTick.

Constructor Summary

Constructors

Constructor and Description
IrWidget() Constructs new IrWidget with default port name and timeouts.
IrWidget(String portName, boolean verbose, int debug) Constructs new IrWidget with default timeouts.
IrWidget(String portName, int startTimeout, int runTimeout, int endTimeout, boolean verbose) Constructs new IrWidget.

Method Summary

Modifier and Type	Method and Description
ModulatedIrSequence	capture() Captures a signal using the given timeout values, and returns it as a ModulatedIrSequence.
void	close()
String	getVersion() The IrWidget does not support versions.
boolean	isValid() Tries to identify instances that are not valid.
static void	main(String[] args) For testing purposes only.
void	open() Opens the device with previously set parameters.
void	setDebug(int debug) Sets a debug parameter.
void	setTimeout(int timeout) Deprecated. Use three argument version instead.
void	setTimeout(int startTimeout, int runTimeout, int endTimeout)
void	setVerbosity(boolean verbose) Sets a verbosity flag, causing commands to be executed verbosely.
boolean	stopCapture() Stops ongoing capture.

Methods inherited from class java.lang.Object

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

Field Detail

msPerTick

public static final int msPerTick

Number of micro seconds in a count msPerTick.

See Also:

Constant Field Values

defaultPortName

public static final String defaultPortName

See Also:

Constant Field Values

defaultStartTimeout

public static final int defaultStartTimeout

See Also:

Constant Field Values

defaultRunTimeout

public static final int defaultRunTimeout

See Also:

Constant Field Values

defaultEndTimeout

public static final int defaultEndTimeout

See Also:

Constant Field Values

Constructor Detail

IrWidget

public IrWidget()

Constructs new IrWidget with default port name and timeouts.

IrWidget

public IrWidget(String portName,
                boolean verbose,
                int debug)

Constructs new IrWidget with default timeouts.

Parameters:

portName - Name of serial port to use. Typically something like COM7: (Windows) or /dev/ttyUSB0.

verbose -

debug - debug code

IrWidget

public IrWidget(String portName,
                int startTimeout,
                int runTimeout,
                int endTimeout,
                boolean verbose)

Constructs new IrWidget.

Parameters:

portName - Name of serial port to use. Typically something like COM7: (Windows) or /dev/ttyUSB0.

verbose -

startTimeout -

runTimeout -

endTimeout -

Method Detail

setDebug

public void setDebug(int debug)

Description copied from interface: IHarcHardware

Sets a debug parameter. Exact semantic depends on the implementation.

Specified by:

setDebug in interface IHarcHardware

open

public void open()
          throws HarcHardwareException,
                 IOException

Description copied from interface: IHarcHardware

Opens the device with previously set parameters.

Specified by:

open in interface IHarcHardware

Throws:

HarcHardwareException

IOException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

setTimeout

public void setTimeout(int startTimeout,
                       int runTimeout,
                       int endTimeout)

Specified by:

setTimeout in interface ICapture

setTimeout

public void setTimeout(int timeout)

Deprecated. Use three argument version instead.

Description copied from interface: IHarcHardware

Set timeout in milliseconds. Exact semantics may be dependent on the hardware.

Specified by:

setTimeout in interface IHarcHardware

Parameters:

timeout -

capture

public ModulatedIrSequence capture()
                            throws IOException

Captures a signal using the given timeout values, and returns it as a ModulatedIrSequence.

Specified by:

capture in interface ICapture

Returns:

ModulatedIrSequence

Throws:

IOException

getVersion

public String getVersion()

The IrWidget does not support versions.

Specified by:

getVersion in interface IHarcHardware

Returns:

null

setVerbosity

public void setVerbosity(boolean verbose)

Description copied from interface: IHarcHardware

Sets a verbosity flag, causing commands to be executed verbosely. Exact semantic depends on the implementation.

Specified by:

setVerbosity in interface IHarcHardware

Parameters:

verbose - on or off

isValid

public boolean isValid()

Description copied from interface: IHarcHardware

Tries to identify instances that are not valid. Exact meaning can vary.

Specified by:

isValid in interface IHarcHardware

Returns:

validity of the instance.

stopCapture

public boolean stopCapture()

Stops ongoing capture.

Specified by:

stopCapture in interface ICapture

Returns:

true

main

public static void main(String[] args)

For testing purposes only.

Parameters:

args - the command line arguments