org.mbari.siam.devices.hobilabs
Class HydroRad

java.lang.Object
  java.rmi.server.RemoteObject
      java.rmi.server.RemoteServer
          java.rmi.server.UnicastRemoteObject
              org.mbari.siam.core.DeviceService
                  org.mbari.siam.core.BaseInstrumentService
                      org.mbari.siam.core.PolledInstrumentService
                          org.mbari.siam.devices.hobilabs.HydroRad

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, ScheduleOwner, Device, DeviceServiceIF, Instrument

public class HydroRad
extends PolledInstrumentService
implements Instrument

The HydroRad class represents the InstrumentServices driver for controlling multichannel radiometers. The class duties is to capture and verify sample data from the instrument.

See Also:

Device, Instrument, PowerPort, InstrumentService, Serialized Form

Field Summary

Fields inherited from class org.mbari.siam.core.BaseInstrumentService

_defaultSamplerTask, _defaultSampleScheduleName, _errorCache, _instrumentAttributes, _lastPacket, _lastSensorDataPacket, _maxSampleBytes, _messagePacket, _nPowerRequests, _nWakeRequests, _packetLog, _recordType, _running, _samplerWakeupTime, _scheduleKey, _schedules, _sensorDataPacket, _turbinator, MAX_BASE_RECORDTYPE, RECORDTYPE_DEFAULT, RECORDTYPE_METADATA, RECORDTYPE_UNDEFINED

Fields inherited from class org.mbari.siam.core.DeviceService

_fromDevice, _instrumentPort, _nodeProperties, _parentNode, _regEntry, _sandBox, _serviceCachePath, _serviceName, _servicePropertiesPath, _serviceXMLPath, _toDevice, CACHED_PROPERTIES_FILENAME, PROPERTIES_FILENAME, XML_FILENAME

Fields inherited from class java.rmi.server.RemoteObject

ref

Fields inherited from interface org.mbari.siam.distributed.Device

ERROR, INITIAL, INSTRUMENT_STATE, MDATA_ALL, OK, SAFE, SAMPLING, SERVICE_ATTRIBUTES, SERVICE_CACHE, SERVICE_PROPERTIES, SERVICE_XML, SHUTDOWN, SLEEPING, SUSPEND, UNKNOWN

Constructor Summary

HydroRad()
Initializes a new HydroRad instance

Method Summary

protected ScheduleSpecifier	createDefaultSampleSchedule() Return specifier for default sampling schedule.
protected byte[]	getInstrumentMetadata() Not implemented
SerialPortParameters	getSerialPortParameters() Return parameters to use on serial port.
protected PowerPolicy	initCommunicationPowerPolicy() Return initial value of communication power policy.
protected int	initCurrentLimit() Specify current limit in increments of 120 mA upto 11880 mA.
protected void	initializeInstrument() The HydroRad is initialized as follows: - 1.
protected PowerPolicy	initInstrumentPowerPolicy() Return initial value of instrument power policy.
protected int	initInstrumentStartDelay() Specify startup delay (millisec)
protected int	initMaxSampleBytes() Specify maximum bytes in raw sample.
protected byte[]	initPromptString() Specify prompt string.
protected byte[]	initSampleTerminator() Specify sample terminator.
protected void	postSample() Called by the framework after sampling.
protected void	prepareToSample() When this method is called the instrument may just have been powered up (POWER_WHEN_SAMPLIN).
protected void	printData(byte[] buf) Called by the framework after the sample data has been captured to optionally print the contents of the sample buffer for debug purposes.
protected void	requestSample() The HydroRad is sent the ACQUIRE command followed by the "acquireParams" property string.
void	setClock(long t) Not implemented.
int	test() Run device's self-test routine.

Methods inherited from class org.mbari.siam.core.PolledInstrumentService

acquire, doScheduledTask, setAttributes

Methods inherited from class org.mbari.siam.core.BaseInstrumentService

