org.lsst.ccs.drivers.lighthouse

Interface Hardware

All Known Implementing Classes:

ASCIIModbus

public interface Hardware

Provides low-level hardware operations.

Author:

tether

Method Summary

Modifier and Type	Method and Description
ChannelType	readChannelType(DataChannel chan) Reads the data type registers for a data channel of the current record.
ChannelUnits	readChannelUnits(DataChannel chan) Reads the units registers for a data channel of the current record.
double	readChannelValue(DataChannel chan) Reads the value registers for a data channel of the current record.
Set<DeviceFlag>	readDeviceFlags() Reads the device status register.
int	readDeviceMapVersion() Reads the Modbus map version register.
String	readDeviceModel() Reads the model designation registers.
int	readRecordCount() Reads the record count register.
java.time.Duration	readRecordDuration() Reads the record sample time register.
Set<RecordFlag>	readRecordFlags() Reads the device status registers of the current record.
String	readRecordLocation() Reads the registers for location number and location name.
java.time.Instant	readRecordStartTime() Reads the record timestamp register.
void	writeDeviceCommand(DeviceCommand cmd) Writes to the device command register.
void	writeRecordIndex(int index) Writes to the record index register, making the data registers show the contents of a particular record in its memory.

Method Detail

readDeviceModel

String readDeviceModel()
                throws org.lsst.ccs.drivers.commons.DriverException

Reads the model designation registers.

Returns:

The register values made into a String.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

readDeviceMapVersion

int readDeviceMapVersion()
                  throws org.lsst.ccs.drivers.commons.DriverException

Reads the Modbus map version register.

Returns:

The version number times 100. v1.44 would be represented as 144.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

readDeviceFlags

Set<DeviceFlag> readDeviceFlags()
                         throws org.lsst.ccs.drivers.commons.DriverException

Reads the device status register.

Returns:

A set with one element per bit set in the register.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

writeDeviceCommand

void writeDeviceCommand(DeviceCommand cmd)
                 throws org.lsst.ccs.drivers.commons.DriverException

Writes to the device command register.

Parameters:

cmd - A valid device command.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

readRecordCount

int readRecordCount()
             throws org.lsst.ccs.drivers.commons.DriverException

Reads the record count register.

Returns:

The number of records currently held in the device's memory.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

writeRecordIndex

void writeRecordIndex(int index)
               throws org.lsst.ccs.drivers.commons.DriverException

Writes to the record index register, making the data registers show the contents of a particular record in its memory.

Parameters:

index - The zero-based record index. 0 .. N - 1, or -1 for the latest record.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

readRecordStartTime

java.time.Instant readRecordStartTime()
                               throws org.lsst.ccs.drivers.commons.DriverException

Reads the record timestamp register.

Returns:

The time at which data collection started for the current record.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

readRecordDuration

java.time.Duration readRecordDuration()
                               throws org.lsst.ccs.drivers.commons.DriverException

Reads the record sample time register.

Returns:

How long data collection took for the current record.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

readRecordLocation

String readRecordLocation()
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads the registers for location number and location name.

Returns:

The name of the device location for the current record.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

readRecordFlags

Set<RecordFlag> readRecordFlags()
                         throws org.lsst.ccs.drivers.commons.DriverException

Reads the device status registers of the current record.

Returns:

The set of RecordFlag corresponding to the status mask. See RecordFlag.flagsFromMask(int).

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise.

readChannelType

ChannelType readChannelType(DataChannel chan)
                     throws org.lsst.ccs.drivers.commons.DriverException

Reads the data type registers for a data channel of the current record.

Parameters:

chan - The channel.

Returns:

The channel type.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise or if the channel type label read from the device isn't what's specified by chan.

readChannelUnits

ChannelUnits readChannelUnits(DataChannel chan)
                       throws org.lsst.ccs.drivers.commons.DriverException

Reads the units registers for a data channel of the current record.

Parameters:

chan - The channel.

Returns:

The units.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise or if the units label read from the device isn't what's specified by chan.

readChannelValue

double readChannelValue(DataChannel chan)
                 throws org.lsst.ccs.drivers.commons.DriverException

Reads the value registers for a data channel of the current record. Assumes that the registers hold a single-precision IEEE float for an analog channel or an int for others.

Parameters:

chan - The channel.

Returns:

The value, converted to double.

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communication problems arise or if the channel isn't enabled on the device.