org.openimaj.hardware.serial

Class SerialDevice

java.lang.Object

org.openimaj.hardware.serial.SerialDevice

All Implemented Interfaces:

EventListener, SerialDataListener

public class SerialDevice
extends Object
implements SerialDataListener

Serial device driver. Uses RXTX library underneath. The native parts of the RXTX library are published to the Maven repository as a JAR and are extracted and the java.library.path property is flushed and reset.

Author:

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

Created:

12 Jul 2011

Constructor Summary

Constructors

Constructor and Description
SerialDevice(String portName) Constructor that takes the port name to connect to and the rate at which to connect.
SerialDevice(String portName, int dataRate, int dataBits, int stopBits, int parity) Complete constructor that takes all the information required to connect to a port.

Method Summary

Modifier and Type	Method and Description
void	addSerialDataListener(SerialDataListener sdl) Add the given SerialDataListener to the listener list.
void	close() Close the connection to the serial port.
void	dataReceived(String data) Called when data is received on a serial port.
protected void	finalize()
protected void	fireSerialDataEvent(String data) Fires the serial data event when data is received on the port.
InputStream	getInputStream() Returns the input stream for this device.
OutputStream	getOutputStream() Returns the output stream for this device.
String	getRegex() Returns the regular expression being used to split incoming strings.
static HashSet<String>	getSerialPorts()
void	removeSerialDataListener(SerialDataListener sdl) Remove the given SerialDataListener from the listener list
void	setRegex(String regex) Set the regular expression to use to split incoming strings.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialDevice

public SerialDevice(String portName)
             throws Exception

Constructor that takes the port name to connect to and the rate at which to connect. The data rate will be set to 19,200 with 8 data bits, 1 stop bit and no parity.

Parameters:

portName - The port name to connect to.

Throws:

Exception

SerialDevice

public SerialDevice(String portName,
                    int dataRate,
                    int dataBits,
                    int stopBits,
                    int parity)
             throws Exception

Complete constructor that takes all the information required to connect to a port.

Parameters:

portName - The port name to connect to.

dataRate - The data rate to read from the port.

dataBits - The number of data bits

stopBits - The number of stop bits

parity - The bit parity

Throws:

Exception

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

See Also:

Object.finalize()

close

public void close()
           throws IOException

Close the connection to the serial port.

Throws:

IOException

addSerialDataListener

public void addSerialDataListener(SerialDataListener sdl)

Add the given SerialDataListener to the listener list.

Parameters:

sdl - The SerialDataListener to add.

removeSerialDataListener

public void removeSerialDataListener(SerialDataListener sdl)

Remove the given SerialDataListener from the listener list

Parameters:

sdl - The SerialDataListener to remove.

fireSerialDataEvent

protected void fireSerialDataEvent(String data)

Fires the serial data event when data is received on the port.

Parameters:

data - The data that was received

getRegex

public String getRegex()

Returns the regular expression being used to split incoming strings.

Returns:

the regular expression being used to split incoming strings.

setRegex

public void setRegex(String regex)

Set the regular expression to use to split incoming strings.

Parameters:

regex - the regex to split incoming strings

getInputStream

public InputStream getInputStream()

Returns the input stream for this device.

Returns:

the input stream

getOutputStream

public OutputStream getOutputStream()

Returns the output stream for this device.

Returns:

the output stream

dataReceived

public void dataReceived(String data)

Called when data is received on a serial port.

Specified by:

dataReceived in interface SerialDataListener

Parameters:

data - The data that was received as a string.

See Also:

SerialDataListener.dataReceived(java.lang.String)

getSerialPorts

public static HashSet<String> getSerialPorts()

Returns:

A HashSet containing the identifier for all serial ports