acquireSample, addDefaultPacketFilters, addSchedule, addSchedule, annotate, assertSamplingState, cacheProperties, callDataListeners, canSummarize, checkInputProperties, cleanupServiceState, clearDefaultPacketFilters, clearPropertiesCache, createPacketLog, createTask, createTurbinators, disableSummary, enableSummary, endDeviceAccess, getAllSchedules, getChildren, getCommunicationPowerPolicy, getCurrentLimit, getDefaultPacketFilters, getDefaultSampleSchedule, getDefaultSampleScheduleName, getDevicePacketParser, getFileBytes, getInstrumentPowerPolicy, getInstrumentServiceBlock, getInstrumentStartDelay, getInstrumentStateMetadata, getLastSample, getMaxSampleBytes, getMaxSampleTries, getMetadata, getMetadata, getMetadataPayload, getPackets, getPackets, getParent, getParser, getPortDiagnostics, getPortDiagnosticsSummary, getPromptString, getProperties, getProperty, getSampleBuf, getSampleSchedule, getSampleTerminator, getSampleTimeout, getSchedule, getScheduleKey, getSchedules, getServicePropertiesBytes, initialize, initializeDriverDefaults, initializePooledResources, interruptDeviceAccess, logPacket, managePowerSleep, managePowerWake, nPowerRequests, powerOff, powerOffCallback, powerOn, powerOnCallback, prepareToRun, processSample, readSample, removeAllSchedules, removeSchedule, resetPortDiagnostics, resume, resumeSchedule, running, setClock, setCommunicationPowerPolicy, setCurrentLimit, setDefaultSampleScheduleName, setInstrumentPowerPolicy, setInstrumentServiceBlock, setInstrumentStartDelay, setMaxSampleBytes, setMaxSampleTries, setPromptString, setProperty, setRecordType, setSampleTerminator, setSampleTimeout, shutdown, shutdownInstrument, sleepingUntil, snooze, startDeviceAccess, summaryEnabled, suspend, suspendSchedule, sync, syncSchedule, validateSample

Methods inherited from class org.mbari.siam.core.DeviceService

addDataListener, advertiseService, createRegistryEntry, getAttributes, getCommPortName, getFrameworkVersion, getId, getInstrumentPort, getLocation, getName, getRemoteSerialPort, getRemoteSerialPort, getSamplingCount, getSamplingErrorCount, getSamplingRetryCount, getStatus, host, incRetryCount, initializePropertyDefaults, registryEntry, registryName, removeDataListener, setInstrumentPort, setNodeProperties, setParent, setSerialPort, setStatusError, setStatusInitial, setStatusOk, setStatusSafe, setStatusSampling, setStatusShutdown, setStatusSuspend

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mbari.siam.distributed.Instrument

acquireSample, addDefaultPacketFilters, annotate, cacheProperties, clearDefaultPacketFilters, clearPropertiesCache, disableSummary, enableSummary, getDefaultPacketFilters, getLastSample, getPackets, getPackets, getParser, getPortDiagnostics, getPortDiagnosticsSummary, getProperties, getProperty, getSampleSchedule, getSchedules, resetPortDiagnostics, setClock, setProperty, summaryEnabled

Methods inherited from interface org.mbari.siam.distributed.Device

getChildren, getCommPortName, getFrameworkVersion, getId, getLocation, getMetadata, getName, getParent, getSamplingCount, getSamplingErrorCount, getSamplingRetryCount, getStatus, host, powerOff, powerOn, prepareToRun, resume, shutdown, suspend

Methods inherited from interface org.mbari.siam.distributed.DeviceServiceIF

getName

Methods inherited from interface org.mbari.siam.core.ScheduleOwner

addSchedule, getAllSchedules, getScheduleKey, removeAllSchedules, removeSchedule, resumeSchedule, sleepingUntil, suspendSchedule, syncSchedule

Constructor Detail

HydroRad

public HydroRad()
         throws java.rmi.RemoteException

Initializes a new HydroRad instance

Throws:

java.rmi.RemoteException - .

Method Detail

initInstrumentStartDelay

protected int initInstrumentStartDelay()

