org.lsst.ccs.drivers.ad
Class Ad7747Eval

java.lang.Object
  extended by org.lsst.ccs.drivers.ad.Cypress
      extended by org.lsst.ccs.drivers.ad.I2cBus
          extended by org.lsst.ccs.drivers.ad.Ad7747Eval

public class Ad7747Eval
extends I2cBus

Routines to access an Analog Devices AD7747 evaluation board

Author:
Owen Saxton

Field Summary
static int CAP_DAC_A_REG
          Public constants
static int CAP_DAC_B_REG
          Public constants
static int CAP_DATA_REG
          Public constants
static float CAP_FULL_SCALE
           
static int CAP_GAIN_REG
          Public constants
static int CAP_OFFSET_REG
          Public constants
static int CAP_SETUP_REG
          Public constants
static int CAPFS_RATE_13
          Public constants
static int CAPFS_RATE_25
          Public constants
static int CAPFS_RATE_42
          Public constants
static int CAPFS_RATE_45
          Public constants
static int CAPFS_RATE_5
          Public constants
static int CAPFS_RATE_6
          Public constants
static int CAPFS_RATE_7
          Public constants
static int CAPFS_RATE_8
          Public constants
static int CAPFS_TIME_124
          Public constants
static int CAPFS_TIME_154
          Public constants
static int CAPFS_TIME_184
          Public constants
static int CAPFS_TIME_219
          Public constants
static int CAPFS_TIME_22
          Public constants
static int CAPFS_TIME_24
          Public constants
static int CAPFS_TIME_40
          Public constants
static int CAPFS_TIME_76
          Public constants
static int CFG_CAPFS_M
          Public constants
static int CFG_CAPFS_V
          Public constants
static int CFG_MODE_M
          Public constants
static int CFG_MODE_V
          Public constants
static int CFG_VTFS_M
          Public constants
static int CFG_VTFS_V
          Public constants
static int CONFIG_REG
          Public constants
static int CPSU_CAPDIFF
          Public constants
static int CPSU_CAPEN
          Public constants
static int CPSU_STANDARD
          Public constants
static int DACA_ENABLE
          Public constants
static int DACA_VALUE_M
          Public constants
static int DACB_ENABLE
          Public constants
static int DACB_VALUE_M
          Public constants
static int EXC_SETUP_REG
          Public constants
static int EXCLVL_1_2
          Public constants
static int EXCLVL_1_4
          Public constants
static int EXCLVL_1_8
          Public constants
static int EXCLVL_3_8
          Public constants
static int EXSU_EXCDAC
          Public constants
static int EXSU_EXCEN
          Public constants
static int EXSU_EXCLVL_M
          Public constants
static int EXSU_EXCLVL_V
          Public constants
static int EXSU_STANDARD
          Public constants
static float HALF_RANGE3
           
static float INT_VOLT_SCALE
           
static int MODE_CONT
          Public constants
static int MODE_GAIN_CAL
          Public constants
static int MODE_IDLE
          Public constants
static int MODE_OFFS_CAL
          Public constants
static int MODE_POWERDOWN
          Public constants
static int MODE_SINGLE
          Public constants
static int RDO_CONFIG
          Public constants
static int RDO_EXTERN
          Public constants
static int RDO_IMMED
          Public constants
static int RDO_SINGLE
          Public constants
static float REF_VOLTAGE
           
static int STATUS_REG
          Public constants
static int STS_RDYCAP
          Public constants
static int STS_RDYVT
          Public constants
static int STS_READY
          Public constants
static float TEMP_FULL_SCALE
           
static int VOLT_GAIN_REG
          Public constants
static int VT_DATA_REG
          Public constants
static int VT_SETUP_REG
          Public constants
static int VTFS_RATE_16
          Public constants
static int VTFS_RATE_31
          Public constants
static int VTFS_RATE_50
          Public constants
static int VTFS_RATE_8
          Public constants
static int VTFS_TIME_122
          Public constants
static int VTFS_TIME_20
          Public constants
static int VTFS_TIME_32
          Public constants
static int VTFS_TIME_62
          Public constants
static int VTMD_EXT_TEMP
          Public constants
static int VTMD_EXT_VOLT
          Public constants
static int VTMD_INT_TEMP
          Public constants
static int VTMD_VDD_MON
          Public constants
static int VTSU_EXTREF
          Public constants
static int VTSU_STANDARD
          Public constants
static int VTSU_VTCHOP
          Public constants
static int VTSU_VTEN
          Public constants
static int VTSU_VTMODE_M
          Public constants
static int VTSU_VTMODE_V
          Public constants
static int VTSU_VTSHORT
          Public constants
 
Constructor Summary
Ad7747Eval()
          Constructors
Ad7747Eval(int index)
           
 
Method Summary
 int getCapConvRate()
          Gets the capacitance conversion rate
 int getConvMode()
          Gets the conversion mode
 int getDacAValue()
          Gets capacitance DAC A value
 int getDacBValue()
          Gets capacitance DAC B value
 int getStatus()
          Gets the board status
 int getVtConvRate()
          Gets the voltage/temperature conversion rate
 int getVtMode()
          Gets the mode of the voltage/temperature channel
 boolean isCapEnabled()
          Gets the enabled state of the capacitance channel
 boolean isDacAEnabled()
          Gets capacitance DAC A enabled state
 boolean isDacBEnabled()
          Gets capacitance DAC B enabled state
 boolean isExcEnabled()
          Gets the enabled state of the capacitance excitation
 boolean isExternalRef()
          Gets whether the external reference voltage is being used
 boolean isVtEnabled()
          Gets the enabled state of the voltage/temperature channel
 boolean isVtShorted()
          Gets the shorted state of the voltage/temperature channel
 float readCapacitance(int optns)
          Reads capacitance sensor
 float readTemperature(int optns)
          Reads temperature sensor
 float readVoltage(int optns)
          Reads voltage
 void setCapConvRate(int rate)
          Sets the capacitance conversion rate
 void setCapEnabled(boolean set)
          Enables or disables the capacitance channel
 void setConvMode(int mode)
          Sets the conversion mode
 void setDacAEnabled(boolean set)
          Enables or disables capacitance DAC A
 void setDacAValue(int value)
          Sets capacitance DAC A value
 void setDacBEnabled(boolean set)
          Enables or disables capacitance DAC B
 void setDacBValue(int value)
          Sets capacitance DAC B value
 void setExcEnabled(boolean set)
          Enables or disables the capacitance excitation
 void setExternalRef(boolean set)
          Sets or clears the use of the external reference voltage
 void setupStandard()
          Performs standard board setup
 void setVtConvRate(int rate)
          Sets the voltage/temperature conversion rate
 void setVtEnabled(boolean set)
          Enables or disables the voltage/temperature channel
 void setVtMode(int mode)
          Sets the mode of the voltage/temperature channel
 void setVtShorted(boolean set)
          Sets or clears the shorted state of the voltage/temperature channel
 
Methods inherited from class org.lsst.ccs.drivers.ad.I2cBus
load, readRegister, readRegister, readRegister2, readRegister3, updateRegister, writeRegister, writeRegister
 
Methods inherited from class org.lsst.ccs.drivers.ad.Cypress
load, readMemory, readMemory, setReset, writeMemory, writeMemory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STATUS_REG

public static final int STATUS_REG
Public constants

See Also:
Constant Field Values

CAP_DATA_REG

public static final int CAP_DATA_REG
Public constants

See Also:
Constant Field Values

VT_DATA_REG

public static final int VT_DATA_REG
Public constants

See Also:
Constant Field Values

CAP_SETUP_REG

public static final int CAP_SETUP_REG
Public constants

See Also:
Constant Field Values

VT_SETUP_REG

public static final int VT_SETUP_REG
Public constants

See Also:
Constant Field Values

EXC_SETUP_REG

public static final int EXC_SETUP_REG
Public constants

See Also:
Constant Field Values

CONFIG_REG

public static final int CONFIG_REG
Public constants

See Also:
Constant Field Values

CAP_DAC_A_REG

public static final int CAP_DAC_A_REG
Public constants

See Also:
Constant Field Values

CAP_DAC_B_REG

public static final int CAP_DAC_B_REG
Public constants

See Also:
Constant Field Values

CAP_OFFSET_REG

public static final int CAP_OFFSET_REG
Public constants

See Also:
Constant Field Values

CAP_GAIN_REG

public static final int CAP_GAIN_REG
Public constants

See Also:
Constant Field Values

VOLT_GAIN_REG

public static final int VOLT_GAIN_REG
Public constants

See Also:
Constant Field Values

STS_READY

public static final int STS_READY
Public constants

See Also:
Constant Field Values

STS_RDYVT

public static final int STS_RDYVT
Public constants

See Also:
Constant Field Values

STS_RDYCAP

public static final int STS_RDYCAP
Public constants

See Also:
Constant Field Values

CPSU_CAPEN

public static final int CPSU_CAPEN
Public constants

See Also:
Constant Field Values

CPSU_CAPDIFF

public static final int CPSU_CAPDIFF
Public constants

See Also:
Constant Field Values

CPSU_STANDARD

public static final int CPSU_STANDARD
Public constants

See Also:
Constant Field Values

VTSU_VTEN

public static final int VTSU_VTEN
Public constants

See Also:
Constant Field Values

VTSU_VTMODE_M

public static final int VTSU_VTMODE_M
Public constants

See Also:
Constant Field Values

VTSU_VTMODE_V

public static final int VTSU_VTMODE_V
Public constants

See Also:
Constant Field Values

VTMD_INT_TEMP

public static final int VTMD_INT_TEMP
Public constants

See Also:
Constant Field Values

VTMD_EXT_TEMP

public static final int VTMD_EXT_TEMP
Public constants

See Also:
Constant Field Values

VTMD_VDD_MON

public static final int VTMD_VDD_MON
Public constants

See Also:
Constant Field Values

VTMD_EXT_VOLT

public static final int VTMD_EXT_VOLT
Public constants

See Also:
Constant Field Values

VTSU_EXTREF

public static final int VTSU_EXTREF
Public constants

See Also:
Constant Field Values

VTSU_VTSHORT

public static final int VTSU_VTSHORT
Public constants

See Also:
Constant Field Values

VTSU_VTCHOP

public static final int VTSU_VTCHOP
Public constants

See Also:
Constant Field Values

VTSU_STANDARD

public static final int VTSU_STANDARD
Public constants

See Also:
Constant Field Values

EXSU_EXCDAC

public static final int EXSU_EXCDAC
Public constants

See Also:
Constant Field Values

EXSU_EXCEN

public static final int EXSU_EXCEN
Public constants

See Also:
Constant Field Values

EXSU_EXCLVL_M

public static final int EXSU_EXCLVL_M
Public constants

See Also:
Constant Field Values

EXSU_EXCLVL_V

public static final int EXSU_EXCLVL_V
Public constants

See Also:
Constant Field Values

EXCLVL_1_8

public static final int EXCLVL_1_8
Public constants

See Also:
Constant Field Values

EXCLVL_1_4

public static final int EXCLVL_1_4
Public constants

See Also:
Constant Field Values

EXCLVL_3_8

public static final int EXCLVL_3_8
Public constants

See Also:
Constant Field Values

EXCLVL_1_2

public static final int EXCLVL_1_2
Public constants

See Also:
Constant Field Values

EXSU_STANDARD

public static final int EXSU_STANDARD
Public constants

See Also:
Constant Field Values

CFG_VTFS_M

public static final int CFG_VTFS_M
Public constants

See Also:
Constant Field Values

CFG_VTFS_V

public static final int CFG_VTFS_V
Public constants

See Also:
Constant Field Values

VTFS_RATE_50

public static final int VTFS_RATE_50
Public constants

See Also:
Constant Field Values

VTFS_RATE_31

public static final int VTFS_RATE_31
Public constants

See Also:
Constant Field Values

VTFS_RATE_16

public static final int VTFS_RATE_16
Public constants

See Also:
Constant Field Values

VTFS_RATE_8

public static final int VTFS_RATE_8
Public constants

See Also:
Constant Field Values

VTFS_TIME_20

public static final int VTFS_TIME_20
Public constants

See Also:
Constant Field Values

VTFS_TIME_32

public static final int VTFS_TIME_32
Public constants

See Also:
Constant Field Values

VTFS_TIME_62

public static final int VTFS_TIME_62
Public constants

See Also:
Constant Field Values

VTFS_TIME_122

public static final int VTFS_TIME_122
Public constants

See Also:
Constant Field Values

CFG_CAPFS_M

public static final int CFG_CAPFS_M
Public constants

See Also:
Constant Field Values

CFG_CAPFS_V

public static final int CFG_CAPFS_V
Public constants

See Also:
Constant Field Values

CAPFS_RATE_45

public static final int CAPFS_RATE_45
Public constants

See Also:
Constant Field Values

CAPFS_RATE_42

public static final int CAPFS_RATE_42
Public constants

See Also:
Constant Field Values

CAPFS_RATE_25

public static final int CAPFS_RATE_25
Public constants

See Also:
Constant Field Values

CAPFS_RATE_13

public static final int CAPFS_RATE_13
Public constants

See Also:
Constant Field Values

CAPFS_RATE_8

public static final int CAPFS_RATE_8
Public constants

See Also:
Constant Field Values

CAPFS_RATE_7

public static final int CAPFS_RATE_7
Public constants

See Also:
Constant Field Values

CAPFS_RATE_6

public static final int CAPFS_RATE_6
Public constants

See Also:
Constant Field Values

CAPFS_RATE_5

public static final int CAPFS_RATE_5
Public constants

See Also:
Constant Field Values

CAPFS_TIME_22

public static final int CAPFS_TIME_22
Public constants

See Also:
Constant Field Values

CAPFS_TIME_24

public static final int CAPFS_TIME_24
Public constants

See Also:
Constant Field Values

CAPFS_TIME_40

public static final int CAPFS_TIME_40
Public constants

See Also:
Constant Field Values

CAPFS_TIME_76

public static final int CAPFS_TIME_76
Public constants

See Also:
Constant Field Values

CAPFS_TIME_124

public static final int CAPFS_TIME_124
Public constants

See Also:
Constant Field Values

CAPFS_TIME_154

public static final int CAPFS_TIME_154
Public constants

See Also:
Constant Field Values

CAPFS_TIME_184

public static final int CAPFS_TIME_184
Public constants

See Also:
Constant Field Values

CAPFS_TIME_219

public static final int CAPFS_TIME_219
Public constants

See Also:
Constant Field Values

CFG_MODE_M

public static final int CFG_MODE_M
Public constants

See Also:
Constant Field Values

CFG_MODE_V

public static final int CFG_MODE_V
Public constants

See Also:
Constant Field Values

MODE_IDLE

public static final int MODE_IDLE
Public constants

See Also:
Constant Field Values

MODE_CONT

public static final int MODE_CONT
Public constants

See Also:
Constant Field Values

MODE_SINGLE

public static final int MODE_SINGLE
Public constants

See Also:
Constant Field Values

MODE_POWERDOWN

public static final int MODE_POWERDOWN
Public constants

See Also:
Constant Field Values

MODE_OFFS_CAL

public static final int MODE_OFFS_CAL
Public constants

See Also:
Constant Field Values

MODE_GAIN_CAL

public static final int MODE_GAIN_CAL
Public constants

See Also:
Constant Field Values

DACA_ENABLE

public static final int DACA_ENABLE
Public constants

See Also:
Constant Field Values

DACA_VALUE_M

public static final int DACA_VALUE_M
Public constants

See Also:
Constant Field Values

DACB_ENABLE

public static final int DACB_ENABLE
Public constants

See Also:
Constant Field Values

DACB_VALUE_M

public static final int DACB_VALUE_M
Public constants

See Also:
Constant Field Values

RDO_CONFIG

public static final int RDO_CONFIG
Public constants

See Also:
Constant Field Values

RDO_EXTERN

public static final int RDO_EXTERN
Public constants

See Also:
Constant Field Values

RDO_SINGLE

public static final int RDO_SINGLE
Public constants

See Also:
Constant Field Values

RDO_IMMED

public static final int RDO_IMMED
Public constants

See Also:
Constant Field Values

HALF_RANGE3

public static final float HALF_RANGE3
See Also:
Constant Field Values

REF_VOLTAGE

public static final float REF_VOLTAGE
See Also:
Constant Field Values

CAP_FULL_SCALE

public static final float CAP_FULL_SCALE
See Also:
Constant Field Values

TEMP_FULL_SCALE

public static final float TEMP_FULL_SCALE
See Also:
Constant Field Values

INT_VOLT_SCALE

public static final float INT_VOLT_SCALE
See Also:
Constant Field Values
Constructor Detail

Ad7747Eval

public Ad7747Eval()
           throws javax.usb.UsbException
Constructors

Throws:
javax.usb.UsbException

Ad7747Eval

public Ad7747Eval(int index)
           throws javax.usb.UsbException
Throws:
javax.usb.UsbException
Method Detail

setupStandard

public void setupStandard()
                   throws javax.usb.UsbException
Performs standard board setup

The three setup register are written with capacitance and voltage channels disabled, and all other bits set to the values mandated for correct operation. The configuration register is set to idle mode and the maximum conversion rates for the data channels.

Throws:
javax.usb.UsbException

getStatus

public int getStatus()
              throws javax.usb.UsbException
Gets the board status

Throws:
javax.usb.UsbException

setCapEnabled

public void setCapEnabled(boolean set)
                   throws javax.usb.UsbException
Enables or disables the capacitance channel

Parameters:
set - If true, the channel is enabled; otherwise disabled
Throws:
javax.usb.UsbException

isCapEnabled

public boolean isCapEnabled()
                     throws javax.usb.UsbException
Gets the enabled state of the capacitance channel

Returns:
The enabled state
Throws:
javax.usb.UsbException

setExcEnabled

public void setExcEnabled(boolean set)
                   throws javax.usb.UsbException
Enables or disables the capacitance excitation

Parameters:
set - If true, excitation is enabled; otherwise disabled
Throws:
javax.usb.UsbException

isExcEnabled

public boolean isExcEnabled()
                     throws javax.usb.UsbException
Gets the enabled state of the capacitance excitation

Returns:
The enabled state
Throws:
javax.usb.UsbException

setVtEnabled

public void setVtEnabled(boolean set)
                  throws javax.usb.UsbException
Enables or disables the voltage/temperature channel

Parameters:
set - If true, the channel is enabled; otherwise disabled
Throws:
javax.usb.UsbException

isVtEnabled

public boolean isVtEnabled()
                    throws javax.usb.UsbException
Gets the enabled state of the voltage/temperature channel

Returns:
The enabled state
Throws:
javax.usb.UsbException

setVtMode

public void setVtMode(int mode)
               throws javax.usb.UsbException
Sets the mode of the voltage/temperature channel

Parameters:
mode - The mode value to set
Throws:
javax.usb.UsbException

getVtMode

public int getVtMode()
              throws javax.usb.UsbException
Gets the mode of the voltage/temperature channel

Returns:
The mode value
Throws:
javax.usb.UsbException

setVtShorted

public void setVtShorted(boolean set)
                  throws javax.usb.UsbException
Sets or clears the shorted state of the voltage/temperature channel

Parameters:
set - If true, shorted state is set; otherwise cleared
Throws:
javax.usb.UsbException

isVtShorted

public boolean isVtShorted()
                    throws javax.usb.UsbException
Gets the shorted state of the voltage/temperature channel

Returns:
The shorted state
Throws:
javax.usb.UsbException

setExternalRef

public void setExternalRef(boolean set)
                    throws javax.usb.UsbException
Sets or clears the use of the external reference voltage

Parameters:
set - If true, external reference is used; otherwise internal
Throws:
javax.usb.UsbException

isExternalRef

public boolean isExternalRef()
                      throws javax.usb.UsbException
Gets whether the external reference voltage is being used

Returns:
The external reference state
Throws:
javax.usb.UsbException

setVtConvRate

public void setVtConvRate(int rate)
                   throws javax.usb.UsbException
Sets the voltage/temperature conversion rate

Parameters:
rate - The rate value to set
Throws:
javax.usb.UsbException

getVtConvRate

public int getVtConvRate()
                  throws javax.usb.UsbException
Gets the voltage/temperature conversion rate

Returns:
The conversion rate
Throws:
javax.usb.UsbException

setCapConvRate

public void setCapConvRate(int rate)
                    throws javax.usb.UsbException
Sets the capacitance conversion rate

Parameters:
rate - The rate value to set
Throws:
javax.usb.UsbException

getCapConvRate

public int getCapConvRate()
                   throws javax.usb.UsbException
Gets the capacitance conversion rate

Returns:
The conversion rate
Throws:
javax.usb.UsbException

setConvMode

public void setConvMode(int mode)
                 throws javax.usb.UsbException
Sets the conversion mode

Parameters:
mode - The mode value to set
Throws:
javax.usb.UsbException

getConvMode

public int getConvMode()
                throws javax.usb.UsbException
Gets the conversion mode

Returns:
The mode value
Throws:
javax.usb.UsbException

setDacAEnabled

public void setDacAEnabled(boolean set)
                    throws javax.usb.UsbException
Enables or disables capacitance DAC A

Parameters:
set - If true, capacitance DAC A is enabled; otherwise disabled
Throws:
javax.usb.UsbException

isDacAEnabled

public boolean isDacAEnabled()
                      throws javax.usb.UsbException
Gets capacitance DAC A enabled state

Returns:
The enabled state
Throws:
javax.usb.UsbException

setDacAValue

public void setDacAValue(int value)
                  throws javax.usb.UsbException
Sets capacitance DAC A value

Parameters:
value - The DAC value to set
Throws:
javax.usb.UsbException

getDacAValue

public int getDacAValue()
                 throws javax.usb.UsbException
Gets capacitance DAC A value

Returns:
The DAC value
Throws:
javax.usb.UsbException

setDacBEnabled

public void setDacBEnabled(boolean set)
                    throws javax.usb.UsbException
Enables or disables capacitance DAC B

Parameters:
set - If true, capacitance DAC B is enabled; otherwise disabled
Throws:
javax.usb.UsbException

isDacBEnabled

public boolean isDacBEnabled()
                      throws javax.usb.UsbException
Gets capacitance DAC B enabled state

Returns:
The enabled state
Throws:
javax.usb.UsbException

setDacBValue

public void setDacBValue(int value)
                  throws javax.usb.UsbException
Sets capacitance DAC B value

Parameters:
value - The DAC value to set
Throws:
javax.usb.UsbException

getDacBValue

public int getDacBValue()
                 throws javax.usb.UsbException
Gets capacitance DAC B value

Returns:
The DAC value
Throws:
javax.usb.UsbException

readCapacitance

public float readCapacitance(int optns)
                      throws javax.usb.UsbException
Reads capacitance sensor

Parameters:
optns - Options word, composed of the following possible bit masks: RDO_SINGLE: First configures for a single conversion. RDO_IMMED: Reads the data registers immediately instead of waiting for a conversion to complete.
Returns:
The read capacitance (pF)
Throws:
javax.usb.UsbException

readTemperature

public float readTemperature(int optns)
                      throws javax.usb.UsbException
Reads temperature sensor

Parameters:
optns - Options word, composed of the following possible bit masks: RDO_CONFIG: Configures to read either the internal or external temperature sensor. RDO_EXTERN: If configuring, selects the external sensor instead of the internal one. RDO_SINGLE: First configures for a single conversion. RDO_IMMED: Reads the data registers immediately instead of waiting for a conversion to complete.
Returns:
The read temperature (Celsius)
Throws:
javax.usb.UsbException

readVoltage

public float readVoltage(int optns)
                  throws javax.usb.UsbException
Reads voltage

Parameters:
optns - Options word, composed of the following possible bit masks: RDO_CONFIG: Configures to read either the internal or external temperature sensor. RDO_EXTERN: Selects the external sensor instead of the internal one (for both configuring and conversion). RDO_SINGLE: First configures for a single conversion. RDO_IMMED: Reads the data registers immediately instead of waiting for a conversion to complete.
Returns:
The read voltage
Throws:
javax.usb.UsbException


Copyright © 2013 LSST. All Rights Reserved.