org.lsst.ccs.subsystem.rafts

Class REBDevice

java.lang.Object

org.lsst.ccs.framework.ConfigurableComponent

org.lsst.ccs.subsystem.monitor.Device

org.lsst.ccs.subsystem.rafts.REBDevice

All Implemented Interfaces:

org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.UsesSubsystem

public class REBDevice
extends org.lsst.ccs.subsystem.monitor.Device

Implements access to a REB 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 String	CCD_MASK
protected int	ccdMask
protected int	configCcdMask
protected int	hdwTypeI
protected int	hwVersion
protected int	id
protected static String	ID
protected static String	IFC_NAME
protected String	ifcName
protected int	maxCcdMask
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_RTD

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

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

Constructor Summary

Constructors

Constructor and Description
REBDevice() No-argument constructor.
REBDevice(int id, String ifcName, int ccdMask) Constructor.
REBDevice(String hdwType, int id, String ifcName, int ccdMask) Constructor.
REBDevice(String hdwType, int id, String ifcName, int ccdMask, org.lsst.ccs.drivers.reb.ClientFactory clientFactory) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addConfigValues(Map<String,Object> values) Adds to the map of configured values.
int	checkAspics() Checks loaded ASPIC configuration data.
List<Integer>	checkCabacs() Checks loaded CABAC 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.
protected void	configure(org.lsst.ccs.subsystem.monitor.Monitor mon) Performs configuration.
int	getCabacPower() Gets the CABAC power enable bits.
int	getCcdMask() Gets the mask of CCDs being used.
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.
org.lsst.ccs.drivers.reb.ImageMetadata	getImageMetadata() Gets the DAQ metadata for the current image.
ImageProc	getImageProc() Gets the associated image processor.
REB	getREBConfig() Gets the REB configuration data.
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	initialize() Performs basic initialization.
boolean	isBackBiasOn() Gets the back bias on state.
int	loadAspics(boolean all) Loads configuration data to the ASPICs.
int	loadBiasDacs(boolean all) Loads configured bias DAC values.
int	loadCabacs() Loads configuration data to the CABACs in a safe way.
int	loadDacs(boolean all) Loads configured DAC values.
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.
void	resetFrontEnd() Resets the front end.
void	setBackBias(boolean value) Turns back bias on or off.
void	setCabacPower(int enables) Sets the CABAC power enable bits.
void	setCcdMask(int ccdMask) Sets the mask of CCDs being used.
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	setFitsFileNamePatter(String fitsFileNamePattern) Deprecated.
void	setHeater(int heater, double volts)
void	setId(int id) Sets the REB ID.
void	setIfcName(String ifcName) Sets the network interface name.
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.

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

addChannel, addLine, checkHwLine, checkLine, checkOnline, checkTimeout, disable, dropChannel, enable, getConfigValues, getFullName, getOutputLines, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readSensors, setHwLine, setLine, setLineWarm, setOnline, 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.Configurable

change, dropSubmittedChanges, getChildren, getComponentByName, getEnvironment, getParent, getParentObject, getSubmittedChanges, init, isParameterConfigurable, postStart, printConfigurableParameters, setBulkParameter, shutdownNow, start, submitChange, submitChanges, validateBulkChange

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

setParameterBulk

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

Field Detail

ID

protected static final String ID

See Also:

Constant Field Values

IFC_NAME

protected static final String IFC_NAME

See Also:

Constant Field Values

CCD_MASK

protected static final String CCD_MASK

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

id

@ConfigurationParameter(name="id",
                        category="Rafts")
protected int id

ccdMask

@ConfigurationParameter(name="ccdMask",
                        category="Rafts")
protected int ccdMask

ifcName

@ConfigurationParameter(name="ifcName",
                        category="Rafts")
protected String ifcName

hdwTypeI

protected int hdwTypeI

configCcdMask

protected int configCcdMask

maxCcdMask

protected int maxCcdMask

hwVersion

protected int hwVersion

Constructor Detail

REBDevice

public REBDevice()

No-argument constructor.

REBDevice

public REBDevice(int id,
                 String ifcName,
                 int ccdMask)

Constructor.

Parameters:

id - The REB ID

ifcName - The name of the network interface to use

ccdMask - The mask of active CCDs

REBDevice

public REBDevice(String hdwType,
                 int id,
                 String ifcName,
                 int ccdMask)

Constructor.

Parameters:

hdwType - The hardware type (DAQ0, DAQ1 or PCI)

id - The REB ID

ifcName - The name of the network interface to use

ccdMask - The mask of active CCDs

REBDevice

public REBDevice(String hdwType,
                 int id,
                 String ifcName,
                 int ccdMask,
                 org.lsst.ccs.drivers.reb.ClientFactory clientFactory)

Constructor.

Parameters:

hdwType - The hardware type (DAQ0, DAQ1 or PCI)

id - The REB ID

ifcName - The name of the network interface to use

ccdMask - The mask of active CCDs

clientFactory - The client factory for this RebDevice. It is used to inject simulation.

Method Detail

setId

@ConfigurationParameterChanger
public void setId(int id)

Sets the REB ID.

Parameters:

id - The REB ID

getId

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

Gets the REB ID.

Returns:

The REB ID

setIfcName

@ConfigurationParameterChanger
public void setIfcName(String ifcName)

Sets the network interface name.

Parameters:

ifcName - The name of the network interface to use

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

setCcdMask

@ConfigurationParameterChanger
public void setCcdMask(int ccdMask)

Sets the mask of CCDs being used.

Parameters:

ccdMask - The mask of active CCDs

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

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

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

getSerialNumber

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

Gets the serial number.

Returns:

The serial number

configure

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

Performs configuration.

Overrides:

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

Parameters:

mon - The monitor object

initialize

protected void initialize()

Performs basic initialization.

Specified by:

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

close

protected void close()

Closes the connection.

Specified by:

close in class org.lsst.ccs.subsystem.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.subsystem.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.subsystem.monitor.Device

Parameters:

name - The channel name

id - The channel ID

hwChan - The hardware channel

type - The channel type string

subtype - The channel subtype string

readChannelGroup

protected void readChannelGroup()

Reads grouped channels.

Overrides:

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

readChannel

protected double readChannel(int hwChan,
                             int type)

Reads a channel.

Overrides:

readChannel in class org.lsst.ccs.subsystem.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.subsystem.monitor.Device

Parameters:

hwChan - The hardware channel number

type - The encoded channel type

Returns:

The read value

setREBConfig

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

Sets the REB configuration data.

Parameters:

reb - The REB configuration (object)

getREBConfig

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

Gets the REB configuration data.

Returns:

The REB configuration (object)

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

Parameters:

values - Map to be added to

loadDacs

@Command(type=ACTION,
         description="Loads configured DAC values")
public int loadDacs(boolean all)
                                                                                       throws Exception

Loads configured DAC values.

Parameters:

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

Returns:

The number of DACs loaded

Throws:

Exception

clearDacs

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

Clears DAC values.

Throws:

Exception

loadBiasDacs

@Command(type=ACTION,
         description="Loads configured bias DAC values")
public int loadBiasDacs(boolean all)
                                                                                                throws Exception

Loads configured bias DAC values.

Parameters:

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

Returns:

The number of bias DACs loaded

Throws:

Exception

clearBiasDacs

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

Clears bias DAC values.

Throws:

Exception

loadCabacs

@Command(type=ACTION,
         description=" Loads configuration data to the CABACs")
public int loadCabacs()
                                                                                                     throws Exception

Loads configuration data to the CABACs in a safe way.

Returns:

The number of CABACs loaded

Throws:

Exception

checkCabacs

@Command(type=QUERY,
         description="Checks loaded CABAC configuration data")
public List<Integer> checkCabacs()
                                                                                                              throws Exception

Checks loaded CABAC configuration data.

Returns:

A list containing, for each configured CABAC, a mask showing which fields don't match

Throws:

Exception

setCabacPower

@Command(type=ACTION,
         description="Sets the CABAC power enable bits")
public void setCabacPower(@Argument(description="Enable bits")
                                                                                                         int enables)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Sets the CABAC power enable bits.

Parameters:

enables - The enable bits

Throws:

org.lsst.ccs.drivers.commons.DriverException

getCabacPower

@Command(type=QUERY,
         description="Gets the CABAC power enable bits")
public int getCabacPower()

Gets the CABAC power enable bits.

Returns:

The enable bits

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

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 Exception

Gets the back bias on state.

Returns:

Whether back bias is turned on

Throws:

Exception

setBackBias

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

Turns back bias on or off.

Parameters:

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

Throws:

Exception

setHeater

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

Throws:

Exception

setTime

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

Sets the time base to the current system time.

Throws:

Exception

getTime

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

Gets the time base as Unix time.

Returns:

The time base converted to Unix time

Throws:

Exception

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 Exception

Throws:

Exception

setFitsConditions

@Command(type=ACTION,
         description="Sets the FITS file test conditions")
public void setFitsConditions(String filter,
                                                                                                               double temperature,
                                                                                                               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(name="offset",description="Offset to the pixel data")
                                                                                                           int offset,
                                                                                                           @Argument(name="count",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

resetFrontEnd

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

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

Throws:

Exception

getRegister

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

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:

Exception

setRegister

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

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:

Exception

getRebStatus

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

Gets the REB status block.

Returns:

The REB status block

Throws:

Exception

getImageProc

public ImageProc getImageProc()

Gets the associated image processor.

Returns:

The image

getSequencer

public SequencerProc getSequencer()

Gets the associated sequencer.

Returns:

The sequencer

setFitsFileNamePatter

@Deprecated
public void setFitsFileNamePatter(String fitsFileNamePattern)

Deprecated.

Setter method for the fits file name pattern.

Parameters:

fitsFileNamePattern - The fileName pattern to be used when writing out fits files.