org.lsst.ccs.drivers.auxelex

Class IonPump

java.lang.Object

org.lsst.ccs.drivers.auxelex.Srp

org.lsst.ccs.drivers.auxelex.IonPump

public class IonPump
extends Srp

Routines for controlling the SLAC Ion Pump Controller (IPC). As of 5/31/18 the board has a defect which causes the channel switches to be always closed, regardless of the settings in the control register. Hence the only way to turn off the power for a channel is to set the voltage to zero. This also means that the voltage set needs to be cached and only applied to its DAC when/if the power is "switched on". If and when a correctly-functioning board is available, the comments marked with "BADBOARD" should be obeyed.

Author:

Owen Saxton

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.drivers.auxelex.Srp

Srp.BoardType

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHAN_PUMP0 Constants and data.
static int	CHAN_PUMP1 Constants and data.
static int	CHAN_PUMP2 Constants and data.
static int	CHAN_PUMP3 Constants and data.
static int	CHAN_PUMP4 Constants and data.
static int	CHAN_PUMP5 Constants and data.
static int	CHAN_PUMP6 Constants and data.
static int	CHAN_PUMP7 Constants and data.
static int	CHAN_PUMP8 Constants and data.
static int	NUM_CHANNELS Constants and data.

Fields inherited from class org.lsst.ccs.drivers.auxelex.Srp

boardType, DEFAULT_PORT

Constructor Summary

Constructors

Constructor and Description
IonPump() Constructor

Method Summary

Modifier and Type	Method and Description
String[]	getChannelNames() Gets the array of channel names
int	getIlimitStatus() Gets the current limit status word
int	getPlimitStatus() Gets the power limit status word
int	getPoweredStatus() Gets the overall powered status
int	getVlimitStatus() Gets the voltage limit status word
boolean	isCurrentLimited(int chan) Gets whether channel is current limited
boolean	isCurrentLimited(String chan) Gets whether named channel is current limited
boolean	isPowered(int chan) Gets the powered state of a channel
boolean	isPowered(String chan) Gets the powered state of a named channel
boolean	isPowerLimited(int chan) Gets whether channel is power limited
boolean	isPowerLimited(String chan) Gets whether named channel is power limited
boolean	isVoltageLimited(int chan) Gets whether channel is voltage limited
boolean	isVoltageLimited(String chan) Gets whether named channel is voltage limited
void	powerOff(int chan) Powers off a channel.
void	powerOff(String chan) Powers off a named channel.
void	powerOn(int chan) Powers on a channel.
void	powerOn(String chan) Powers on a named channel.
double	readCurrent(int chan) Reads the current for a channel
double	readCurrent(String chan) Reads the current for a named channel
double	readPower(int chan) Reads the power for a channel
double	readPower(String chan) Reads the power for a named channel
double	readVoltage(int chan) Reads the voltage for a channel
double	readVoltage(String chan) Reads the voltage for a named channel
void	setCurrent(int chan, double value) Sets the current for a channel
void	setCurrent(String chan, double value) Sets the current for a named channel
void	setPower(int chan, double value) Sets the power for a channel
void	setPower(String chan, double value) Sets the power for a named channel
void	setVoltage(int chan, double value) Sets the voltage for a channel.
void	setVoltage(String chan, double value) Sets the voltage for a named channel.

Methods inherited from class org.lsst.ccs.drivers.auxelex.Srp

clearSimRegMap, close, getBoardType, getBuildStamp, getIpAddress, getNumSeqErr, getNumTimeout, getSimRegMap, isSimulated, open, open, open, open, putSimRegMap, readReg, readRegs, setDebug, setLogName, setSrpVersion, setValidBoardTypes, simInitialize, simReadRegs, simWriteRegs, updateReg, writeReg, writeRegs

Methods inherited from class java.lang.Object

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

Field Detail

CHAN_PUMP0

public static final int CHAN_PUMP0

Constants and data.

See Also:

Constant Field Values

CHAN_PUMP1

public static final int CHAN_PUMP1

Constants and data.

See Also:

Constant Field Values

CHAN_PUMP2

public static final int CHAN_PUMP2

Constants and data.

See Also:

Constant Field Values

CHAN_PUMP3

public static final int CHAN_PUMP3

Constants and data.

See Also:

Constant Field Values

CHAN_PUMP4

public static final int CHAN_PUMP4

Constants and data.

See Also:

Constant Field Values

CHAN_PUMP5

public static final int CHAN_PUMP5

Constants and data.

See Also:

Constant Field Values

CHAN_PUMP6

public static final int CHAN_PUMP6

Constants and data.

See Also:

Constant Field Values

CHAN_PUMP7

public static final int CHAN_PUMP7

Constants and data.

See Also:

Constant Field Values

CHAN_PUMP8

public static final int CHAN_PUMP8

Constants and data.

See Also:

Constant Field Values

NUM_CHANNELS

public static final int NUM_CHANNELS

Constants and data.

See Also:

Constant Field Values

Constructor Detail

IonPump

public IonPump()

Constructor

Method Detail

getChannelNames

public String[] getChannelNames()

Gets the array of channel names

Returns:

The array of channel names

powerOn

public void powerOn(int chan)
             throws org.lsst.ccs.drivers.commons.DriverException

Powers on a channel.

Parameters:

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

powerOn

public void powerOn(String chan)
             throws org.lsst.ccs.drivers.commons.DriverException

Powers on a named channel.

Parameters:

chan - The channel name

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

powerOff

public void powerOff(int chan)
              throws org.lsst.ccs.drivers.commons.DriverException

Powers off a channel.

Parameters:

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

powerOff

public void powerOff(String chan)
              throws org.lsst.ccs.drivers.commons.DriverException

Powers off a named channel.

Parameters:

chan - The channel name

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

isPowered

public boolean isPowered(int chan)
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the powered state of a channel

Parameters:

chan - The channel number

Returns:

Whether the channel is powered on

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

isPowered

public boolean isPowered(String chan)
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the powered state of a named channel

Parameters:

chan - The channel name

Returns:

Whether the channel is powered on

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

getPoweredStatus

public int getPoweredStatus()
                     throws org.lsst.ccs.drivers.commons.DriverException

Gets the overall powered status

Returns:

The channel control word

Throws:

org.lsst.ccs.drivers.commons.DriverException

isVoltageLimited

public boolean isVoltageLimited(int chan)
                         throws org.lsst.ccs.drivers.commons.DriverException

Gets whether channel is voltage limited

Parameters:

chan - The channel number

Returns:

Whether the channel is limited

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

isVoltageLimited

public boolean isVoltageLimited(String chan)
                         throws org.lsst.ccs.drivers.commons.DriverException

Gets whether named channel is voltage limited

Parameters:

chan - The channel name

Returns:

Whether the channel is limited

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

getVlimitStatus

public int getVlimitStatus()
                    throws org.lsst.ccs.drivers.commons.DriverException

Gets the voltage limit status word

Returns:

The limit status word

Throws:

org.lsst.ccs.drivers.commons.DriverException

isCurrentLimited

public boolean isCurrentLimited(int chan)
                         throws org.lsst.ccs.drivers.commons.DriverException

Gets whether channel is current limited

Parameters:

chan - The channel number

Returns:

Whether the channel is limited

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

isCurrentLimited

public boolean isCurrentLimited(String chan)
                         throws org.lsst.ccs.drivers.commons.DriverException

Gets whether named channel is current limited

Parameters:

chan - The channel name

Returns:

Whether the channel is limited

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

getIlimitStatus

public int getIlimitStatus()
                    throws org.lsst.ccs.drivers.commons.DriverException

Gets the current limit status word

Returns:

The limit status word

Throws:

org.lsst.ccs.drivers.commons.DriverException

isPowerLimited

public boolean isPowerLimited(int chan)
                       throws org.lsst.ccs.drivers.commons.DriverException

Gets whether channel is power limited

Parameters:

chan - The channel number

Returns:

Whether the channel is limited

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

isPowerLimited

public boolean isPowerLimited(String chan)
                       throws org.lsst.ccs.drivers.commons.DriverException

Gets whether named channel is power limited

Parameters:

chan - The channel name

Returns:

Whether the channel is limited

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

getPlimitStatus

public int getPlimitStatus()
                    throws org.lsst.ccs.drivers.commons.DriverException

Gets the power limit status word

Returns:

The limit status word

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltage

public void setVoltage(int chan,
                       double value)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage for a channel.

Parameters:

chan - The channel number

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

setVoltage

public void setVoltage(String chan,
                       double value)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage for a named channel.

Parameters:

chan - The channel name

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

setCurrent

public void setCurrent(int chan,
                       double value)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the current for a channel

Parameters:

chan - The channel number

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

setCurrent

public void setCurrent(String chan,
                       double value)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the current for a named channel

Parameters:

chan - The channel name

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

setPower

public void setPower(int chan,
                     double value)
              throws org.lsst.ccs.drivers.commons.DriverException

Sets the power for a channel

Parameters:

chan - The channel number

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

setPower

public void setPower(String chan,
                     double value)
              throws org.lsst.ccs.drivers.commons.DriverException

Sets the power for a named channel

Parameters:

chan - The channel name

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

readVoltage

public double readVoltage(int chan)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads the voltage for a channel

Parameters:

chan - The channel number

Returns:

The voltage on that channel

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

readVoltage

public double readVoltage(String chan)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads the voltage for a named channel

Parameters:

chan - The channel name

Returns:

The voltage on that channel

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

readCurrent

public double readCurrent(int chan)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads the current for a channel

Parameters:

chan - The channel number

Returns:

The current on that channel

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

readCurrent

public double readCurrent(String chan)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads the current for a named channel

Parameters:

chan - The channel name

Returns:

The current on that channel

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

readPower

public double readPower(int chan)
                 throws org.lsst.ccs.drivers.commons.DriverException

Reads the power for a channel

Parameters:

chan - The channel number

Returns:

The power on that channel

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

readPower

public double readPower(String chan)
                 throws org.lsst.ccs.drivers.commons.DriverException

Reads the power for a named channel

Parameters:

chan - The channel name

Returns:

The power on that channel

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid