org.lsst.ccs.subsystem.rafts

Class REBDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.rafts.REBDevice

All Implemented Interfaces:

org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.AlertHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle

public class REBDevice
extends org.lsst.ccs.monitor.Device
implements org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.config.ConfigurationBulkChangeHandler

Implements access to a REB device.

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	REBDevice.AdcData

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

org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode

Field Summary

Fields

Modifier and Type	Field and Description
protected CcdType	ccdType
static int	CHAN_HTR_POWER
static int	CHAN_HTR_VOLTS
static int	CHAN_RTD_INT_TEMP
static int	CHAN_RTD_INT_VOLT
static int	CHAN_TOTAL_POWER
protected int	configCcdMask
protected int	hdwTypeI
protected int	hwVersion
static int	NUM_HTR_CHANS
static int	NUM_RTD_CHANS
static String	RAFTS
static String	RAFTS_LIMITS
protected int	realCcdMask
static int	TYPE_ASP_TEMP
static int	TYPE_BD_POWER
static int	TYPE_BD_TEMP
static int	TYPE_BIAS_VOLT
static int	TYPE_CCD_CURR
static int	TYPE_CR_VOLT
static int	TYPE_HEATER
static int	TYPE_HV_SWITCH
static int	TYPE_RTD

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

chanMask, ctlChans, disabled, fullName, inited, lineMask, lineState, lineWarm, log, mon, name, online, s

Constructor Summary

Constructors

Constructor and Description
REBDevice()

Method Summary

Modifier and Type	Method and Description
void	build() Early initialization (build phase).
org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode	canClearAlert(org.lsst.ccs.bus.data.Alert alert) Clears an alert.
int	checkAspics() Checks loaded ASPIC configuration data.
protected int[]	checkChannel(String name, int hwChan, String type, String subtype) Checks a channel's parameters for validity.
void	clearBiasDacs() Clears bias DAC values.
void	clearDacs() Clears DAC values.
protected void	close() Closes the connection.
int	getCcdMask() Gets the mask of CCDs being used.
CcdType	getCcdType() Gets the CCD type.
int	getHdwType() Gets the hardware type.
int	getHwVersion() Gets the hardware version.
int	getId() Gets the REB ID.
String	getIfcName() Gets the network interface name.
ImageData	getImage(int offset, int count) Gets a portion of the current image.
ImageData	getImage(int ccd, int offset, int count) Gets a portion of the current image.
org.lsst.ccs.drivers.reb.ImageMetadata	getImageMetadata() Gets the DAQ metadata for the current image.
ImageProc	getImageProc() Gets the associated image processor.
int	getRaftNumber() Gets the raft number.
REB	getREBConfig() Gets the REB configuration data.
int	getRebNumber() Gets the REB number.
StatusData	getRebStatus() Gets the REB status block.
int	getRebType() Gets the REB type.
RegisterData	getRegister(int address, int count) Gets the contents of REB registers.
SequencerProc	getSequencer() Gets the associated sequencer.
long	getSerialNumber() Gets the serial number.
long	getTime() Gets the time base as Unix time.
long	getTime(String rSet)
protected void	initChannel(String name, int id, int hwChan, int type, int subtype) Initializes a channel (in this case only checks HW channel number).
protected void	initDevice() Performs basic initialization.
protected void	initialize() Performs full initialization.
boolean	isBackBiasOn() Gets the back bias on state.
boolean	isSerialNumValid() Gets whether the serial number is valid.
int	loadAspics(boolean all) Loads configuration data to the ASPICs.
int	loadBiasDacs(boolean all) Loads configured bias DAC values.
int	loadDacs(boolean all) Loads configured DAC values.
void	postStart()
void	powerCCDs(boolean on) Performs CCD power on/off sequences.
void	powerCCDsOff() Performs CCD power off sequence.
void	powerCCDsOn() Performs CCD power on sequence.
protected double	readChannel(int hwChan, int type) Reads a channel.
protected void	readChannelGroup() Reads grouped channels.
double	readChannelNow(int hwChan, int type) Reads a channel immediately.
double[]	readPowerAdcs() Reads the board power ADCs.
int	readSeqIdleState() Reads the sequencer idle state lines.
int	resetAspics() Resets the ASPICs.
void	resetFrontEnd() Resets the front end.
void	setAllAspicGain(int gain) Transversal setting of all Gains for the Aspics of this reb.
void	setAllAspicRc(int rc) Transversal setting of all Rcs for the Aspics of this reb.
void	setAllAspicTM(boolean tm) Transversal setting of all TM for the Aspics of this reb.
void	setBackBias(boolean value) Turns back bias on or off.
void	setCcdType(CcdType ccdType) Sets the CCD type.
void	setClientFactory(org.lsst.ccs.drivers.reb.ClientFactory factory) Sets the client factory.
void	setFitsConditions(String filter, double temperature, double wavelength) Sets the FITS file test conditions.
void	setHeater(int heater, double volts) Sets a heater voltage.
void	setHeaterPower(int heater, double power) Sets heater power.
protected void	setOnline(boolean online)
void	setREBConfig(REB reb) Sets the REB configuration data.
void	setRegister(int address, int[] values) Sets the contents of REB registers.
void	setTime() Sets the time base to the current system time.
void	simulateDisconnection() Simulate a disconnect
void	testCCDShorts() Performs CCD shorts test.
void	validateBulkChange(Map<String,Object> params) Validates configuration parameter change.
void	writeSeqIdleState(int value) Writes the sequencer idle state lines.

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

