org.lsst.ccs.drivers.lighthouse

Interface Hardware

All Known Implementing Classes:

ASCIIModbus

public interface Hardware

An abstract description of device operations that are close to the hardware. Except for close(), each of these operations involves just a few register read and/or write commands.

Author:

tether

Method Summary

Modifier and Type	Method and Description
boolean	alarmIsEnabled(DataChannel chan) Gets the alarm enable status for a particle channel.
boolean	channelIsEnabled(DataChannel chan) Checks whether the given data channel is enabled.
void	close() Closes the underlying connection to the device.
long	getAlarmThreshold(DataChannel chan) Gets the current alarm threshold for a particle channel.
long	getClock() Gets the device's time-of-day clock.
String	getDeviceLocationName() Gets the label for the current location set for the device.
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.
DataRecord	readRecord() Reads the current data record from the device faster than one could by combining the other methods exported by this interface.
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	setAlarmEnable(DataChannel chan, boolean on) Enables or disables the alarm for a particle channel.
void	setAlarmThreshold(DataChannel chan, long threshold) Sets the particle count alarm threshold for a particle channel but doesn't change the alarm enable status.
void	setClock(long epochSecond) Sets the device's time-of-day clock.
void	setDeviceLocationIndex(int index) Sets the current-location register for the device.
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

close

void close()
    throws org.lsst.ccs.drivers.commons.DriverException

Closes the underlying connection to the device.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for I/O errors.

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.

channelIsEnabled

boolean channelIsEnabled(DataChannel chan)
                  throws org.lsst.ccs.drivers.commons.DriverException

Checks whether the given data channel is enabled.

Parameters:

chan - The channel to check.

Returns:

True if the channel is enabled on the device, else false.

Throws:

org.lsst.ccs.drivers.commons.DriverException - upon I/O error.

readRecord

DataRecord readRecord()
               throws org.lsst.ccs.drivers.commons.DriverException

Reads the current data record from the device faster than one could by combining the other methods exported by this interface.

Returns:

The data record.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for I/O errors.

setAlarmThreshold

void setAlarmThreshold(DataChannel chan,
                       long threshold)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the particle count alarm threshold for a particle channel but doesn't change the alarm enable status.

Parameters:

chan - The channel to be affected.

threshold - The limiting particle count.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for I/O errors.

IllegalArgumentException - if the channel is analog or if the threshold is not in the interval [0, 2^32-1].

getAlarmThreshold

long getAlarmThreshold(DataChannel chan)
                throws org.lsst.ccs.drivers.commons.DriverException

Gets the current alarm threshold for a particle channel.

Parameters:

chan - The channel to query.

Returns:

The current alarm threshold.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for I/O errors.

IllegalArgumentException - if the channel is analog.

setAlarmEnable

void setAlarmEnable(DataChannel chan,
                    boolean on)
             throws org.lsst.ccs.drivers.commons.DriverException

Enables or disables the alarm for a particle channel.

Parameters:

chan - The channel to affect.

on - true to enable alarms, false to disable.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for I/O errors.

IllegalArgumentException - if the channel is analog.

alarmIsEnabled

boolean alarmIsEnabled(DataChannel chan)
                throws org.lsst.ccs.drivers.commons.DriverException

Gets the alarm enable status for a particle channel.

Parameters:

chan - The channel to query.

Returns:

true if enabled, false if disabled.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for I/O errors.

IllegalArgumentException - if the channel is analog.

setClock

void setClock(long epochSecond)
       throws org.lsst.ccs.drivers.commons.DriverException

Sets the device's time-of-day clock.

Parameters:

epochSecond - Elapsed seconds since the Unix epoch.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for I/O errors.

getClock

long getClock()
       throws org.lsst.ccs.drivers.commons.DriverException

Gets the device's time-of-day clock.

Returns:

The clock reading in seconds since the Unix epoch.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for I/O errors.

setDeviceLocationIndex

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

Sets the current-location register for the device.

Parameters:

index - The index (lowest = 1).

Throws:

org.lsst.ccs.drivers.commons.DriverException - for I/O errors.

getDeviceLocationName

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

Gets the label for the current location set for the device.

Returns:

The current location label.

Throws:

org.lsst.ccs.drivers.commons.DriverException - for I/O errors.