org.lsst.ccs.subsystem.rafts

Class PowerDevice

java.lang.Object

org.lsst.ccs.framework.ConfigurableComponent

org.lsst.ccs.subsystem.monitor.Device

org.lsst.ccs.subsystem.rafts.PowerDevice

All Implemented Interfaces:

org.lsst.ccs.framework.Configurable

Direct Known Subclasses:

BK1696Device, BK9130Device, N6700Device, SimPowerDevice

public abstract class PowerDevice
extends org.lsst.ccs.subsystem.monitor.Device

Interface to an ASCII commanded power supply device.

Author:

Owen Saxton

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	CONN_TYPE_NOT_CONFIG Constants.
protected int	connType
protected Power.ConnType	connTypeE
protected String	connTypeS Data fields.
protected static int	DEVC_ID_NOT_CONFIG Constants.
protected static int	DEVC_PARM_NOT_CONFIG Constants.
protected String	devcId
protected int	devcParm
protected static int	NETWORK_CONN_INVALID Constants.

Fields inherited from class org.lsst.ccs.subsystem.monitor.Device

chanMask, ctlChans, fullName, inited, lineMask, lineState, lineWarm, log, mon, online

Fields inherited from class org.lsst.ccs.framework.ConfigurableComponent

environment

Constructor Summary

Constructors

Constructor and Description
PowerDevice(String connType, String devcId, int devcParm) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addConfigValues(Map<String,Object> values) Adds to the map of configured values.
protected void	configure(org.lsst.ccs.subsystem.monitor.Monitor mon) Performs configuration.
String	getConnType()
String	getDevcId()
int	getDevcParm()
protected abstract int	getMaxChannel() Gets the maximum hardware channel number.
protected abstract int	getMinChannel() Gets the minimum hardware channel number.
protected abstract int	getOptions() Gets the device options.
Power	getPowerConfig() Gets the configuration data.
protected List<PowerState>	getPowerState() Gets the list of power state data.
protected void	powerOff() Powers off all channels.
protected void	powerOn() Powers on all channels.
protected double	readCurrent(int hwChan) Reads the current from the hardware.
protected void	readCurrentGroup() Reads a group of currents from the hardware.
protected abstract double	readCurrentHdw(int hwChan) Reads the current from the hardware.
protected boolean	readOutput(int hwChan) Reads the power output state from the hardware.
protected void	readOutputGroup() Reads a group of power output states from the hardware.
protected abstract boolean	readOutputHdw(int hwChan) Reads the power output state from the hardware.
protected double	readVoltage(int hwChan) Reads the voltage from the hardware.
protected void	readVoltageGroup() Reads a group of voltages from the hardware.
protected abstract double	readVoltageHdw(int hwChan) Reads the voltage from the hardware.
void	setConnType(String connTypeS) Sets/gets the connection type.
void	setDevcId(String devcId) Sets/gets the device ID.
void	setDevcParm(int devcParm) Sets/gets the device parameter.
void	setPowerConfig(Power power) Sets the configuration data.
protected void	writeCurrent(double current, int hwChan) Writes the current to the hardware.
protected void	writeCurrentGroup() Writes a group of currents to the hardware.
protected abstract void	writeCurrentHdw(double current, int hwChan) Writes the current to the hardware.
protected void	writeOffDelay(double offDelay, int hwChan) Writes the power-off delay to the hardware.
protected void	writeOffDelayGroup() Writes a group of power-off delays to the hardware.
protected abstract void	writeOffDelayHdw(double offDelay, int hwChan) Writes the power-off delay to the hardware.
protected void	writeOnDelay(double onDelay, int hwChan) Writes the power-on delay to the hardware.
protected void	writeOnDelayGroup() Writes a group of power-on delays to the hardware.
protected abstract void	writeOnDelayHdw(double onDelay, int hwChan) Writes the power-on delay to the hardware.
protected void	writeOutput(boolean value, int hwChan) Writes the power output state to the hardware.
protected void	writeOutputGroup() Writes a group of power output states to the hardware.
protected abstract void	writeOutputHdw(boolean value, int hwChan) Writes the power output state to the hardware.
protected void	writeVoltage(double voltage, int hwChan) Writes the voltage to the hardware.
protected void	writeVoltageGroup() Writes a group of voltages to the hardware.
protected abstract void	writeVoltageHdw(double voltage, int hwChan) Writes the voltage to the hardware.