addChannel, addLine, checkHardware, checkHwLine, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getFullName, getName, getOutputLines, init, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, readSensors, setHwLine, setLine, setLineWarm, setOutputLines, testOnline

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.ClearAlertHandler

canClearAlert

Methods inherited from interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

setParameterBulk

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

checkStarted, checkStopped

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

postBuild, postInit, postShutdown, shutdown, start

Field Detail

RAFTS

public static final String RAFTS

See Also:

Constant Field Values

RAFTS_LIMITS

public static final String RAFTS_LIMITS

See Also:

Constant Field Values

TYPE_BD_TEMP

public static final int TYPE_BD_TEMP

See Also:

Constant Field Values

TYPE_BD_POWER

public static final int TYPE_BD_POWER

See Also:

Constant Field Values

TYPE_RTD

public static final int TYPE_RTD

See Also:

Constant Field Values

TYPE_ASP_TEMP

public static final int TYPE_ASP_TEMP

See Also:

Constant Field Values

TYPE_BIAS_VOLT

public static final int TYPE_BIAS_VOLT

See Also:

Constant Field Values

TYPE_CCD_CURR

public static final int TYPE_CCD_CURR

See Also:

Constant Field Values

TYPE_CR_VOLT

public static final int TYPE_CR_VOLT

See Also:

Constant Field Values

TYPE_HEATER

public static final int TYPE_HEATER

See Also:

Constant Field Values

TYPE_HV_SWITCH

public static final int TYPE_HV_SWITCH

See Also:

Constant Field Values

CHAN_TOTAL_POWER

public static final int CHAN_TOTAL_POWER

See Also:

Constant Field Values

CHAN_HTR_VOLTS

public static final int CHAN_HTR_VOLTS

See Also:

Constant Field Values

CHAN_HTR_POWER

public static final int CHAN_HTR_POWER

See Also:

Constant Field Values

NUM_HTR_CHANS

public static final int NUM_HTR_CHANS

See Also:

Constant Field Values

CHAN_RTD_INT_TEMP

public static final int CHAN_RTD_INT_TEMP

See Also:

Constant Field Values

CHAN_RTD_INT_VOLT

public static final int CHAN_RTD_INT_VOLT

See Also:

Constant Field Values

NUM_RTD_CHANS

public static final int NUM_RTD_CHANS

See Also:

Constant Field Values

ccdType

protected CcdType ccdType

hdwTypeI

protected int hdwTypeI

configCcdMask

protected int configCcdMask

realCcdMask

protected int realCcdMask

hwVersion

protected int hwVersion

Constructor Detail

REBDevice

public REBDevice()

Method Detail

build

public void build()

Early initialization (build phase).

Specified by:

build in interface org.lsst.ccs.framework.HasLifecycle

validateBulkChange

public void validateBulkChange(Map<String,Object> params)

Validates configuration parameter change.

Specified by:

validateBulkChange in interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

Parameters:

params - The map of configuration parameter values

getId

@Command(type=QUERY,
         description="Get the REB ID")
public int getId()

Gets the REB ID.

Returns:

The REB ID

getIfcName

@Command(type=QUERY,
         description="Get the network interface name")
public String getIfcName()

Gets the network interface name.

Returns:

The name of the network interface being used

getCcdMask

@Command(type=QUERY,
         description="Get the mask of CCDs being used")
public int getCcdMask()

Gets the mask of CCDs being used.

Returns:

The mask of active CCDs

setCcdType

public void setCcdType(CcdType ccdType)

Sets the CCD type.

Parameters:

ccdType - The CCD type

getCcdType

@Command(type=QUERY,
         description="Get the type of CCDs being used")
public CcdType getCcdType()

Gets the CCD type.

Returns:

The CCD type

setClientFactory

public void setClientFactory(org.lsst.ccs.drivers.reb.ClientFactory factory)

Sets the client factory.

Parameters:

factory - The client factory

getRebType

@Command(type=QUERY,
         description="Gets the REB type")
public int getRebType()

Gets the REB type.

Returns:

The REB type

getRebNumber

@Command(type=QUERY,
         description="Gets the REB number")
public int getRebNumber()

Gets the REB number.

Returns:

The REB number (0 - 2) within its raft

getRaftNumber

@Command(type=QUERY,
         description="Gets the raft number")
public int getRaftNumber()

Gets the raft number.

Returns:

The raft number (00 - 44) for the REB

getHdwType

@Command(type=QUERY,
         description="Gets the hardware type")
public int getHdwType()

Gets the hardware type.

Returns:

The hardware type

getHwVersion

@Command(type=QUERY,
         description="Get the hardware version")
public int getHwVersion()

Gets the hardware version.

Returns:

The hardware version, or 0 if the REB is not connected

getSerialNumber

@Command(type=QUERY,
         description="Get the serial number")
public long getSerialNumber()

Gets the serial number.

Returns:

The serial number, or 0 if the REB is not connected

isSerialNumValid

public boolean isSerialNumValid()

Gets whether the serial number is valid.

Returns:

The serial number validity

canClearAlert

public org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode canClearAlert(org.lsst.ccs.bus.data.Alert alert)

Clears an alert.

Specified by:

canClearAlert in interface org.lsst.ccs.framework.ClearAlertHandler

Parameters:

alert - The alert

Returns:

initDevice

protected void initDevice()

Performs basic initialization. Invoked when HasLifecycle::init is called on Device class. Checks that Groovy specifications are consistent

Overrides:

initDevice in class org.lsst.ccs.monitor.Device

initialize

protected void initialize()

Performs full initialization. Opens connection to the REB and obtains information about it

Specified by:

initialize in class org.lsst.ccs.monitor.Device

postStart

public void postStart()

Specified by:

postStart in interface org.lsst.ccs.framework.HasLifecycle

close

protected void close()

Closes the connection.

Specified by:

close in class org.lsst.ccs.monitor.Device

checkChannel

protected int[] checkChannel(String name,
                             int hwChan,
                             String type,
                             String subtype)
                      throws Exception

Checks a channel's parameters for validity.

Overrides:

checkChannel in class org.lsst.ccs.monitor.Device

Parameters:

name - The channel name

hwChan - The hardware channel

type - The channel type string

subtype - The channel subtype string

Returns:

Two-element array containing the encoded type [0] and subtype [1]

Throws:

Exception - If parameters are invalid

initChannel

protected void initChannel(String name,
                           int id,
                           int hwChan,
                           int type,
                           int subtype)

Initializes a channel (in this case only checks HW channel number).

Overrides:

initChannel in class org.lsst.ccs.monitor.Device

Parameters:

name - The channel name

id - The channel ID

hwChan - The hardware channel

type - The channel type

subtype - The channel subtype

readChannelGroup

protected void readChannelGroup()

Reads grouped channels.

Overrides:

readChannelGroup in class org.lsst.ccs.monitor.Device

readChannel

protected double readChannel(int hwChan,
                             int type)

Reads a channel.

Overrides:

readChannel in class org.lsst.ccs.monitor.Device

Parameters:

hwChan - The hardware channel number

type - The encoded channel type

Returns:

The read value

readChannelNow

public double readChannelNow(int hwChan,
                             int type)

Reads a channel immediately.

Overrides:

readChannelNow in class org.lsst.ccs.monitor.Device

Parameters:

hwChan - The hardware channel number

type - The encoded channel type

Returns:

The read value

readPowerAdcs

public double[] readPowerAdcs()
                       throws RaftException

Reads the board power ADCs.

Returns:

The array of board voltages and currents

Throws:

RaftException

readSeqIdleState

public int readSeqIdleState()
                     throws RaftException

Reads the sequencer idle state lines.

Returns:

The lines value

Throws:

RaftException

writeSeqIdleState

public void writeSeqIdleState(int value)
                       throws RaftException

Writes the sequencer idle state lines.

Parameters:

value - The lines value

Throws:

RaftException

setREBConfig

@Command(type=ACTION,
         description="Sets the REB configuration data")
public void setREBConfig(@Argument(name="reb",description="REB configuration data")
                                                                                                       REB reb)
                                                                                                throws RaftException

Sets the REB configuration data.

Parameters:

reb - The REB configuration (object)

Throws:

RaftException

getREBConfig

@Command(type=QUERY,
         description="Gets the REB configuration data")
public REB getREBConfig()

Gets the REB configuration data.

Returns:

The REB configuration (object)

setAllAspicTM

@Command(type=CONFIGURATION,
         description="Set TM for all ASPICs on this REB")
public void setAllAspicTM(boolean tm)

Transversal setting of all TM for the Aspics of this reb. It internally uses the configuration service.

Parameters:

tm - true for TM, false for normal

setAllAspicGain

@Command(type=CONFIGURATION,
         description="Set gain for all ASPICs on this REB")
public void setAllAspicGain(int gain)

Transversal setting of all Gains for the Aspics of this reb. It internally uses the configuration service.

Parameters:

gain - the new gain value

setAllAspicRc

@Command(type=CONFIGURATION,
         description="Set RC for all ASPICs on this REB")
public void setAllAspicRc(int rc)

Transversal setting of all Rcs for the Aspics of this reb. It internally uses the configuration service.

Parameters:

rc - the new rc value

powerCCDs

@Command(type=ACTION,
         description="Perform CCD power on/off sequence")
public void powerCCDs(@Argument(description="Whether to power on")
                                                                                                      boolean on)
                                                                                               throws RaftException

Performs CCD power on/off sequences.

Parameters:

on - Whether to power on (true) or off (false)

Throws:

RaftException

powerCCDsOn

@Command(type=ACTION,
         description="Perform CCD power on sequence")
public void powerCCDsOn()
                                                                                             throws RaftException

Performs CCD power on sequence.

Throws:

RaftException

powerCCDsOff

@Command(type=ACTION,
         description="Perform CCD power off sequence")
public void powerCCDsOff()
                                                                                               throws RaftException

Performs CCD power off sequence.

Throws:

RaftException

testCCDShorts

@Command(type=ACTION,
         description="Perform CCD shorts test")
