org.mbari.siam.devices.smartstar
Class SmartStar

java.lang.Object
  extended by java.rmi.server.RemoteObject
      extended by java.rmi.server.RemoteServer
          extended by java.rmi.server.UnicastRemoteObject
              extended by org.mbari.siam.core.DeviceService
                  extended by org.mbari.siam.core.InstrumentService
                      extended by org.mbari.siam.devices.smartstar.SmartStar
All Implemented Interfaces:
java.io.Serializable, java.rmi.Remote, ScheduleOwner, Device, DeviceServiceIF, Instrument

public class SmartStar
extends InstrumentService
implements Instrument

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.mbari.siam.core.InstrumentService
_defaultSampleScheduleName, _instrumentAttributes, _lastPacket, _lastSensorDataPacket, _messagePacket, _packetLog, _recordType, _schedules, _sensorDataPacket, 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
SmartStar()
           
 
Method Summary
protected  ScheduleSpecifier createDefaultSampleSchedule()
          Return specifier for default sampling schedule.
protected  byte[] getInstrumentMetadata()
          Return SmartStar metadata.
 SerialPortParameters getSerialPortParameters()
          Return parameters to use on serial port.
protected  PowerPolicy initCommunicationPowerPolicy()
          SmartStar communications power policy POWER_ALWAYS.
protected  int initCurrentLimit()
          SmartStar current limit 500 milliamps.
protected  void initializeInstrument()
          Initialize the compass.
protected  PowerPolicy initInstrumentPowerPolicy()
          SmartStar power policy POWER_ALWAYS.
protected  int initInstrumentStartDelay()
          SmartStar startup time 1000 millisec.
protected  int initMaxSampleBytes()
          SmartStar maximum number of bytes in a instrument data sample 1000.
protected  byte[] initPromptString()
          SmartStar prompt "RDY\r"
protected  byte[] initSampleTerminator()
          SmartStar sample terminator "RDY\r"
protected  void prepareToSample()
          Signal the SmartSar that you are ready to fetch the data.
protected  int readSample(byte[] sample)
          Read captured data sample from the SmartStar.
protected  void requestSample()
          Request captured data from the SmartStar
 void setClock(long time)
          Set the sensor's clock.
 int test()
          Self-test routine; This does nothing in the SmartStar driver
 
Methods inherited from class org.mbari.siam.core.InstrumentService
acquire, acquireSample, addDefaultPacketFilters, addSchedule, addSchedule, annotate, cacheProperties, checkInputProperties, cleanupServiceState, clearDefaultPacketFilters, clearPropertiesCache, createTask, disableSamplingDiagnostics, disableSummary, doScheduledTask, enableSamplingDiagnostics, enableSummary, getAllSchedules, getChildren, getCommunicationPowerPolicy, getCurrentLimit, getDefaultPacketFilters, getDefaultSampleSchedule, getDefaultSampleScheduleName, getDevicePacketParser, getFileBytes, getInstrumentBlock, getInstrumentPowerPolicy, getInstrumentStartDelay, getInstrumentStateMetadata, getLastSample, getLocation, getMaxSampleBytes, getMaxSampleTries, getMetadata, getMetadata, getMetadataPayload, getPackets, getPackets, getParent, getParser, getPortDiagnostics, getPortDiagnosticsSummary, getPromptString, getProperties, getProperty, getSampleBuf, getSampleSchedule, getSampleTerminator, getSampleTimeout, getSchedule, getScheduleKey, getSchedules, getServiceCacheBytes, getServicePropertiesBytes, getServiceXMLBytes, initialize, initializeDriverDefaults, initServiceState, interruptSampling, logPacket, managePowerSleep, managePowerWake, parseDataPacket, postSample, powerOff, powerOffCallback, powerOn, powerOnCallback, prepareToRun, printData, processSample, removeAllSchedules, removeSchedule, resetPortDiagnostics, resumeSchedule, running, setAttributes, setClock, setCommunicationPowerPolicy, setCurrentLimit, setDefaultSampleScheduleName, setInstrumentBlock, setInstrumentPowerPolicy, setInstrumentStartDelay, setMaxSampleBytes, setMaxSampleTries, setPromptString, setProperty, setRecordType, setSampleTerminator, setSampleTimeout, shutdown, shutdownInstrument, sleepingUntil, summaryEnabled, suspend, suspendSchedule, sync, syncSchedule, validateSample
 
Methods inherited from class org.mbari.siam.core.DeviceService
addDataListener, advertiseService, createRegistryEntry, getAttributes, getCommPortName, getFrameworkVersion, getId, getInstrumentPort, getName, getRemoteSerialPort, getRemoteSerialPort, getSamplingCount, getSamplingErrorCount, getSamplingRetryCount, getStatus, host, incRetryCount, initializePropertyDefaults, registryEntry, registryName, removeDataListener, resume, 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
 

Constructor Detail

SmartStar

public SmartStar()
          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException
Method Detail

initInstrumentPowerPolicy

protected PowerPolicy initInstrumentPowerPolicy()
SmartStar power policy POWER_ALWAYS.

Specified by:
initInstrumentPowerPolicy in class InstrumentService

initCommunicationPowerPolicy

protected PowerPolicy initCommunicationPowerPolicy()
SmartStar communications power policy POWER_ALWAYS.

Specified by:
initCommunicationPowerPolicy in class InstrumentService

initInstrumentStartDelay

protected int initInstrumentStartDelay()
SmartStar startup time 1000 millisec.

Specified by:
initInstrumentStartDelay in class InstrumentService

initCurrentLimit

protected int initCurrentLimit()
SmartStar current limit 500 milliamps.

Specified by:
initCurrentLimit in class InstrumentService

initSampleTerminator

protected byte[] initSampleTerminator()
SmartStar sample terminator "RDY\r"

Specified by:
initSampleTerminator in class InstrumentService

initPromptString

protected byte[] initPromptString()
SmartStar prompt "RDY\r"

Specified by:
initPromptString in class InstrumentService

initMaxSampleBytes

protected int initMaxSampleBytes()
SmartStar maximum number of bytes in a instrument data sample 1000.

Specified by:
initMaxSampleBytes in class InstrumentService

initializeInstrument

protected void initializeInstrument()
Initialize the compass.

Overrides:
initializeInstrument in class InstrumentService

getSerialPortParameters

public SerialPortParameters getSerialPortParameters()
                                             throws gnu.io.UnsupportedCommOperationException
Return parameters to use on serial port.

Overrides:
getSerialPortParameters in class DeviceService
Throws:
gnu.io.UnsupportedCommOperationException

prepareToSample

protected void prepareToSample()
                        throws java.lang.Exception
Signal the SmartSar that you are ready to fetch the data. This method must be called before request sample

Overrides:
prepareToSample in class InstrumentService
Throws:
java.lang.Exception

readSample

protected int readSample(byte[] sample)
                  throws TimeoutException,
                         java.lang.Exception
Read captured data sample from the SmartStar.

Overrides:
readSample in class InstrumentService
Parameters:
sample - output buffer
Throws:
TimeoutException
java.lang.Exception

getInstrumentMetadata

protected byte[] getInstrumentMetadata()
Return SmartStar metadata.


setClock

public void setClock(long time)
Set the sensor's clock. This does nothing in the SmartStar driver

Specified by:
setClock in interface Instrument
Specified by:
setClock in class InstrumentService

test

public int test()
Self-test routine; This does nothing in the SmartStar driver

Specified by:
test in interface Device

requestSample

protected void requestSample()
                      throws java.io.IOException
Request captured data from the SmartStar

Specified by:
requestSample in class InstrumentService
Throws:
java.io.IOException

createDefaultSampleSchedule

protected ScheduleSpecifier createDefaultSampleSchedule()
                                                 throws ScheduleParseException
Return specifier for default sampling schedule.

Specified by:
createDefaultSampleSchedule in class InstrumentService
Throws:
ScheduleParseException


Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.