org.lsst.ccs.subsystem.airwatch.main

Class LighthouseModbus

java.lang.Object

org.lsst.ccs.subsystem.airwatch.main.LighthouseModbus

All Implemented Interfaces:

Instrument

public class LighthouseModbus
extends Object
implements Instrument

Implements readout of a Lighthouse Worldwide Solutions 3016-like instrument with a direct serial or network connection. Each instance communicates with its instrument using the ASCII version of the Modbus protocol. That in turn is built on top of the CCS ASCII driver so the connection can be via serial port or network. It's assumed that the instrument is putting records into its internal buffer. This code never removes records from the buffer, only copies them, and so must keep track of the timestamp of the newest record ever read.

Author:

tether

Constructor Summary

Constructors

Constructor and Description
LighthouseModbus(InstrumentConfig config) Constructs a new instance from configuration data.

Method Summary

Modifier and Type	Method and Description
Instrument	disable() Produces a new instance that has readout disabled.
Instrument	enable(LocationConfig loc) Produces a new instance that has been enabled for readout and is serving a new location.
int	getIndex() Gets the position of this instrument in the list of instruments.
Optional<org.lsst.ccs.HardwareException>	getLastException() Gets the exception thrown (if any) the last time we tried to operate on this instrument.
InstrumentStatus	getStatus() Gets the current status of the instrument.
Stream<TrendableRecord>	getTrendables() Gets all the trendable data resulting from the last reading of the instrument.
Instrument	read() Produces a new instance that contains a fresh set of data read from the instrument.

Methods inherited from class java.lang.Object

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

Constructor Detail

LighthouseModbus

public LighthouseModbus(InstrumentConfig config)

Constructs a new instance from configuration data. The new instance will be disabled for reading, have no stored data and have no stored exception.

Parameters:

config - The subsystem's configuration information for the instrument.

Method Detail

getLastException

public Optional<org.lsst.ccs.HardwareException> getLastException()

Gets the exception thrown (if any) the last time we tried to operate on this instrument.

Specified by:

getLastException in interface Instrument

Returns:

An empty Optional if there have been no operations or if the last operation was successful. Otherwise an Optional containing the exception that terminated the operation. Getters are not considered operations.

getIndex

public int getIndex()

Gets the position of this instrument in the list of instruments.

Specified by:

getIndex in interface Instrument

Returns:

The index.

See Also:

LocalConfigService.getInstrumentConfigs()

getStatus

public InstrumentStatus getStatus()

Gets the current status of the instrument. This method will be used in QUERY-type commands, so implementations must rely solely on data in memory and must not perform any hardware operations.

Specified by:

getStatus in interface Instrument

Returns:

The status object.

getTrendables

public Stream<TrendableRecord> getTrendables()

Gets all the trendable data resulting from the last reading of the instrument.

Specified by:

getTrendables in interface Instrument

Returns:

A stream of TrendableRecord instances, empty if no data is available, for example if the instrument has never been read or if the last read found no new data or failed. The master key of each record is the location for which the data were taken. The master timestamp is the time at which the record was made. Each key/value pair consists of a channel name and value.

See Also:

Instrument.read()

disable

public Instrument disable()

Produces a new instance that has readout disabled.

Specified by:

disable in interface Instrument

Returns:

The new instance.

enable

public Instrument enable(LocationConfig loc)

Produces a new instance that has been enabled for readout and is serving a new location. The device will be reconfigured for the new location. For example, alarm thresholds will be altered.

Specified by:

enable in interface Instrument

Parameters:

loc - The configuration of the new location.

Returns:

The new instance.

read

public Instrument read()

Produces a new instance that contains a fresh set of data read from the instrument. The Instrument.getTrendables() method relies on this data to produce its result.

Specified by:

read in interface Instrument

Returns:

The new instance.