org.harctoolbox.harchardware.ir

Class Arduino

java.lang.Object

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

org.harctoolbox.harchardware.ir.Arduino

All Implemented Interfaces:

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

public class Arduino
extends IrSerial<LocalSerialPortBuffered>
implements IRawIrSender, ICapture, IReceive, ICommandLineDevice

This class supports sending and capturing from an Arduino connected through a (virtual) serial port. For sending, the sketch scrutinize_sender should be running, for receiving the sketch scrutinize_receiver.

Field Summary

Fields

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

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, defaultEndTimeout

Constructor Summary

Constructors

Constructor and Description
Arduino()
Arduino(String portName)
Arduino(String portName, int baudRate)
Arduino(String portName, int baudRate, boolean verbose)
Arduino(String portName, int baudRate, int beginTimeout, boolean verbose)
Arduino(String portName, int beginTimeout, int captureMaxSize, int endingTimeout, boolean verbose)
Arduino(String portName, int baudRate, int beginTimeout, int captureMaxSize, int endingTimeout, boolean verbose)

Method Summary

Modifier and Type	Method and Description
ModulatedIrSequence	capture() Listens to the device and returns a sequence.
void	flushInput()
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.
String	readString() Reads a line of text.
String	readString(boolean wait) Reads a line of text.
boolean	ready() Tells whether this stream is ready to be read.
IrSequence	receive() Listens to the device and returns a sequence.
void	reset()
boolean	sendIr(IrSignal irSignal, int count, Transmitter transmitter)
void	sendString(String cmd) Sends a command (a String) to the instance.
void	setBeginTimeout(int beginTimeout)
void	setCaptureMaxSize(int captureMaxSize)
void	setDebug(int debug) Sets a debug parameter.
void	setEndTimeout(int endTimeout)
void	setFallbackFrequency(double fallbackFrequency)
void	setLineEnding(String lineEnding)
boolean	stopCapture() Signals the capturing device that it should stop capturing.
boolean	stopReceive() Signals the receiving device that it should stop receiving.
void	waitFor(String goal, String areUThere, int delay, int tries)

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

okString

public static final String okString

See Also:

Constant Field Values

timeoutString

public static final String timeoutString

See Also:

Constant Field Values

defaultBaudRate

public static final int defaultBaudRate

See Also:

Constant Field Values

Constructor Detail

Arduino

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

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

Arduino

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

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

Arduino

public Arduino(String portName,
               int baudRate)
        throws NoSuchPortException,
               PortInUseException,
               UnsupportedCommOperationException,
               IOException

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

Arduino

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

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

Arduino

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

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

Arduino

public Arduino(String portName,
               int beginTimeout,
               int captureMaxSize,
               int endingTimeout,
               boolean verbose)
        throws NoSuchPortException,
               PortInUseException,
               UnsupportedCommOperationException,
               IOException

Throws:

NoSuchPortException

PortInUseException

UnsupportedCommOperationException

IOException

Arduino

public Arduino(String portName,
               int baudRate,
               int beginTimeout,
               int captureMaxSize,
               int endingTimeout,
               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

setLineEnding

public void setLineEnding(String lineEnding)

Parameters:

lineEnding - the lineEnding to set

setFallbackFrequency

public void setFallbackFrequency(double fallbackFrequency)

Parameters:

fallbackFrequency - the fallbackFrequency to set

sendIr

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

Specified by:

sendIr in interface IRawIrSender

Returns:

if false, command failed.

Throws:

NoSuchTransmitterException

IrpMasterException

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<LocalSerialPortBuffered>

Throws:

IOException

HarcHardwareException

waitFor

public void waitFor(String goal,
                    String areUThere,
                    int delay,
                    int tries)
             throws IOException,
                    HarcHardwareException

Throws:

IOException

HarcHardwareException

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<LocalSerialPortBuffered>

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

setEndTimeout

public void setEndTimeout(int endTimeout)

Specified by:

setEndTimeout in interface IIrReader

capture

public ModulatedIrSequence capture()
                            throws IOException,
                                   HarcHardwareException

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

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

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 IrSequence receive()
                   throws HarcHardwareException,
                          IOException,
                          IrpMasterException

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

IrpMasterException

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

reset

public void reset()

sendString

public void sendString(String cmd)
                throws IOException

Description copied from interface: ICommandLineDevice

Sends a command (a String) to the instance.

Specified by:

sendString in interface ICommandLineDevice

Parameters:

cmd - Command string to be sent.

Throws:

IOException

readString

public String readString()
                  throws IOException

Description copied from interface: ICommandLineDevice

Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.

Specified by:

readString in interface ICommandLineDevice

Returns:

A String containing the contents of the line, not including any line-termination characters, or null if no input available.

Throws:

IOException

readString

public String readString(boolean wait)
                  throws IOException

Description copied from interface: ICommandLineDevice

Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.

Specified by:

readString in interface ICommandLineDevice

Parameters:

wait - if true, wait until something arrives, otherwise return null if nothing there.

Returns:

A String containing the contents of the line, not including any line-termination characters, or null if no input available.

Throws:

IOException

ready

public boolean ready()
              throws IOException

Description copied from interface: ICommandLineDevice

Tells whether this stream is ready to be read. A buffered character stream is ready if the buffer is not empty, or if the underlying character stream is ready.

Specified by:

ready in interface ICommandLineDevice

Returns:

True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.

Throws:

IOException - If an I/O error occurs

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

flushInput

public void flushInput()
                throws IOException

Specified by:

flushInput in interface ICommandLineDevice

Throws:

IOException