org.mbari.siam.core
Interface InstrumentPort

All Known Implementing Classes:

AnalogInstrumentPort, DigitalInputInstrumentPort, HttpInstrumentPort, MiscInstrumentPort, NVTInstrumentPort, PuckSerialInstrumentPort, SerialInstrumentPort

public interface InstrumentPort

Interface that encompasses power control and communications to an instrument.

Author:

Mike Risi

Field Summary

static boolean

RTS_SENSE

Method Summary

void	connectPower() Connect instrument to power.
void	disableCommunications() Disable communications
void	disconnectPower() Disconnect instrument from power.
void	enableCommunications() Enable communications
java.lang.String	getCommPortName() get the name of the communications port
float	getCurrentLevel() Get the current level of the PowerPort (amps).
int	getCurrentLimit() Get current limit of port.
java.io.InputStream	getInputStream() get an InputStream to the instrument
InstrumentConsole	getInstrumentConsole() get a console to an Instrument
InstrumentPortOutputStream	getOutputStream() get an OutputStream to the instrument
java.lang.String	getStatusMessage() Get health/status string.
java.lang.String	getStatusSummaryMessage() Get health/status summary string.
java.lang.String	getTerseStatus() Get terse summary string.
float	getVoltageLevel() Get the voltage level of the PowerPort (volts).
void	initialize() Initialize the port.
void	isolatePort() Isolate comms and power from port.
boolean	isSuspended() get the suspend state of the instrument port
void	resetStatus() Reset status.
void	resume() resumes instruents comms from suspended state
void	setCommsMode(CommsMode commsMode) Set communications mode (RS422,RS485,RS232)
void	setCurrentLimit(int currentLimit) Set current limit on port.
void	shutDown() Power down the instrument and close the communications port
void	suspend() suspends comms so another application can communicate with the instrument

Field Detail

RTS_SENSE

static final boolean RTS_SENSE

See Also:

Constant Field Values

Method Detail

initialize

void initialize()
                throws InitializeException

Initialize the port.

Throws:

InitializeException

resume

void resume()

resumes instruents comms from suspended state

suspend

void suspend()

suspends comms so another application can communicate with the instrument

shutDown

void shutDown()

Power down the instrument and close the communications port

isSuspended

boolean isSuspended()

get the suspend state of the instrument port

getCommPortName

java.lang.String getCommPortName()

get the name of the communications port

getInputStream

java.io.InputStream getInputStream()
                                   throws java.io.IOException

get an InputStream to the instrument

Throws:

java.io.IOException

getOutputStream

InstrumentPortOutputStream getOutputStream()
                                           throws java.io.IOException

get an OutputStream to the instrument

Throws:

java.io.IOException

getInstrumentConsole

InstrumentConsole getInstrumentConsole()
                                       throws java.io.IOException

get a console to an Instrument

Throws:

java.io.IOException

enableCommunications

void enableCommunications()

Enable communications

disableCommunications

void disableCommunications()

Disable communications

connectPower

void connectPower()

Connect instrument to power.

disconnectPower

void disconnectPower()

Disconnect instrument from power.

setCurrentLimit

void setCurrentLimit(int currentLimit)
                     throws RangeException,
                            NotSupportedException

Set current limit on port.

Throws:

RangeException

NotSupportedException

getCurrentLimit

int getCurrentLimit()
                    throws NoDataException,
                           NotSupportedException

Get current limit of port.

Throws:

NoDataException

NotSupportedException

getVoltageLevel

float getVoltageLevel()
                      throws NoDataException,
                             NotSupportedException

Get the voltage level of the PowerPort (volts).

Throws:

NoDataException

NotSupportedException

getCurrentLevel

float getCurrentLevel()
                      throws NoDataException,
                             NotSupportedException

Get the current level of the PowerPort (amps).

Throws:

NoDataException

NotSupportedException

isolatePort

void isolatePort()

Isolate comms and power from port.

getStatusMessage

java.lang.String getStatusMessage()

Get health/status string.

getStatusSummaryMessage

java.lang.String getStatusSummaryMessage()

Get health/status summary string.

getTerseStatus

java.lang.String getTerseStatus()

Get terse summary string.

resetStatus

void resetStatus()

Reset status.

setCommsMode

void setCommsMode(CommsMode commsMode)

Set communications mode (RS422,RS485,RS232)