Package org.harctoolbox.harchardware.ir

Class IrToy

java.lang.Object

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

org.harctoolbox.harchardware.ir.IrToy

All Implemented Interfaces:

Closeable, AutoCloseable, IHarcHardware, ICapture, IIrReader, IRawIrSender, IReceive

public final class IrToy
extends IrSerial<LocalSerialPortRaw>
implements IRawIrSender, ICapture, IReceive

This class contains a driver for Dangerous Prototype's IrToy.

See Also:

• http://www.dangerousprototypes.com/docs/USB_IR_Toy:_Sampling_mode

Field Summary

Fields

Modifier and Type	Field	Description
static final int	defaultBaudRate
static final LocalSerialPort.FlowControl	defaultFlowControl
static final String	defaultPortName
static final int	defaultTimeout
static final boolean	useDebuggingLeds

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

serialPort, verbose

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

DEFAULT_BEGIN_TIMEOUT, DEFAULT_CAPTURE_MAXSIZE, DEFAULT_ENDING_TIMEOUT

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

repeatMax

Constructor Summary

Constructors

Constructor	Description
IrToy()
IrToy(String portName)
IrToy(String portName, boolean verbose)
IrToy(String portName, boolean verbose, Integer timeout)
IrToy(String portName, boolean verbose, Integer timeout, Integer baudRate)
IrToy(String portName, boolean verbose, Integer timeout, Integer baudRate, Integer maxLearnLength, LocalSerialPort.FlowControl flowControl)

Method Summary

Modifier and Type	Method	Description
void	bootloaderMode()
org.harctoolbox.ircore.ModulatedIrSequence	capture()	Listens to the device and returns a sequence.
void	checkVersion()
void	close()
String	getProtocolVersion()
String	getVersion()	Returns the hardware version (not the version of the driver software).
void	open()	Opens the device with previously set parameters.
org.harctoolbox.ircore.IrSequence	receive()	Listens to the device and returns a sequence.
void	reset(int times)
String	selftest()
boolean	sendCcf(String ccf, int count, Transmitter transmitter)
boolean	sendCcfRepeat(String ccf, Transmitter transmitter)	Not supported due to hardware restrictions.
boolean	sendIr(org.harctoolbox.ircore.IrSignal code, int count, Transmitter transmitter)
void	setBeginTimeout(int beginTimeout)
void	setCaptureMaxSize(int captureMaxSize)
void	setDebug(int debug)	Sets a debug parameter.
void	setEndingTimeout(int timeout)
void	setLed(boolean status)
void	setLedMute(boolean status)
void	setPin(int pin, boolean state)	pin 2: RA2 pin 3: RA3 pin 4: RA4 pin 5: RA5 pin 11: RB3 pin 13: RB5
boolean	stopCapture()	Signals the capturing device that it should stop capturing.
boolean	stopReceive()	Signals the receiving device that it should stop receiving.

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

getTransmitter, isValid, setBaudRate, setDataSize, setFlowControl, setParity, setPortName, setStopBits, setTimeout, setVerbose

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.IHarcHardware

isValid, setTimeout, setVerbose

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

getTransmitter

Field Details

useDebuggingLeds

public static final boolean useDebuggingLeds

See Also:

• Constant Field Values

defaultPortName

public static final String defaultPortName

See Also:

• Constant Field Values

defaultBaudRate

public static final int defaultBaudRate

See Also:

• Constant Field Values

defaultFlowControl

public static final LocalSerialPort.FlowControl defaultFlowControl

defaultTimeout

public static final int defaultTimeout

See Also:

• Constant Field Values

Constructor Details

IrToy

public IrToy()
      throws IOException

Throws:

IOException

IrToy

public IrToy(String portName)
      throws IOException

Throws:

IOException

IrToy

public IrToy(String portName,
 boolean verbose)
      throws IOException

Throws:

IOException

IrToy

public IrToy(String portName,
 boolean verbose,
 Integer timeout)
      throws IOException

Throws:

IOException

IrToy

public IrToy(String portName,
 boolean verbose,
 Integer timeout,
 Integer baudRate)
      throws IOException

Throws:

IOException

IrToy

public IrToy(String portName,
 boolean verbose,
 Integer timeout,
 Integer baudRate,
 Integer maxLearnLength,
 LocalSerialPort.FlowControl flowControl)
      throws IOException

Throws:

IOException

Method Details

setPin

public void setPin(int pin,
 boolean state)
            throws IOException

pin 2: RA2 pin 3: RA3 pin 4: RA4 pin 5: RA5 pin 11: RB3 pin 13: RB5

Parameters:

pin -

state -

Throws:

IOException

open

public void open()
          throws IOException,
HarcHardwareException

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:

IOException

HarcHardwareException

checkVersion

public void checkVersion()
                  throws HarcHardwareException,
IOException

Throws:

HarcHardwareException

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class IrSerial<LocalSerialPortRaw>

Throws:

IOException

reset

public void reset(int times)
           throws IOException

Throws:

IOException

capture

public org.harctoolbox.ircore.ModulatedIrSequence capture()
                                                   throws HarcHardwareException,
IOException

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:

HarcHardwareException - if the device is not in valid/open state.

IOException

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

receive

public org.harctoolbox.ircore.IrSequence receive()
                                          throws HarcHardwareException,
IOException

Description copied from interface: IReceive

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:

receive in interface IReceive

Returns:

Captured sequence, or null by timeout.

Throws:

HarcHardwareException - if the device is not in valid/open state.

IOException

stopReceive

public boolean stopReceive()

Description copied from interface: IReceive

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

Specified by:

stopReceive in interface IReceive

Returns:

status

selftest

public String selftest()
                throws IOException

Throws:

IOException

bootloaderMode

public void bootloaderMode()
                    throws IOException

Throws:

IOException

getProtocolVersion

public String getProtocolVersion()

setLedMute

public void setLedMute(boolean status)
                throws IOException

Throws:

IOException

setLed

public void setLed(boolean status)
            throws IOException

Throws:

IOException

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 beginTimeout)
                     throws IOException

Specified by:

setBeginTimeout in interface IIrReader

Throws:

IOException

setCaptureMaxSize

public void setCaptureMaxSize(int captureMaxSize)

Specified by:

setCaptureMaxSize in interface IIrReader

setEndingTimeout

public void setEndingTimeout(int timeout)

Specified by:

setEndingTimeout in interface IIrReader

sendIr

public boolean sendIr(org.harctoolbox.ircore.IrSignal code,
 int count,
 Transmitter transmitter)
               throws IOException,
HarcHardwareException

Specified by:

sendIr in interface IRawIrSender

Returns:

if false, command failed.

Throws:

IOException

NoSuchTransmitterException

HarcHardwareException

sendCcf

public boolean sendCcf(String ccf,
 int count,
 Transmitter transmitter)
                throws IOException,
HarcHardwareException,
org.harctoolbox.ircore.Pronto.NonProntoFormatException,
org.harctoolbox.ircore.InvalidArgumentException

Throws:

IOException

HarcHardwareException

org.harctoolbox.ircore.Pronto.NonProntoFormatException

org.harctoolbox.ircore.InvalidArgumentException

sendCcfRepeat

public boolean sendCcfRepeat(String ccf,
 Transmitter transmitter)

Not supported due to hardware restrictions.

Parameters:

ccf -

transmitter -

Returns:

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