org.mbari.siam.distributed
Interface PowerPort

All Known Implementing Classes:

DpaPresentPowerPort, FOCEPowerPort, NullPowerPort, SidearmPowerPort

public interface PowerPort

Interface to control a device's power.

Author:

Tom O'Reilly

Method Summary

void	connectPower() Connect instrument to power.
void	disableCommunications() Disable communications
void	disconnectPower() Disconnect instrument from power.
void	enableCommunications() Enable communications
float	getCurrentLevel() Get the current level of the PowerPort (amps).
int	getCurrentLimit() Get current limit of port.
java.lang.String	getName() Get name of power port.
java.lang.String	getStatusMessage() Get status message.
java.lang.String	getStatusSummaryMessage() Get status summary message.
float	getTemperature() Get temperature.
java.lang.String	getTerseStatus() Get a terse status message
float	getVoltageLevel() Get the voltage level of the PowerPort (volts).
void	initialize() Initialize the port.
void	isolatePort() Isolate comms and power from port.
void	resetStatus() Reset status
void	setCommsMode(CommsMode commsMode) Set communications mode (RS422,RS485,RS232)
void	setCurrentLimit(int currentLimit) Set current limit on port.

Method Detail

initialize

void initialize()

Initialize the port.

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

getTemperature

float getTemperature()
                     throws NoDataException,
                            NotSupportedException

Get temperature.

Throws:

NoDataException

NotSupportedException

getStatusMessage

java.lang.String getStatusMessage()

Get status message.

getStatusSummaryMessage

java.lang.String getStatusSummaryMessage()

Get status summary message.

getTerseStatus

java.lang.String getTerseStatus()

Get a terse status message

resetStatus

void resetStatus()

Reset status

enableCommunications

void enableCommunications()

Enable communications

disableCommunications

void disableCommunications()

Disable communications

connectPower

void connectPower()

Connect instrument to power.

disconnectPower

void disconnectPower()

Disconnect instrument from power.

isolatePort

void isolatePort()

Isolate comms and power from port.

getName

java.lang.String getName()

Get name of power port.

setCommsMode

void setCommsMode(CommsMode commsMode)

Set communications mode (RS422,RS485,RS232)