org.lsst.ccs.drivers.lighthouse

Class SerialTransport

java.lang.Object

org.lsst.ccs.drivers.lighthouse.SerialTransport

All Implemented Interfaces:

Transport

public class SerialTransport
extends Object
implements Transport

Sends and receives bytes using a serial port on the local host.

Author:

tether

Field Summary

Fields inherited from interface org.lsst.ccs.drivers.lighthouse.Transport

MODBUS_FRAME_TERMINATOR, SERIAL_BAUD, SERIAL_CHARACTERISTICS

Constructor Summary

Constructors

Constructor and Description
SerialTransport(String portName) Opens the serial port.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialTransport

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

Opens the serial port.

Parameters:

portName - The name of the port, for example /dev/ttyUSB0.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the open fails.

Method Detail

send

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

Sends a command to the device.

Specified by:

send in interface Transport

Parameters:

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

Throws:

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

receive

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

Receives a response from the device.

Specified by:

receive in interface Transport

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

public void close()

Closes the comm link to the device.

Specified by:

close in interface Transport