Specify startup delay (millisec)

Specified by:

initInstrumentStartDelay in class BaseInstrumentService

initPromptString

protected byte[] initPromptString()

Specify prompt string.

Specified by:

initPromptString in class BaseInstrumentService

initSampleTerminator

protected byte[] initSampleTerminator()

Specify sample terminator.

Specified by:

initSampleTerminator in class BaseInstrumentService

initMaxSampleBytes

protected int initMaxSampleBytes()

Specify maximum bytes in raw sample.

Specified by:

initMaxSampleBytes in class BaseInstrumentService

initCurrentLimit

protected int initCurrentLimit()

Specify current limit in increments of 120 mA upto 11880 mA.

Specified by:

initCurrentLimit in class BaseInstrumentService

initInstrumentPowerPolicy

protected PowerPolicy initInstrumentPowerPolicy()

Return initial value of instrument power policy.

Specified by:

initInstrumentPowerPolicy in class BaseInstrumentService

initCommunicationPowerPolicy

protected PowerPolicy initCommunicationPowerPolicy()

Return initial value of communication power policy.

Specified by:

initCommunicationPowerPolicy in class BaseInstrumentService

createDefaultSampleSchedule

protected ScheduleSpecifier createDefaultSampleSchedule()
                                                 throws ScheduleParseException

Return specifier for default sampling schedule.

Specified by:

createDefaultSampleSchedule in class PolledInstrumentService

Throws:

ScheduleParseException

getSerialPortParameters

public SerialPortParameters getSerialPortParameters()
                                             throws gnu.io.UnsupportedCommOperationException

Return parameters to use on serial port.

Overrides:

getSerialPortParameters in class DeviceService

Throws:

gnu.io.UnsupportedCommOperationException

initializeInstrument

protected void initializeInstrument()
                             throws InitializeException,
                                    java.lang.Exception

The HydroRad is initialized as follows: - 1. Shutter (if open) is closed. 2. Instrument time is optionally set.

Overrides:

initializeInstrument in class BaseInstrumentService

Throws:

InitializeException

java.lang.Exception

prepareToSample

protected void prepareToSample()
                        throws java.lang.Exception

When this method is called the instrument may just have been powered up (POWER_WHEN_SAMPLIN). If this is the case, communications is halted until the instrument has finished sending power up information (lineSilent(...) returning true). The time is the unconditionally set. In all power modes the spectrometer is powered up and the shutters are opened.

Overrides:

prepareToSample in class BaseInstrumentService

Throws:

java.lang.Exception - If there is a problem communicating w/ the instrument

requestSample

protected void requestSample()
                      throws TimeoutException,
                             java.lang.Exception

The HydroRad is sent the ACQUIRE command followed by the "acquireParams" property string. The instrument can take 4 - 5 minutes to determine the correct he integration time and return data. Control isn't handed back to the framework until the DATA_SYNC string has been detected. This filters out responses that are not part of the sample data stream.

Specified by:

requestSample in class PolledInstrumentService

Throws:

TimeoutException - thrown if no response to the ACQUIRE command is detected or the DATA_SYNC sequence is not detected.

java.lang.Exception - thrown if any other Exceptions are returned

postSample

protected void postSample()

Called by the framework after sampling. The HydroRad is put into a low power mode (this may be superceeded by a power down depending on power policy).

Overrides:

postSample in class BaseInstrumentService

getInstrumentMetadata

protected byte[] getInstrumentMetadata()

Not implemented

setClock

public void setClock(long t)

Not implemented. Samples are locally timestamped

Specified by:

setClock in interface Instrument

Overrides:

setClock in class BaseInstrumentService

Parameters:

t -

printData

protected void printData(byte[] buf)

Called by the framework after the sample data has been captured to optionally print the contents of the sample buffer for debug purposes.

Overrides:

printData in class BaseInstrumentService

Parameters:

buf - sample buffer

test

public int test()

Description copied from interface: Device

Run device's self-test routine.

Specified by:

test in interface Device