Methods inherited from class org.lsst.ccs.subsystem.monitor.Device

addChannel, addLine, checkChannel, checkHwLine, checkLine, checkOnline, checkTimeout, close, dropChannel, getConfigValues, getFullName, getOutputLines, initChannel, initialize, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, readChannelGroup, readSensors, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, testOnline

Methods inherited from class org.lsst.ccs.framework.ConfigurableComponent

getChildren, getEnvironment, setEnvironment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.lsst.ccs.framework.Configurable

alias, change, getCheckedValueFromConfiguration, getComponentByName, getDictionary, getName, getParent, getParentObject, getSubsystem, init, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, postStart, proceduralWalk, publish, publish, publish, publish, publish, publish, shutdownNow, start, treeWalk

Field Detail

NETWORK_CONN_INVALID

protected static final int NETWORK_CONN_INVALID

Constants.

See Also:

Constant Field Values

CONN_TYPE_NOT_CONFIG

protected static final int CONN_TYPE_NOT_CONFIG

Constants.

See Also:

Constant Field Values

DEVC_ID_NOT_CONFIG

protected static final int DEVC_ID_NOT_CONFIG

Constants.

See Also:

Constant Field Values

DEVC_PARM_NOT_CONFIG

protected static final int DEVC_PARM_NOT_CONFIG

Constants.

See Also:

Constant Field Values

connTypeS

protected String connTypeS

Data fields.

devcId

protected String devcId

devcParm

protected int devcParm

connType

protected int connType

connTypeE

protected Power.ConnType connTypeE

Constructor Detail

PowerDevice

public PowerDevice(String connType,
                   String devcId,
                   int devcParm)

Constructor.

Parameters:

connType - The connection type: network; ftdi; serial

devcId - The device ID: host name; USB serial no.; serial device name

devcParm - The device parameter: baud rate; baud rate; port number

Method Detail

configure

protected void configure(org.lsst.ccs.subsystem.monitor.Monitor mon)

Performs configuration.

Overrides:

configure in class org.lsst.ccs.subsystem.monitor.Device

setConnType

@ConfigChanger
public void setConnType(String connTypeS)
                                throws VSTException

Sets/gets the connection type.

Throws:

VSTException

getConnType

@Command(type=QUERY,
         description="Gets the connection type")
public String getConnType()

setDevcId

@ConfigChanger
public void setDevcId(String devcId)

Sets/gets the device ID.

getDevcId

@Command(type=QUERY,
         description="Gets the device ID")
public String getDevcId()

setDevcParm

@ConfigChanger
public void setDevcParm(int devcParm)

Sets/gets the device parameter.

getDevcParm

@Command(type=QUERY,
         description="Gets the device parameter")
public int getDevcParm()

getPowerConfig

public Power getPowerConfig()

Gets the configuration data.

setPowerConfig

public void setPowerConfig(Power power)
                    throws Exception

Sets the configuration data.

Throws:

Exception

addConfigValues

protected void addConfigValues(Map<String,Object> values)

Adds to the map of configured values.

Overrides:

addConfigValues in class org.lsst.ccs.subsystem.monitor.Device

getPowerState

protected List<PowerState> getPowerState()
                                  throws Exception

Gets the list of power state data.

Throws:

Exception

powerOn

protected void powerOn()
                throws Exception

Powers on all channels.

Throws:

Exception

powerOff

protected void powerOff()
                 throws Exception

Powers off all channels.

Throws:

Exception

writeVoltage

protected void writeVoltage(double voltage,
                            int hwChan)
                     throws Exception

Writes the voltage to the hardware.

Throws:

Exception

readVoltage

protected double readVoltage(int hwChan)
                      throws Exception

Reads the voltage from the hardware.

