org.openimaj.hardware.serial

Class SerialReader

java.lang.Object

org.openimaj.hardware.serial.SerialReader

All Implemented Interfaces:

Closeable, AutoCloseable, jssc.SerialPortEventListener

public class SerialReader
extends Object
implements jssc.SerialPortEventListener, Closeable

An event listener that receives data from the serial port, buffers the data, parses the data then calls the listeners for every sentence parsed.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

12 Jul 2011

Constructor Summary

Constructors

Constructor and Description
SerialReader(InputStream in, SerialDataParser parser) Default constructor

Method Summary

Modifier and Type	Method and Description
void	addSerialDataListener(SerialDataListener listener) Add a serial data listener that will be informed of individual tokens that are parsed from the parser.
void	close()
protected void	fireDataReceived(String[] strings) Fire multiple events: one for each parsed string.
void	removeSerialDataListener(SerialDataListener listener) Remove the given listener from this reader.
void	serialEvent(jssc.SerialPortEvent event)
void	setMaxBufferSize(int maxSize) Set the size of the buffer to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialReader

public SerialReader(InputStream in,
                    SerialDataParser parser)

Default constructor

Parameters:

in -

parser -

Method Detail

serialEvent

public void serialEvent(jssc.SerialPortEvent event)

Specified by:

serialEvent in interface jssc.SerialPortEventListener

addSerialDataListener

public void addSerialDataListener(SerialDataListener listener)

Add a serial data listener that will be informed of individual tokens that are parsed from the parser.

Parameters:

listener - The listener

removeSerialDataListener

public void removeSerialDataListener(SerialDataListener listener)

Remove the given listener from this reader.

Parameters:

listener - The listener

fireDataReceived

protected void fireDataReceived(String[] strings)

Fire multiple events: one for each parsed string.

Parameters:

strings - The strings parsed from the parser.

setMaxBufferSize

public void setMaxBufferSize(int maxSize)

Set the size of the buffer to use. The buffer size must be larger than any expected data item that you are wanting to parse. If your sentences can be up to 128 bytes, then the buffer should be at least 128 bytes. It can be larger.

Parameters:

maxSize - The size of the buffer to use.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException