org.lsst.ccs.drivers.serial

Class SerialPort

java.lang.Object

org.lsst.ccs.drivers.serial.SerialPort

public class SerialPort
extends Object

A serial port driver. Currently implemented on top of JSSC. https://code.google.com/p/java-simple-serial-connector/

Author:

aubourg

Constructor Summary

Constructors

Constructor and Description
SerialPort() Constructor.
SerialPort(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	closePort() closes the port.
int	getInputBufferBytesCount() get the number of bytes available in the buffer (ie non blocking)
void	openPort(String name) Opens the port.
int	read(byte[] buff, int offset, int timeout) Reads available data into a byte array.
int	read(byte[] buff, int offset, int mleng, int timeout) Reads available data into a byte array.
byte[]	readBytes() read as many bytes as available without blocking.
byte[]	readBytes(int byteCount) read a given number of bytes from the serial port.
byte[]	readBytes(int byteCount, int timeout) read bytes from the serial port.
String	readString() read all available bytes from the serial port, return as a String
String	readString(int byteCount) read bytes from the serial port.
String	readString(int byteCount, int timeout) read bytes from the serial port.
String	readUntilCRLF() reads a String until CR+LF occurs.
String	readUntilCRLF(int timeout) reads a String until CR+LF occurs, with explicit timeout
String	readUntilLF() reads a String until LF occurs.
String	readUntilLF(int timeout) reads a String until LF occurs, with explicit timeout
String	readUntilSUPSP() reads a String until "> " or "< " occurs.
String	readUntilSUPSP(int timeout) reads a String until "> " or "< " occurs, with explicit timeout
boolean	setFlowControlMode(int mask) set the flow control mode.
boolean	setParams(int baudRate, int dataBits, int stopBits, int parity) Set the communication parameters
boolean	writeByte(byte singleByte) sends a single byte
boolean	writeBytes(byte[] buffer) sends a byte array
boolean	writeBytes(byte[] buffer, int offset, int leng) sends part of a byte array
boolean	writeString(String string) sends a String as byte array
void	writeStringCR(String s) sends a String + CR as byte array
void	writeStringCRLF(String s) sends a String + CR + LF as byte array
void	writeStringLF(String s) sends a String + LF as byte array

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialPort

public SerialPort()

Constructor.

SerialPort

public SerialPort(String name)
           throws org.lsst.ccs.drivers.commons.DriverException

Constructor. Opens the port.

Parameters:

name - the os-dependant name of the port (eg /dev/ttyXX).

Throws:

org.lsst.ccs.drivers.commons.DriverException

Method Detail

openPort

public void openPort(String name)
              throws org.lsst.ccs.drivers.commons.DriverException

Opens the port.

Parameters:

name - the os-dependent name of the port (eg /dev/ttyXX).

Throws:

org.lsst.ccs.drivers.commons.DriverException

closePort

public boolean closePort()
                  throws org.lsst.ccs.drivers.commons.DriverException

closes the port.

Returns:

whether or not the close was successful

Throws:

org.lsst.ccs.drivers.commons.DriverException

getInputBufferBytesCount

public int getInputBufferBytesCount()
                             throws org.lsst.ccs.drivers.commons.DriverException

get the number of bytes available in the buffer (ie non blocking)

Returns:

the number of bytes.

Throws:

org.lsst.ccs.drivers.commons.DriverException

readBytes

public byte[] readBytes()
                 throws org.lsst.ccs.drivers.commons.DriverException

read as many bytes as available without blocking.

Returns:

the newly allocated byte array.

Throws:

org.lsst.ccs.drivers.commons.DriverException

readBytes

public byte[] readBytes(int byteCount,
                        int timeout)
                 throws org.lsst.ccs.drivers.commons.DriverException

read bytes from the serial port. If not enough bytes are available might fail by throwing a TimeoutException after "timeout" milliseconds.

Parameters:

byteCount - the number of bytes to read

timeout - milliseconds before failing on timeout

Returns:

the newly allocated byte array.

Throws:

org.lsst.ccs.drivers.commons.DriverException

readBytes

public byte[] readBytes(int byteCount)
                 throws org.lsst.ccs.drivers.commons.DriverException

read a given number of bytes from the serial port.

Parameters:

byteCount - the number of bytes to read

Returns:

the newly allocated byte array.

Throws:

org.lsst.ccs.drivers.commons.DriverException

readString

public String readString()
                  throws org.lsst.ccs.drivers.commons.DriverException

read all available bytes from the serial port, return as a String

Returns:

the newly allocated String.

Throws:

org.lsst.ccs.drivers.commons.DriverException

readString

public String readString(int byteCount,
                         int timeout)
                  throws org.lsst.ccs.drivers.commons.DriverException

read bytes from the serial port. If not enough bytes are available might fail by throwing a TimeoutException after "timeout" milliseconds.

Parameters:

byteCount - the number of bytes to read

timeout - milliseconds before failing on timeout

Returns:

the newly allocated byte array.

Throws:

org.lsst.ccs.drivers.commons.DriverException

readString

public String readString(int byteCount)
                  throws org.lsst.ccs.drivers.commons.DriverException

read bytes from the serial port.

Parameters:

byteCount - the number of bytes to read

Returns:

the newly allocated byte array.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setFlowControlMode

public boolean setFlowControlMode(int mask)
                           throws org.lsst.ccs.drivers.commons.DriverException

set the flow control mode.

Parameters:

mask - bitfield 0 : NONE 1 : RTSCTS_IN 2 : RTSCTS_OUT 4 : XONXOFF_IN 8 : XONXOFF_OUT

Returns:

true if everything was ok.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setParams

public boolean setParams(int baudRate,
                         int dataBits,
                         int stopBits,
                         int parity)
                  throws org.lsst.ccs.drivers.commons.DriverException

Set the communication parameters

Parameters:

baudRate - baud rate (110, 300, 600, 1200, 4800, 9600, 14400, 19200, 38400, 57600, 115200, 128000, 256000)

dataBits - data bits (5, 6, 7, 8)

stopBits - stop bits (1, 2, 3 for 1.5)

parity - parity (0 none, 1 odd, 2 even, 3 mark, 4 space)

Returns:

true if everything is ok

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeByte

public boolean writeByte(byte singleByte)
                  throws org.lsst.ccs.drivers.commons.DriverException

sends a single byte

Parameters:

singleByte - the byte to send

Returns:

whether everything was okay

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeBytes

public boolean writeBytes(byte[] buffer)
                   throws org.lsst.ccs.drivers.commons.DriverException

sends a byte array

Parameters:

buffer - the byte array to send

Returns:

whether everything is okay

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeBytes

public boolean writeBytes(byte[] buffer,
                          int offset,
                          int leng)
                   throws org.lsst.ccs.drivers.commons.DriverException

sends part of a byte array

Parameters:

buffer - the byte array to send

offset - the offset of the first byte to send

leng - the number of bytes to send

Returns:

whether everything is okay

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeString

public boolean writeString(String string)
                    throws org.lsst.ccs.drivers.commons.DriverException

sends a String as byte array

Parameters:

string - the string to send

Returns:

whether everything is okay

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeStringCRLF

public void writeStringCRLF(String s)
                     throws org.lsst.ccs.drivers.commons.DriverException

sends a String + CR + LF as byte array

Parameters:

s - the string to send

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeStringLF

public void writeStringLF(String s)
                   throws org.lsst.ccs.drivers.commons.DriverException

sends a String + LF as byte array

Parameters:

s - the string to send

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeStringCR

public void writeStringCR(String s)
                   throws org.lsst.ccs.drivers.commons.DriverException

sends a String + CR as byte array

Parameters:

s - the string to send

Throws:

org.lsst.ccs.drivers.commons.DriverException

readUntilCRLF

public String readUntilCRLF()
                     throws org.lsst.ccs.drivers.commons.DriverException

reads a String until CR+LF occurs. Default timeout of 1000 ms

Returns:

the read string (without the CRLF)

Throws:

org.lsst.ccs.drivers.commons.DriverException

readUntilLF

public String readUntilLF()
                   throws org.lsst.ccs.drivers.commons.DriverException

reads a String until LF occurs. Default timeout of 1000 ms

Returns:

the read string (without the LF)

Throws:

org.lsst.ccs.drivers.commons.DriverException

readUntilSUPSP

public String readUntilSUPSP()
                      throws org.lsst.ccs.drivers.commons.DriverException

reads a String until "> " or "< " occurs. For Thorlabs Laser Default timeout of 1000 ms

Returns:

the read string (without the "> " or "< ")

Throws:

org.lsst.ccs.drivers.commons.DriverException

readUntilSUPSP

public String readUntilSUPSP(int timeout)
                      throws org.lsst.ccs.drivers.commons.DriverException

reads a String until "> " or "< " occurs, with explicit timeout

Parameters:

timeout - the timeout in ms

Returns:

the read string (without the "> " or "< ")

Throws:

org.lsst.ccs.drivers.commons.DriverException

readUntilLF

public String readUntilLF(int timeout)
                   throws org.lsst.ccs.drivers.commons.DriverException

reads a String until LF occurs, with explicit timeout

Parameters:

timeout - the timeout in ms

Returns:

the read string (without the LF)

Throws:

org.lsst.ccs.drivers.commons.DriverException

readUntilCRLF

public String readUntilCRLF(int timeout)
                     throws org.lsst.ccs.drivers.commons.DriverException

reads a String until CR+LF occurs, with explicit timeout

Parameters:

timeout - the timeout in ms

Returns:

the read string (without the CRLF)

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

public int read(byte[] buff,
                int offset,
                int timeout)
         throws org.lsst.ccs.drivers.commons.DriverException

Reads available data into a byte array.

Parameters:

buff - The buffer to receive the response data

offset - The offset to the first available byte in the buffer

timeout - the timeout in ms

Returns:

The number of bytes read

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

public int read(byte[] buff,
                int offset,
                int mleng,
                int timeout)
         throws org.lsst.ccs.drivers.commons.DriverException

Reads available data into a byte array.

Parameters:

buff - The buffer to receive the response data

offset - The offset to the first available byte in the buffer

mleng - The maximum number of bytes to read

timeout - the timeout in ms

Returns:

The number of bytes read

Throws:

org.lsst.ccs.drivers.commons.DriverException