org.harctoolbox.harchardware.ir

Class CommandFusion

java.lang.Object

org.harctoolbox.harchardware.ir.IrSerial<LocalSerialPortRaw>

org.harctoolbox.harchardware.ir.CommandFusion

All Implemented Interfaces:

Closeable, AutoCloseable, IHarcHardware, ICapture, IIrReader, IRawIrSender

public class CommandFusion
extends IrSerial<LocalSerialPortRaw>
implements IRawIrSender, ICapture

This class implements capturing and sending support for the CommandFusion Learner. see IR learner, IR Module, and USB Communication Protocol.

Field Summary

Fields

Modifier and Type	Field and Description
static int	defaultBaudRate
static String	defaultPortName

Fields inherited from class org.harctoolbox.harchardware.ir.IrSerial

serialPort, verbose

Fields inherited from interface org.harctoolbox.harchardware.ir.IRawIrSender

repeatMax

Fields inherited from interface org.harctoolbox.harchardware.ir.IIrReader

defaultBeginTimeout, defaultCaptureMaxSize

Constructor Summary

Constructors

Constructor and Description
CommandFusion()
CommandFusion(String portName)
CommandFusion(String portName, boolean verbose)
CommandFusion(String portName, int baudRate, int beginTimeout, boolean verbose)

Method Summary

Modifier and Type	Method and Description
ModulatedIrSequence	capture() Listens to the device and returns a sequence.
String	getVersion() Returns the hardware version (not the version of the driver software).
static void	main(String[] args)
void	open() Opens the device with previously set parameters.
boolean	sendIr(int deviceType, int codeset, int key) Sends an IR signal from the built-in, proprietary data base.
boolean	sendIr(IrSignal irSignal, int count, Transmitter transmitter)
void	setBeginTimeout(int integer)
void	setCaptureMaxSize(int integer)
void	setDebug(int debug) Sets a debug parameter.
void	setEndTimeout(int integer)
boolean	stopCapture() Signals the capturing device that it should stop capturing.

Methods inherited from class org.harctoolbox.harchardware.ir.IrSerial

close, getTransmitter, isValid, setBaudRate, setDataSize, setFlowControl, setParity, setPortName, setStopBits, setTimeout, setVerbosity

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.harctoolbox.harchardware.ir.IRawIrSender

getTransmitter

Methods inherited from interface org.harctoolbox.harchardware.IHarcHardware

isValid, setTimeout, setVerbosity

Methods inherited from interface java.io.Closeable

close

Field Detail

defaultPortName

public static final String defaultPortName

See Also:

Constant Field Values

defaultBaudRate

public static final int defaultBaudRate

See Also:

Constant Field Values

Constructor Detail

CommandFusion

public CommandFusion()
              throws NoSuchPortException,
                     PortInUseException,
                     UnsupportedCommOperationException,
                     IOException

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

CommandFusion

public CommandFusion(String portName)
              throws NoSuchPortException,
                     PortInUseException,
                     UnsupportedCommOperationException,
                     IOException

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

CommandFusion

public CommandFusion(String portName,
                     boolean verbose)
              throws NoSuchPortException,
                     PortInUseException,
                     UnsupportedCommOperationException,
                     IOException

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

CommandFusion

public CommandFusion(String portName,
                     int baudRate,
                     int beginTimeout,
                     boolean verbose)
              throws NoSuchPortException,
                     PortInUseException,
                     UnsupportedCommOperationException,
                     IOException

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

Method Detail

main

public static void main(String[] args)

Parameters:

args - the command line arguments

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

Overrides:

open in class IrSerial<LocalSerialPortRaw>

Throws:

HarcHardwareException

IOException

sendIr

public boolean sendIr(int deviceType,
                      int codeset,
                      int key)
               throws IOException

Sends an IR signal from the built-in, proprietary data base.

Parameters:

deviceType -

codeset -

key - function code

Returns:

success of operation

Throws:

IOException

sendIr

public boolean sendIr(IrSignal irSignal,
                      int count,
                      Transmitter transmitter)
               throws IncompatibleArgumentException,
                      IOException

Specified by:

sendIr in interface IRawIrSender

Returns:

if false, command failed.

Throws:

IOException

IncompatibleArgumentException

capture

public ModulatedIrSequence capture()
                            throws IOException,
                                   IncompatibleArgumentException

Description copied from interface: ICapture

Listens to the device and returns a sequence. Requires the device to be previously opened. Should itself neither open or close the device.

Specified by:

capture in interface ICapture

Returns:

Captured sequence, or null by timeout.

Throws:

IOException

IncompatibleArgumentException

stopCapture

public boolean stopCapture()

Description copied from interface: ICapture

Signals the capturing device that it should stop capturing. May not be implemented in all hardware.

Specified by:

stopCapture in interface ICapture

Returns:

status

getVersion

public String getVersion()

Description copied from interface: IHarcHardware

Returns the hardware version (not the version of the driver software). May be null if no relevant information available.

Specified by:

getVersion in interface IHarcHardware

Overrides:

getVersion in class IrSerial<LocalSerialPortRaw>

Returns:

Version string. Semantics can vary.

setBeginTimeout

public void setBeginTimeout(int integer)

Specified by:

setBeginTimeout in interface IIrReader

setCaptureMaxSize

public void setCaptureMaxSize(int integer)

Specified by:

setCaptureMaxSize in interface IIrReader

setEndTimeout

public void setEndTimeout(int integer)

Specified by:

setEndTimeout in interface IIrReader