public void testCCDShorts()
                                                                                         throws RaftException

Performs CCD shorts test.

Throws:

RaftException

loadDacs

@Command(type=ACTION,
         description="Loads configured DAC values")
public int loadDacs(@Argument(description="Whether all DACs are loaded, or only changed ones")
                                                                                              boolean all)
                                                                                       throws RaftException

Loads configured DAC values.

Parameters:

all - If true, all data are loaded; otherwise only changes

Returns:

The number of DACs loaded

Throws:

RaftException

clearDacs

@Command(type=ACTION,
         description="Clear DAC values")
public void clearDacs()
                                                                              throws RaftException

Clears DAC values.

Throws:

RaftException

loadBiasDacs

@Command(type=ACTION,
         description="Loads configured bias DAC values")
public int loadBiasDacs(@Argument(description="Whether all DACs are loaded, or only changed ones")
                                                                                                       boolean all)
                                                                                                throws RaftException

Loads configured bias DAC values.

Parameters:

all - If true, all data are loaded; otherwise only changes

Returns:

The number of bias DACs loaded

Throws:

RaftException

clearBiasDacs

@Command(type=ACTION,
         description="Clear bias DAC values")
public void clearBiasDacs()
                                                                                       throws RaftException

Clears bias DAC values.

Throws:

RaftException

loadAspics

@Command(type=ACTION,
         description="Load configuration data to the ASPICs")
public int loadAspics(boolean all)
                                                                                                   throws Exception

Loads configuration data to the ASPICs.

Parameters:

all - If true, all data are loaded; otherwise only changes

Returns:

The number of ASPICs loaded

Throws:

Exception

resetAspics

@Command(type=ACTION,
         description="Reset the ASPICs")
public int resetAspics()
                                                                               throws Exception

Resets the ASPICs.

Returns:

The number of ASPICs reset

Throws:

Exception

checkAspics

@Command(type=ACTION,
         description="Check loaded ASPIC configuration")
public int checkAspics()
                                                                                               throws Exception

Checks loaded ASPIC configuration data.

Returns:

The mask of mismatched fields

Throws:

Exception

isBackBiasOn

@Command(type=QUERY,
         description="Get the back bias on state")
public boolean isBackBiasOn()
                                                                                             throws RaftException

Gets the back bias on state.

Returns:

Whether back bias is turned on

Throws:

RaftException

setBackBias

@Command(type=ACTION,
         description="Turn back bias on or off")
public void setBackBias(@Argument(description="The on state")
                                                                                               boolean value)
                                                                                        throws RaftException

Turns back bias on or off.

Parameters:

value - The back bias on state to set (true or false)

Throws:

RaftException

setHeater

@Command(type=ACTION,
         description="Set heater voltage")
public void setHeater(@Argument(description="Heater number")
                                                                                       int heater,
                                                                                       @Argument(description="The voltage")
                                                                                       double volts)
                                                                                throws RaftException

Sets a heater voltage.

Parameters:

heater - The heater number: 0 or 1

volts - The voltage to set

Throws:

RaftException

setHeaterPower

@Command(type=ACTION,
         description="Set heater power")
public void setHeaterPower(@Argument(description="Heater number")
                                                                                          int heater,
                                                                                          @Argument(description="The power value")
                                                                                          double power)
                                                                                   throws RaftException

Sets heater power.

Parameters:

heater - The heater number: 0 or 1

power - The power value to set

Throws:

RaftException

setTime

@Command(type=ACTION,
         description="Sets the time base to the current system time")
public void setTime()
                                                                                                         throws RaftException

Sets the time base to the current system time.

Throws:

RaftException

getTime

@Command(type=QUERY,
         description="Gets the time base as Unix time")
public long getTime()
                                                                                          throws RaftException

Gets the time base as Unix time.

Returns:

The time base converted to Unix time

Throws:

RaftException

getTime

@Command(type=QUERY,
         description="Gets a trigger time as Unix time")
