org.lsst.ccs.drivers.auxelex

Class BfrPathFinder

java.lang.Object

org.lsst.ccs.drivers.auxelex.Srp

org.lsst.ccs.drivers.auxelex.BfrPathFinder

public class BfrPathFinder
extends Srp

Routines for controlling the power breaker-filter-relay board (BFR)

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BfrPathFinder.CurrentType

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	NUM_RELAYS Constants and data.
static int	NUM_SENSORS
static int	RELAY_HTR_1 Constants and data.
static int	RELAY_HTR_2 Constants and data.
static int	RELAY_PWS_16 Constants and data.
static int	RELAY_PWS_17 Constants and data.
static int	RELAY_PWS_18 Constants and data.
static int	RELAY_PWS_19 Constants and data.
static int	RELAY_PWS_2 Constants and data.
static int	RELAY_PWS_20 Constants and data.
static int	RELAY_PWS_21 Constants and data.
static int	RELAY_PWS_25 Constants and data.
static int	RELAY_PWS_3 Constants and data.
static int	RELAY_PWS_4 Constants and data.
static int	SENSOR_HTRS
static int	SENSOR_PROT
static int	SENSOR_PWS_1
static int	SENSOR_PWS_16
static int	SENSOR_PWS_17
static int	SENSOR_PWS_18
static int	SENSOR_PWS_19
static int	SENSOR_PWS_20_21
static int	SENSOR_PWS_25
static int	SENSOR_PWS_3
static int	SENSOR_PWS_4

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

boardType, DEFAULT_PORT

Constructor Summary

Constructors

Constructor and Description
BfrPathFinder() Constructor

Method Summary

Modifier and Type	Method and Description
static String[]	getRelayNames() Gets the names of the relays
boolean[]	isRelayOn() Gets the state of all relays
boolean	isRelayOn(int relay) Gets the state of a relay by number
boolean	isRelayOn(String relay) Gets the state of a relay by name
double[]	readCurrent(BfrPathFinder.CurrentType type) Reads all instantaneous current values.
double	readCurrent(BfrPathFinder.CurrentType type, int sensor) Reads an instantaneous current value.
double[]	readCurrent(BfrPathFinder.CurrentType type, int sensor, int count) Reads a range of instantaneous current values.
double[]	readHeldCurrent(BfrPathFinder.CurrentType type) Reads all held current values.
double	readHeldCurrent(BfrPathFinder.CurrentType type, int sensor) Reads a held current value.
double[]	readHeldCurrent(BfrPathFinder.CurrentType type, int sensor, int count) Reads a range of held current values.
double[]	readMaxCurrent(BfrPathFinder.CurrentType type) Reads all maximum current values.
double	readMaxCurrent(BfrPathFinder.CurrentType type, int sensor) Reads a maximum current value.
double[]	readMaxCurrent(BfrPathFinder.CurrentType type, int sensor, int count) Reads a range of maximum current values.
double[]	readMinCurrent(BfrPathFinder.CurrentType type) Reads all minimum current values.
double	readMinCurrent(BfrPathFinder.CurrentType type, int sensor) Reads a minimum current value.
double[]	readMinCurrent(BfrPathFinder.CurrentType type, int sensor, int count) Reads a range of minimum current values.
void	resetExtrema() Resets all minimum and maximum values
void	setRelayOff() Turns off all relays
void	setRelayOff(int... relays) Turns off several relays by number
void	setRelayOff(int relay) Turns off a relay by number
void	setRelayOff(String... relays) Turns off several relays by name
void	setRelayOff(String relay) Turns off a relay by name
void	setRelayOn() Turns on all relays
void	setRelayOn(int... relays) Turns on several relays by number
void	setRelayOn(int relay) Turns on a relay by number
void	setRelayOn(String... relays) Turns on several relays by name
void	setRelayOn(String relay) Turns on a relay by name
protected void	simInitialize() Initializes the simulation.
protected void	simWriteRegs(int addr, int[] value, int count) Writes simulated registers.
void	triggerHold() Triggers a hold operation

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, simReadRegs, updateReg, writeReg, writeRegs

Methods inherited from class java.lang.Object

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

Field Detail

RELAY_HTR_1

public static final int RELAY_HTR_1

Constants and data.

See Also:

Constant Field Values

RELAY_HTR_2

public static final int RELAY_HTR_2

Constants and data.

See Also:

Constant Field Values

RELAY_PWS_2

public static final int RELAY_PWS_2

Constants and data.

See Also:

Constant Field Values

RELAY_PWS_3

public static final int RELAY_PWS_3

Constants and data.

See Also:

Constant Field Values

RELAY_PWS_4

public static final int RELAY_PWS_4

Constants and data.

See Also:

Constant Field Values

RELAY_PWS_16

public static final int RELAY_PWS_16

Constants and data.

See Also:

Constant Field Values

RELAY_PWS_17

public static final int RELAY_PWS_17

Constants and data.

See Also:

Constant Field Values

RELAY_PWS_18

public static final int RELAY_PWS_18

Constants and data.

See Also:

Constant Field Values

RELAY_PWS_19

public static final int RELAY_PWS_19

Constants and data.

See Also:

Constant Field Values

RELAY_PWS_25

public static final int RELAY_PWS_25

Constants and data.

See Also:

Constant Field Values

RELAY_PWS_20

public static final int RELAY_PWS_20

Constants and data.

See Also:

Constant Field Values

RELAY_PWS_21

public static final int RELAY_PWS_21

Constants and data.

See Also:

Constant Field Values

NUM_RELAYS

public static final int NUM_RELAYS

Constants and data.

See Also:

Constant Field Values

SENSOR_HTRS

public static final int SENSOR_HTRS

See Also:

Constant Field Values

SENSOR_PWS_1

public static final int SENSOR_PWS_1

See Also:

Constant Field Values

SENSOR_PWS_3

public static final int SENSOR_PWS_3

See Also:

Constant Field Values

SENSOR_PWS_4

public static final int SENSOR_PWS_4

See Also:

Constant Field Values

SENSOR_PWS_16

public static final int SENSOR_PWS_16

See Also:

Constant Field Values

SENSOR_PWS_17

public static final int SENSOR_PWS_17

See Also:

Constant Field Values

SENSOR_PWS_18

public static final int SENSOR_PWS_18

See Also:

Constant Field Values

SENSOR_PWS_19

public static final int SENSOR_PWS_19

See Also:

Constant Field Values

SENSOR_PWS_25

public static final int SENSOR_PWS_25

See Also:

Constant Field Values

SENSOR_PWS_20_21

public static final int SENSOR_PWS_20_21

See Also:

Constant Field Values

SENSOR_PROT

public static final int SENSOR_PROT

See Also:

Constant Field Values

NUM_SENSORS

public static final int NUM_SENSORS

See Also:

Constant Field Values

Constructor Detail

BfrPathFinder

public BfrPathFinder()

Constructor

Method Detail

setRelayOn

public void setRelayOn(int relay)
                throws org.lsst.ccs.drivers.commons.DriverException

Turns on a relay by number

Parameters:

relay - The relay number (0 - 11)

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the relay number is out of bounds

setRelayOn

public void setRelayOn(String relay)
                throws org.lsst.ccs.drivers.commons.DriverException

Turns on a relay by name

Parameters:

relay - The relay name

Throws:

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

setRelayOn

public void setRelayOn(int... relays)
                throws org.lsst.ccs.drivers.commons.DriverException

Turns on several relays by number

Parameters:

relays - An arg list or array of relay numbers (0 - 11)

Throws:

org.lsst.ccs.drivers.commons.DriverException - if any relay number is out of bounds

setRelayOn

public void setRelayOn(String... relays)
                throws org.lsst.ccs.drivers.commons.DriverException

Turns on several relays by name

Parameters:

relays - An arg list or array of relay names

Throws:

org.lsst.ccs.drivers.commons.DriverException - if any relay name is invalid

setRelayOn

public void setRelayOn()
                throws org.lsst.ccs.drivers.commons.DriverException

Turns on all relays

Throws:

org.lsst.ccs.drivers.commons.DriverException - if any relay number is out of bounds

setRelayOff

public void setRelayOff(int relay)
                 throws org.lsst.ccs.drivers.commons.DriverException

Turns off a relay by number

Parameters:

relay - The relay number (0 - 11)

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the relay number is out of bounds

setRelayOff

public void setRelayOff(String relay)
                 throws org.lsst.ccs.drivers.commons.DriverException

Turns off a relay by name

Parameters:

relay - The relay name

Throws:

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

setRelayOff

public void setRelayOff(int... relays)
                 throws org.lsst.ccs.drivers.commons.DriverException

Turns off several relays by number

Parameters:

relays - An arg list or array of relay numbers (0 - 11)

Throws:

org.lsst.ccs.drivers.commons.DriverException - if any relay number is out of bounds

setRelayOff

public void setRelayOff(String... relays)
                 throws org.lsst.ccs.drivers.commons.DriverException

Turns off several relays by name

Parameters:

relays - An arg list or array of relay names

Throws:

org.lsst.ccs.drivers.commons.DriverException - if any relay name is invalid

setRelayOff

public void setRelayOff()
                 throws org.lsst.ccs.drivers.commons.DriverException

Turns off all relays

Throws:

org.lsst.ccs.drivers.commons.DriverException

isRelayOn

public boolean isRelayOn(int relay)
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the state of a relay by number

Parameters:

relay - The relay number (0 - 11)

Returns:

Whether the relay is on

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the relay number is out of bounds

isRelayOn

public boolean isRelayOn(String relay)
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the state of a relay by name

Parameters:

relay - The relay name

Returns:

Whether the relay is on

Throws:

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

isRelayOn

public boolean[] isRelayOn()
                    throws org.lsst.ccs.drivers.commons.DriverException

Gets the state of all relays

Returns:

12-element boolean array of relay states

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

public double[] readCurrent(BfrPathFinder.CurrentType type,
                            int sensor,
                            int count)
                     throws org.lsst.ccs.drivers.commons.DriverException

Reads a range of instantaneous current values.

Parameters:

type - The type of current (RMS, AC, DC)

sensor - The first sensor number (0 - 10)

count - The number of sensors to read

Returns:

An array of current values

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

public double readCurrent(BfrPathFinder.CurrentType type,
                          int sensor)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads an instantaneous current value.

Parameters:

type - The type of current (RMS, AC, DC)

sensor - The sensor number (0 - 10)

Returns:

The current value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

public double[] readCurrent(BfrPathFinder.CurrentType type)
                     throws org.lsst.ccs.drivers.commons.DriverException

Reads all instantaneous current values.

Parameters:

type - The type of current (RMS, AC, DC)

Returns:

The current value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readMinCurrent

public double[] readMinCurrent(BfrPathFinder.CurrentType type,
                               int sensor,
                               int count)
                        throws org.lsst.ccs.drivers.commons.DriverException

Reads a range of minimum current values.

Parameters:

type - The type of current (RMS, AC, DC)

sensor - The first sensor number (0 - 10)

count - The number of sensors to read

Returns:

An array of current values

Throws:

org.lsst.ccs.drivers.commons.DriverException

readMinCurrent

public double readMinCurrent(BfrPathFinder.CurrentType type,
                             int sensor)
                      throws org.lsst.ccs.drivers.commons.DriverException

Reads a minimum current value.

Parameters:

type - The type of current (RMS, AC, DC)

sensor - The sensor number (0 - 10)

Returns:

The current value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readMinCurrent

public double[] readMinCurrent(BfrPathFinder.CurrentType type)
                        throws org.lsst.ccs.drivers.commons.DriverException

Reads all minimum current values.

Parameters:

type - The type of current (RMS, AC, DC)

Returns:

The current value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readMaxCurrent

public double[] readMaxCurrent(BfrPathFinder.CurrentType type,
                               int sensor,
                               int count)
                        throws org.lsst.ccs.drivers.commons.DriverException

Reads a range of maximum current values.

Parameters:

type - The type of current (RMS, AC, DC)

sensor - The first sensor number (0 - 10)

count - The number of sensors to read

Returns:

An array of current values

Throws:

org.lsst.ccs.drivers.commons.DriverException

readMaxCurrent

public double readMaxCurrent(BfrPathFinder.CurrentType type,
                             int sensor)
                      throws org.lsst.ccs.drivers.commons.DriverException

Reads a maximum current value.

Parameters:

type - The type of current (RMS, AC, DC)

sensor - The sensor number (0 - 10)

Returns:

The current value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readMaxCurrent

public double[] readMaxCurrent(BfrPathFinder.CurrentType type)
                        throws org.lsst.ccs.drivers.commons.DriverException

Reads all maximum current values.

Parameters:

type - The type of current (RMS, AC, DC)

Returns:

The current value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readHeldCurrent

public double[] readHeldCurrent(BfrPathFinder.CurrentType type,
                                int sensor,
                                int count)
                         throws org.lsst.ccs.drivers.commons.DriverException

Reads a range of held current values.

Parameters:

type - The type of current (RMS, AC, DC)

sensor - The first sensor number (0 - 10)

count - The number of sensors to read

Returns:

An array of current values

Throws:

org.lsst.ccs.drivers.commons.DriverException

readHeldCurrent

public double readHeldCurrent(BfrPathFinder.CurrentType type,
                              int sensor)
                       throws org.lsst.ccs.drivers.commons.DriverException

Reads a held current value.

Parameters:

type - The type of current (RMS, AC, DC)

sensor - The sensor number (0 - 10)

Returns:

The current value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readHeldCurrent

public double[] readHeldCurrent(BfrPathFinder.CurrentType type)
                         throws org.lsst.ccs.drivers.commons.DriverException

Reads all held current values.

Parameters:

type - The type of current (RMS, AC, DC)

Returns:

The current value

Throws:

org.lsst.ccs.drivers.commons.DriverException

resetExtrema

public void resetExtrema()
                  throws org.lsst.ccs.drivers.commons.DriverException

Resets all minimum and maximum values

Throws:

org.lsst.ccs.drivers.commons.DriverException

triggerHold

public void triggerHold()
                 throws org.lsst.ccs.drivers.commons.DriverException

Triggers a hold operation

Throws:

org.lsst.ccs.drivers.commons.DriverException

getRelayNames

public static String[] getRelayNames()
                              throws org.lsst.ccs.drivers.commons.DriverException

Gets the names of the relays

Returns:

12-element string array of relay names, in number order

Throws:

org.lsst.ccs.drivers.commons.DriverException

simInitialize

protected void simInitialize()

Initializes the simulation.

Overrides:

simInitialize in class Srp

simWriteRegs

protected void simWriteRegs(int addr,
                            int[] value,
                            int count)

Writes simulated registers.

Overrides:

simWriteRegs in class Srp

Parameters:

addr - The first register address

value - The array of values to write.

count - The number of values to write.