Throws:

Exception

writeCurrent

protected void writeCurrent(double current,
                            int hwChan)
                     throws Exception

Writes the current to the hardware.

Throws:

Exception

readCurrent

protected double readCurrent(int hwChan)
                      throws Exception

Reads the current from the hardware.

Throws:

Exception

writeOnDelay

protected void writeOnDelay(double onDelay,
                            int hwChan)
                     throws Exception

Writes the power-on delay to the hardware.

Throws:

Exception

writeOffDelay

protected void writeOffDelay(double offDelay,
                             int hwChan)
                      throws Exception

Writes the power-off delay to the hardware.

Throws:

Exception

writeOutput

protected void writeOutput(boolean value,
                           int hwChan)
                    throws Exception

Writes the power output state to the hardware.

Throws:

Exception

readOutput

protected boolean readOutput(int hwChan)
                      throws Exception

Reads the power output state from the hardware.

Throws:

Exception

getOptions

protected abstract int getOptions()

Gets the device options.

getMinChannel

protected abstract int getMinChannel()

Gets the minimum hardware channel number.

getMaxChannel

protected abstract int getMaxChannel()

Gets the maximum hardware channel number.

writeVoltageHdw

protected abstract void writeVoltageHdw(double voltage,
                                        int hwChan)
                                 throws org.lsst.ccs.drivers.commons.DriverException

Writes the voltage to the hardware.

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeVoltageGroup

protected void writeVoltageGroup()
                          throws org.lsst.ccs.drivers.commons.DriverException

Writes a group of voltages to the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltageHdw

protected abstract double readVoltageHdw(int hwChan)
                                  throws org.lsst.ccs.drivers.commons.DriverException

Reads the voltage from the hardware.

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltageGroup

protected void readVoltageGroup()
                         throws org.lsst.ccs.drivers.commons.DriverException

Reads a group of voltages from the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeCurrentHdw

protected abstract void writeCurrentHdw(double current,
                                        int hwChan)
                                 throws org.lsst.ccs.drivers.commons.DriverException

Writes the current to the hardware.

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeCurrentGroup

protected void writeCurrentGroup()
                          throws org.lsst.ccs.drivers.commons.DriverException

Writes a group of currents to the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrentHdw

protected abstract double readCurrentHdw(int hwChan)
                                  throws org.lsst.ccs.drivers.commons.DriverException

Reads the current from the hardware.

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrentGroup

protected void readCurrentGroup()
                         throws org.lsst.ccs.drivers.commons.DriverException

Reads a group of currents from the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeOnDelayHdw

protected abstract void writeOnDelayHdw(double onDelay,
                                        int hwChan)
                                 throws org.lsst.ccs.drivers.commons.DriverException

Writes the power-on delay to the hardware.

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeOnDelayGroup

protected void writeOnDelayGroup()
                          throws org.lsst.ccs.drivers.commons.DriverException

Writes a group of power-on delays to the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeOffDelayHdw

protected abstract void writeOffDelayHdw(double offDelay,
                                         int hwChan)
                                  throws org.lsst.ccs.drivers.commons.DriverException

Writes the power-off delay to the hardware.

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeOffDelayGroup

protected void writeOffDelayGroup()
                           throws org.lsst.ccs.drivers.commons.DriverException

Writes a group of power-off delays to the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeOutputHdw

protected abstract void writeOutputHdw(boolean value,
                                       int hwChan)
                                throws org.lsst.ccs.drivers.commons.DriverException

Writes the power output state to the hardware.

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeOutputGroup

protected void writeOutputGroup()
                         throws org.lsst.ccs.drivers.commons.DriverException

Writes a group of power output states to the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

readOutputHdw

protected abstract boolean readOutputHdw(int hwChan)
                                  throws org.lsst.ccs.drivers.commons.DriverException

Reads the power output state from the hardware.

Throws:

org.lsst.ccs.drivers.commons.DriverException

readOutputGroup

protected void readOutputGroup()
                        throws org.lsst.ccs.drivers.commons.DriverException

Reads a group of power output states from the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException