org.lsst.ccs.drivers.lighthouse

Interface Transport

All Known Implementing Classes:

FTDITransport, NetTransport, SerialTransport

public interface Transport

Represents a communications link over which commands are sent to the device and replies received from it.

Author:

tether

Field Summary

Fields

Modifier and Type	Field and Description
static org.lsst.ccs.drivers.ascii.Ascii.Terminator	MODBUS_FRAME_TERMINATOR All ASCII Modbus commands frames and response frames must end with this.
static int	SERIAL_BAUD The baud rate to use for serial-port or FTDI connections.
static int	SERIAL_CHARACTERISTICS The data characteristics to use for serial-port or FTDI connections.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the comm link to the device.
String	receive(Duration timeout) Receives a response from the device.
void	send(String command) Sends a command to the device.

Field Detail

SERIAL_BAUD

static final int SERIAL_BAUD

The baud rate to use for serial-port or FTDI connections.

See Also:

Constant Field Values

SERIAL_CHARACTERISTICS

static final int SERIAL_CHARACTERISTICS

The data characteristics to use for serial-port or FTDI connections.

MODBUS_FRAME_TERMINATOR

static final org.lsst.ccs.drivers.ascii.Ascii.Terminator MODBUS_FRAME_TERMINATOR

All ASCII Modbus commands frames and response frames must end with this. Transport objects will append this to outgoing command frames. They will stop collecting the response frame when this sequence arrives and strip it from the returned string.

Method Detail

send

void send(String command)
   throws org.lsst.ccs.drivers.commons.DriverException

Sends a command to the device.

Parameters:

command - The command string, w/o the final CRLF, to send.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for any other problem.

receive

String receive(Duration timeout)
        throws org.lsst.ccs.drivers.commons.DriverException

Receives a response from the device.

Parameters:

timeout - timeout.getSeconds() is how long to wait for the start of a response.

Returns:

The response string stripped of the final CRLF.

Throws:

org.lsst.ccs.drivers.commons.DriverTimeoutException - if no response bytes arrive before the deadline.

org.lsst.ccs.drivers.commons.DriverException - for any other problem.

close

void close()

Closes the comm link to the device.