public long getTime(@Argument(name="regset",description="Register set name")
                                                                                                  String rSet)
                                                                                           throws RaftException

Throws:

RaftException

setFitsConditions

@Command(type=ACTION,
         description="Sets the FITS file test conditions")
public void setFitsConditions(@Argument(description="Filter name")
                                                                                                               String filter,
                                                                                                               @Argument(description="The temperature")
                                                                                                               double temperature,
                                                                                                               @Argument(description="The wavelength")
                                                                                                               double wavelength)

Sets the FITS file test conditions.

Parameters:

filter - The filter name

temperature - The temperature set point

wavelength - The monochromator wavelength

getImageMetadata

@Command(type=QUERY,
         description="Get the DAQ metadata for the current image")
public org.lsst.ccs.drivers.reb.ImageMetadata getImageMetadata()
                                                                                                                                                throws RaftException

Gets the DAQ metadata for the current image.

Returns:

The image metadata

Throws:

RaftException

getImage

@Command(type=QUERY,
         description="Gets a portion of the current image")
public ImageData getImage(@Argument(description="Offset to the pixel data")
                                                                                                           int offset,
                                                                                                           @Argument(description="Number of pixels")
                                                                                                           int count)
                                                                                                    throws RaftException

Gets a portion of the current image.

Parameters:

offset - The offset (in pixels) to the first pixel data to obtain.

count - The number of data pixels to obtain. If zero, all the data, starting at offset, is obtained.

Returns:

The returned pixel data

Throws:

RaftException

getImage

@Command(type=QUERY,
         description="Gets a portion of the current image")
public ImageData getImage(@Argument(description="CCD number")
                                                                                                           int ccd,
                                                                                                           @Argument(description="Offset to the pixel data")
                                                                                                           int offset,
                                                                                                           @Argument(description="Number of pixels")
                                                                                                           int count)
                                                                                                    throws RaftException

Gets a portion of the current image.

Parameters:

ccd - The CCD number

offset - The offset (in pixels) to the first pixel data to obtain.

count - The number of data pixels to obtain. If zero, all the data, starting at offset, is obtained.

Returns:

The returned pixel data

Throws:

RaftException

resetFrontEnd

@Command(type=ACTION,
         description="Resets the front end")
public void resetFrontEnd()
                                                                                      throws RaftException

Resets the front end. This is the only way to stop a running sequencer program

Throws:

RaftException

getRegister

@Command(type=QUERY,
         description="Gets the contents of REB registers")
public RegisterData getRegister(@Argument(description="Address of the first register")
                                                                                                                int address,
                                                                                                                @Argument(description="Number of registers to read")
                                                                                                                int count)
                                                                                                         throws RaftException

Gets the contents of REB registers.

Parameters:

address - The address of the first register to read

count - The number of registers to read

Returns:

The block of register values

Throws:

RaftException

setRegister

@Command(type=ACTION,
         description="Sets the contents of REB registers")
public void setRegister(@Argument(description="Address of the first register")
                                                                                                         int address,
                                                                                                         @Argument(description="Values to write")
                                                                                                         int[] values)
                                                                                                  throws RaftException

Sets the contents of REB registers.

Parameters:

address - The address of the first register to write

values - The array of values to write to consecutive registers

Throws:

RaftException

getRebStatus

@Command(type=QUERY,
         description="Gets the REB status block")
public StatusData getRebStatus()
                                                                                               throws RaftException

Gets the REB status block.

Returns:

The REB status block

Throws:

RaftException

getImageProc

public ImageProc getImageProc()

Gets the associated image processor.

Returns:

The image

getSequencer

public SequencerProc getSequencer()

Gets the associated sequencer.

Returns:

The sequencer

simulateDisconnection

@Command(simulation=true)
public void simulateDisconnection()

Simulate a disconnect

setOnline

protected void setOnline(boolean online)

Overrides:

setOnline in class org.lsst.ccs.monitor.Device