BoardDacs (LSST CCS - REB Driver 2.5.1 API)

java.lang.Object
- org.lsst.ccs.drivers.reb.BoardDacs

```
public class BoardDacs
extends Object
```
Routines for setting the on-board DACs.

Author:

Owen Saxton

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CHAN_CSGATE` Public constants
`static int`	`CHAN_CSGATE_1` Public constants
`static int`	`CHAN_CSGATE_2` Public constants
`static int`	`CHAN_CSGATE_3` Public constants
`static int`	`CHAN_GD` Public constants
`static int`	`CHAN_HEATER` Public constants
`static int`	`CHAN_HEATER_1` Public constants
`static int`	`CHAN_HEATER_2` Public constants
`static int`	`CHAN_OD` Public constants
`static int`	`CHAN_OG` Public constants
`static int`	`CHAN_OG_SH` Public constants
`static int`	`CHAN_PCLK_H` Public constants
`static int`	`CHAN_PCLK_H_SH` Public constants
`static int`	`CHAN_PCLK_L` Public constants
`static int`	`CHAN_PCLK_L_SH` Public constants
`static int`	`CHAN_RD` Public constants
`static int`	`CHAN_RG_H` Public constants
`static int`	`CHAN_RG_H_SH` Public constants
`static int`	`CHAN_RG_L` Public constants
`static int`	`CHAN_RG_L_SH` Public constants
`static int`	`CHAN_SCLK_H` Public constants
`static int`	`CHAN_SCLK_H_SH` Public constants
`static int`	`CHAN_SCLK_L` Public constants
`static int`	`CHAN_SCLK_L_SH` Public constants
`static int`	`DAC_BIAS_GATE` Public constants
`static int`	`DAC_CABAC_ALT` Public constants
`static int`	`DAC_CLOCK_RAILS` Public constants
`static int`	`DAC_CS_GATE` Public constants
`static int`	`DAC_HAS_STRIP` Public constants
`static int`	`DAC_HEATER` Public constants
`static int`	`DACS_LOAD` Public constants
`static int`	`DACS_SET` Public constants
`static int`	`ERROR_MASK_GD` Public constants
`static int`	`ERROR_MASK_OD` Public constants
`static int`	`ERROR_MASK_RD` Public constants
`static int`	`ERROR_MASK_SIZE` Public constants
`static int`	`INC_STRIPS` Public constants
`static int`	`OFF_BIAS_ERROR` Public constants
`static int`	`OFF_BIAS_GATE` Public constants
`static int`	`OFF_CABAC_ALT` Public constants
`static int`	`OFF_CLOCK_RAILS` Public constants
`static int`	`OFF_CS_GATE` Public constants
`static int`	`OFF_HEATER` Public constants
`static int`	`REG_BOARD_DACS` Public constants
`static int`	`REG_BOARD_DACS_0` Public constants
`static int`	`VERSION_GREB1` Public constants
`static int`	`VERSION_GREB2` Public constants
`static int`	`VERSION_REB0_0` Public constants
`static int`	`VERSION_REB0_1` Public constants
`static int`	`VERSION_REB3` Public constants
`static int`	`VERSION_REB5` Public constants
`static int`	`VERSION_UNSUPP` Public constants
`static int`	`VERSION_WREB1` Public constants
`static int`	`VERSION_WREB2` Public constants
`static int`	`VERSION_WREB4` Public constants

Constructor Summary

Constructors
Constructor and Description

BoardDacs(BaseSet bss)
Constructor.

Constructors
Constructor and Description
`BoardDacs(BaseSet bss)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getErrors()` Gets the bit mask of DAC channels in error.
`int`	`getNumStrips()` Gets the number of strips.
`int`	`getUnders()` Gets the bit mask of DAC channels under threshold.
`String`	`getUndersString()` Gets the string of DAC channels under threshold.
`int`	`getVersion()` Gets the DAC version.
`void`	`load(int dac)` Loads one DAC's values.
`void`	`load(int strip, int dac)` Loads the values for one DAC and strip.
`void`	`loadAll()` Loads all DAC values.
`void`	`loadGlobal()` Loads all global DAC values.
`void`	`loadStrip()` Loads all strip-associated DAC values.
`void`	`loadStrip(int strip)` Loads all DAC values for a strip.
`void`	`set(int chan, int value)` Sets a DAC value.
`void`	`set(int chan, int value, boolean load)` Sets a DAC value.
`void`	`set(int strip, int chan, int value)` Sets a DAC value into a strip.
`void`	`set(int strip, int chan, int value, boolean load)` Sets a DAC value into a strip.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERSION_UNSUPP
```
public static final int VERSION_UNSUPP
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - VERSION_REB0_0
```
public static final int VERSION_REB0_0
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - VERSION_REB0_1
```
public static final int VERSION_REB0_1
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - VERSION_REB3
```
public static final int VERSION_REB3
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - VERSION_REB5
```
public static final int VERSION_REB5
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - VERSION_WREB1
```
public static final int VERSION_WREB1
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - VERSION_WREB2
```
public static final int VERSION_WREB2
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - VERSION_WREB4
```
public static final int VERSION_WREB4
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - VERSION_GREB1
```
public static final int VERSION_GREB1
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - VERSION_GREB2
```
public static final int VERSION_GREB2
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - REG_BOARD_DACS
```
public static final int REG_BOARD_DACS
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - REG_BOARD_DACS_0
```
public static final int REG_BOARD_DACS_0
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - OFF_CLOCK_RAILS
```
public static final int OFF_CLOCK_RAILS
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - OFF_CS_GATE
```
public static final int OFF_CS_GATE
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - OFF_HEATER
```
public static final int OFF_HEATER
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - OFF_CABAC_ALT
```
public static final int OFF_CABAC_ALT
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - OFF_BIAS_GATE
```
public static final int OFF_BIAS_GATE
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - OFF_BIAS_ERROR
```
public static final int OFF_BIAS_ERROR
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - INC_STRIPS
```
public static final int INC_STRIPS
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DACS_SET
```
public static final int DACS_SET
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DACS_LOAD
```
public static final int DACS_LOAD
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DAC_HAS_STRIP
```
public static final int DAC_HAS_STRIP
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DAC_CLOCK_RAILS
```
public static final int DAC_CLOCK_RAILS
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DAC_CS_GATE
```
public static final int DAC_CS_GATE
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DAC_CABAC_ALT
```
public static final int DAC_CABAC_ALT
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DAC_HEATER
```
public static final int DAC_HEATER
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DAC_BIAS_GATE
```
public static final int DAC_BIAS_GATE
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_SCLK_L
```
public static final int CHAN_SCLK_L
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_SCLK_L_SH
```
public static final int CHAN_SCLK_L_SH
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_SCLK_H
```
public static final int CHAN_SCLK_H
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_SCLK_H_SH
```
public static final int CHAN_SCLK_H_SH
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_RG_L
```
public static final int CHAN_RG_L
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_RG_L_SH
```
public static final int CHAN_RG_L_SH
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_RG_H
```
public static final int CHAN_RG_H
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_RG_H_SH
```
public static final int CHAN_RG_H_SH
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_PCLK_L
```
public static final int CHAN_PCLK_L
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_PCLK_L_SH
```
public static final int CHAN_PCLK_L_SH
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_PCLK_H
```
public static final int CHAN_PCLK_H
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_PCLK_H_SH
```
public static final int CHAN_PCLK_H_SH
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_OD
```
public static final int CHAN_OD
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_GD
```
public static final int CHAN_GD
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_RD
```
public static final int CHAN_RD
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_OG
```
public static final int CHAN_OG
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_OG_SH
```
public static final int CHAN_OG_SH
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_CSGATE
```
public static final int CHAN_CSGATE
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_HEATER
```
public static final int CHAN_HEATER
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_CSGATE_1
```
public static final int CHAN_CSGATE_1
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_CSGATE_2
```
public static final int CHAN_CSGATE_2
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_CSGATE_3
```
public static final int CHAN_CSGATE_3
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_HEATER_1
```
public static final int CHAN_HEATER_1
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - CHAN_HEATER_2
```
public static final int CHAN_HEATER_2
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - ERROR_MASK_GD
```
public static final int ERROR_MASK_GD
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - ERROR_MASK_OD
```
public static final int ERROR_MASK_OD
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - ERROR_MASK_RD
```
public static final int ERROR_MASK_RD
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - ERROR_MASK_SIZE
```
public static final int ERROR_MASK_SIZE
```
    Public constants
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BoardDacs
```
public BoardDacs(BaseSet bss)
```
    Constructor.
    
    Parameters:
    
    bss - The associated base set object
- Method Detail
  - getVersion
```
public int getVersion()
```
    Gets the DAC version.
    
    Returns:
    
    The version number (VERSION_REB5, etc)
  - getNumStrips
```
public int getNumStrips()
                 throws REBException
```
    Gets the number of strips.
    
    Returns:
    
    The number of strips
    
    Throws:
    
    REBException - if the firmware version is unknown
  - loadAll
```
public void loadAll()
             throws REBException
```
    Loads all DAC values. All the values previously set in the DACs are loaded into their output registers
    
    Throws:
    
    REBException
  - loadGlobal
```
public void loadGlobal()
                throws REBException
```
    Loads all global DAC values. All the values previously set in the global DACs are loaded into their output registers
    
    Throws:
    
    REBException
  - loadStrip
```
public void loadStrip()
               throws REBException
```
    Loads all strip-associated DAC values. All the values previously set in the strip-associated DACs are loaded into their output registers
    
    Throws:
    
    REBException
  - loadStrip
```
public void loadStrip(int strip)
               throws REBException
```
    Loads all DAC values for a strip. All the values previously set for a particular strip are loaded into their output registers
    
    Parameters:
    
    strip - The strip number
    
    Throws:
    
    REBException
  - load
```
public void load(int dac)
          throws REBException
```
    Loads one DAC's values. All the values previously set in a DAC are loaded into its output registers. This is a no-op for VERSION_REB0_0
    
    Parameters:
    
    dac - The DAC number
    
    Throws:
    
    REBException
  - load
```
public void load(int strip,
                 int dac)
          throws REBException
```
    Loads the values for one DAC and strip. All the values previously set in a DAC are loaded into its output registers.
    
    Parameters:
    
    strip - The strip number.
    
    dac - The DAC number
    
    Throws:
    
    REBException
  - set
```
public void set(int chan,
                int value)
         throws REBException
```
    Sets a DAC value. The supplied value is set into its DAC, but not loaded into the DAC's output register until the load method is called
    
    Parameters:
    
    chan - The overall channel number
    
    value - The value to be set
    
    Throws:
    
    REBException
  - set
```
public void set(int chan,
                int value,
                boolean load)
         throws REBException
```
    Sets a DAC value. The supplied value is set into its DAC, and optionally loaded into the DAC's output register
    
    Parameters:
    
    chan - The overall channel number
    
    value - The value to be set (0 - 4095)
    
    load - Whether to load the DAC's output register
    
    Throws:
    
    REBException
  - set
```
public void set(int strip,
                int chan,
                int value)
         throws REBException
```
    Sets a DAC value into a strip. The supplied value is set into the its DAC, but not loaded into the DAC's output register until the load method is called
    
    Parameters:
    
    strip - The strip number.
    
    chan - The overall channel number
    
    value - The value to be set
    
    Throws:
    
    REBException
  - set
```
public void set(int strip,
                int chan,
                int value,
                boolean load)
         throws REBException
```
    Sets a DAC value into a strip. The supplied value is set into the its DAC, and optionally loaded into the DAC's output register
    
    Parameters:
    
    strip - The strip number.
    
    chan - The overall channel number
    
    value - The value to be set
    
    load - Whether to load the DAC's output register
    
    Throws:
    
    REBException
  - getErrors
```
public int getErrors()
              throws REBException
```
    Gets the bit mask of DAC channels in error.
    
    Returns:
    
    The bit mask
    
    Throws:
    
    REBException
  - getUnders
```
public int getUnders()
              throws REBException
```
    Gets the bit mask of DAC channels under threshold.
    
    Returns:
    
    The bit mask
    
    Throws:
    
    REBException
  - getUndersString
```
public String getUndersString()
                       throws REBException
```
    Gets the string of DAC channels under threshold.
    
    Returns:
    
    The string of blank-separated channel names
    
    Throws:
    
    REBException

Class BoardDacs

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION_UNSUPP

VERSION_REB0_0

VERSION_REB0_1

VERSION_REB3

VERSION_REB5

VERSION_WREB1

VERSION_WREB2

VERSION_WREB4

VERSION_GREB1

VERSION_GREB2

REG_BOARD_DACS

REG_BOARD_DACS_0

OFF_CLOCK_RAILS

OFF_CS_GATE

OFF_HEATER

OFF_CABAC_ALT

OFF_BIAS_GATE

OFF_BIAS_ERROR

INC_STRIPS

DACS_SET

DACS_LOAD

DAC_HAS_STRIP

DAC_CLOCK_RAILS

DAC_CS_GATE

DAC_CABAC_ALT

DAC_HEATER

DAC_BIAS_GATE

CHAN_SCLK_L

CHAN_SCLK_L_SH

CHAN_SCLK_H

CHAN_SCLK_H_SH

CHAN_RG_L

CHAN_RG_L_SH

CHAN_RG_H

CHAN_RG_H_SH

CHAN_PCLK_L

CHAN_PCLK_L_SH

CHAN_PCLK_H

CHAN_PCLK_H_SH

CHAN_OD

CHAN_GD

CHAN_RD

CHAN_OG

CHAN_OG_SH

CHAN_CSGATE

CHAN_HEATER

CHAN_CSGATE_1

CHAN_CSGATE_2

CHAN_CSGATE_3

CHAN_HEATER_1

CHAN_HEATER_2

ERROR_MASK_GD

ERROR_MASK_OD

ERROR_MASK_RD

ERROR_MASK_SIZE

Constructor Detail

BoardDacs

Method Detail

getVersion

getNumStrips

loadAll

loadGlobal

loadStrip

loadStrip

load

load

set

set

set

set

getErrors

getUnders

getUndersString