Maq20 (LSST Camera Control Software - Dataforth Driver 1.0.0 API)

java.lang.Object
- org.lsst.ccs.drivers.modbus.Modbus
- - org.lsst.ccs.drivers.dataforth.Maq20

```
public class Maq20
extends org.lsst.ccs.drivers.modbus.Modbus
```
Routines for controlling a Dataforth MAQ20 DAQ system.

Author:

Owen Saxton

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MOD_TYPE_ID` Public constants.
`static int`	`MOD_TYPE_IS` Public constants.
`static int`	`MOD_TYPE_JTC` Public constants.
`static int`	`MOD_TYPE_KTC` Public constants.
`static int`	`MOD_TYPE_MVD` Public constants.
`static int`	`MOD_TYPE_RSTC` Public constants.
`static int`	`MOD_TYPE_RTD` Public constants.
`static int`	`MOD_TYPE_TTC` Public constants.
`static int`	`MOD_TYPE_UNKNOWN` Public constants.
`static int`	`MOD_TYPE_VD` Public constants.
`static int`	`MOD_TYPE_VS` Public constants.
`static int`	`NUM_MODULES` Public constants.
`static int`	`RANGE_MAMP_0_20` Public constants.
`static int`	`RANGE_MAMP_4_20` Public constants.
`static int`	`RANGE_MVOLT_100` Public constants.
`static int`	`RANGE_MVOLT_1000` Public constants.
`static int`	`RANGE_MVOLT_2000` Public constants.
`static int`	`RANGE_MVOLT_250` Public constants.
`static int`	`RANGE_MVOLT_50` Public constants.
`static int`	`RANGE_RTD_100` Public constants.
`static int`	`RANGE_RTD_200` Public constants.
`static int`	`RANGE_RTD_850` Public constants.
`static int`	`RANGE_TC_J_199` Public constants.
`static int`	`RANGE_TC_J_393` Public constants.
`static int`	`RANGE_TC_J_760` Public constants.
`static int`	`RANGE_TC_K_1350` Public constants.
`static int`	`RANGE_TC_K_332` Public constants.
`static int`	`RANGE_TC_K_651` Public constants.
`static int`	`RANGE_TC_R_1750` Public constants.
`static int`	`RANGE_TC_R_990` Public constants.
`static int`	`RANGE_TC_S_1750` Public constants.
`static int`	`RANGE_TC_S_970` Public constants.
`static int`	`RANGE_TC_T_220` Public constants.
`static int`	`RANGE_TC_T_400` Public constants.
`static int`	`RANGE_VOLT_10` Public constants.
`static int`	`RANGE_VOLT_20` Public constants.
`static int`	`RANGE_VOLT_40` Public constants.
`static int`	`RANGE_VOLT_5` Public constants.
`static int`	`RANGE_VOLT_60` Public constants.

Fields inherited from class org.lsst.ccs.drivers.modbus.Modbus
CONN_TYPE_FTDI, CONN_TYPE_NETWORK, timeout

Constructor Summary

Constructors
Constructor and Description

Maq20()

Constructors
Constructor and Description
`Maq20()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`enable(int modId, int chan, boolean state)` Enables or disables a channel.
`String`	`getDateCode(int modId)` Gets the date code.
`String`	`getFwRevision(int modId)` Gets the firmware revision number.
`String`	`getIPAddress()` Gets the IP address.
`int`	`getModuleId(String serial)` Gets a module's ID.
`String`	`getModuleName(int modId)` Gets the module name.
`int`	`getModuleType(int modId)` Gets the module type.
`int`	`getNumInputs(int modId)` Gets the number of input channels for a module.
`int`	`getNumRanges(int modId)` Gets the number of ranges for a module.
`int`	`getRange(int modId, int chan)` Gets the range for a channel.
`String`	`getSerialNumber(int modId)` Gets the serial number.
`String`	`getSubnetMask()` Gets the subnet mask.
`boolean`	`isEnabled(int modId, int chan)` Gets the enabled state of a channel.
`boolean`	`moduleExists(int modId)` Tests whether a module exists.
`void`	`open(int type, String ident, int parm)` Opens a connection to the device.
`double`	`readTemperature()` Reads the board temperature.
`double[]`	`readValue(int modId)` Reads the data values for all channels.
`double`	`readValue(int modId, int chan)` Reads the data value for a channel.
`double[]`	`readValue(int modId, int chan, int count)` Reads the data values for several channels.
`void`	`register(String... serial)` Register the modules.
`void`	`setIPAddress(String ipAddr)` Sets the IP address.
`void`	`setRange(int modId, int chan, int range)` Sets the range for a channel.
`void`	`setSubnetMask(String mask)` Sets the subnet mask.

Methods inherited from class org.lsst.ccs.drivers.modbus.Modbus
checkOpen, close, isAddressMode, open, readCoils, readDiscretes, readInputs, readRegisters, setAddressMode, setTimeout, writeCoil, writeCoils, writeRegister, writeRegisters

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

- Field Detail
  - NUM_MODULES
```
public static final int NUM_MODULES
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MOD_TYPE_UNKNOWN
```
public static final int MOD_TYPE_UNKNOWN
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MOD_TYPE_JTC
```
public static final int MOD_TYPE_JTC
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MOD_TYPE_KTC
```
public static final int MOD_TYPE_KTC
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MOD_TYPE_TTC
```
public static final int MOD_TYPE_TTC
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MOD_TYPE_RSTC
```
public static final int MOD_TYPE_RSTC
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MOD_TYPE_RTD
```
public static final int MOD_TYPE_RTD
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MOD_TYPE_MVD
```
public static final int MOD_TYPE_MVD
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MOD_TYPE_VD
```
public static final int MOD_TYPE_VD
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MOD_TYPE_VS
```
public static final int MOD_TYPE_VS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MOD_TYPE_ID
```
public static final int MOD_TYPE_ID
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - MOD_TYPE_IS
```
public static final int MOD_TYPE_IS
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_T_400
```
public static final int RANGE_TC_T_400
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_T_220
```
public static final int RANGE_TC_T_220
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_J_760
```
public static final int RANGE_TC_J_760
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_J_393
```
public static final int RANGE_TC_J_393
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_J_199
```
public static final int RANGE_TC_J_199
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_K_1350
```
public static final int RANGE_TC_K_1350
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_K_651
```
public static final int RANGE_TC_K_651
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_K_332
```
public static final int RANGE_TC_K_332
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_R_1750
```
public static final int RANGE_TC_R_1750
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_R_990
```
public static final int RANGE_TC_R_990
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_S_1750
```
public static final int RANGE_TC_S_1750
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_TC_S_970
```
public static final int RANGE_TC_S_970
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_RTD_850
```
public static final int RANGE_RTD_850
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_RTD_200
```
public static final int RANGE_RTD_200
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_RTD_100
```
public static final int RANGE_RTD_100
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_VOLT_60
```
public static final int RANGE_VOLT_60
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_VOLT_40
```
public static final int RANGE_VOLT_40
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_VOLT_20
```
public static final int RANGE_VOLT_20
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_VOLT_10
```
public static final int RANGE_VOLT_10
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_VOLT_5
```
public static final int RANGE_VOLT_5
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_MVOLT_2000
```
public static final int RANGE_MVOLT_2000
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_MVOLT_1000
```
public static final int RANGE_MVOLT_1000
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_MVOLT_250
```
public static final int RANGE_MVOLT_250
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_MVOLT_100
```
public static final int RANGE_MVOLT_100
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_MVOLT_50
```
public static final int RANGE_MVOLT_50
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_MAMP_0_20
```
public static final int RANGE_MAMP_0_20
```
    Public constants.
    
    See Also:
    
    Constant Field Values
  - RANGE_MAMP_4_20
```
public static final int RANGE_MAMP_4_20
```
    Public constants.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Maq20
```
public Maq20()
```
- Method Detail
  - open
```
public void open(int type,
                 String ident,
                 int parm)
          throws org.lsst.ccs.drivers.commons.DriverException
```
    Opens a connection to the device.
    
    Overrides:
    
    open in class org.lsst.ccs.drivers.modbus.Modbus
    
    Parameters:
    
    type - The type of connection to make
    
    ident - The device identifier: host name or IP address for network; serial number for FTDI device;
    
    parm - The device parameter: port number for network; baud rate for FTDI
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - moduleExists
```
public boolean moduleExists(int modId)
```
    Tests whether a module exists.
    
    Parameters:
    
    modId - The module registration ID
    
    Returns:
    
    Whether the module exists
  - getModuleName
```
public String getModuleName(int modId)
                     throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the module name.
    
    Parameters:
    
    modId - The module registration ID
    
    Returns:
    
    The module name
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getModuleType
```
public int getModuleType(int modId)
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the module type.
    
    Parameters:
    
    modId - The module registration ID
    
    Returns:
    
    The module type
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getSerialNumber
```
public String getSerialNumber(int modId)
                       throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the serial number.
    
    Parameters:
    
    modId - The module registration ID
    
    Returns:
    
    The serial number
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getDateCode
```
public String getDateCode(int modId)
                   throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the date code.
    
    Parameters:
    
    modId - The module registration ID
    
    Returns:
    
    The date code
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getFwRevision
```
public String getFwRevision(int modId)
                     throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the firmware revision number.
    
    Parameters:
    
    modId - The module registration ID
    
    Returns:
    
    The firmware revision number
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getIPAddress
```
public String getIPAddress()
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the IP address.
    
    Returns:
    
    The IP address, as a string
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setIPAddress
```
public void setIPAddress(String ipAddr)
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the IP address.
    
    Parameters:
    
    ipAddr - The IP address, as an IP string
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getSubnetMask
```
public String getSubnetMask()
                     throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the subnet mask.
    
    Returns:
    
    The subnet mask, as a string
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setSubnetMask
```
public void setSubnetMask(String mask)
                   throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the subnet mask.
    
    Parameters:
    
    mask - The subnet mask, as an IP string
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readTemperature
```
public double readTemperature()
                       throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads the board temperature.
    
    Returns:
    
    The board temperature
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - register
```
public void register(String... serial)
              throws org.lsst.ccs.drivers.commons.DriverException
```
    Register the modules.
    
    Parameters:
    
    serial - The serial numbers of all the modules, in the desired order
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getModuleId
```
public int getModuleId(String serial)
                throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets a module's ID.
    
    Parameters:
    
    serial - The module's serial number
    
    Returns:
    
    The module's registration ID, or -1 if not found
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getNumInputs
```
public int getNumInputs(int modId)
                 throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the number of input channels for a module.
    
    Parameters:
    
    modId - The module registration ID
    
    Returns:
    
    The number of input channels
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getNumRanges
```
public int getNumRanges(int modId)
                 throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the number of ranges for a module.
    
    Parameters:
    
    modId - The module registration ID
    
    Returns:
    
    The number of ranges
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getRange
```
public int getRange(int modId,
                    int chan)
             throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the range for a channel.
    
    Parameters:
    
    modId - The module registration ID
    
    chan - The channel number
    
    Returns:
    
    The range number
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setRange
```
public void setRange(int modId,
                     int chan,
                     int range)
              throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the range for a channel.
    
    Parameters:
    
    modId - The module registration ID
    
    chan - The channel number
    
    range - The range number
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - isEnabled
```
public boolean isEnabled(int modId,
                         int chan)
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the enabled state of a channel.
    
    Parameters:
    
    modId - The module registration ID
    
    chan - The channel number
    
    Returns:
    
    Whether the channel is enabled
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - enable
```
public void enable(int modId,
                   int chan,
                   boolean state)
            throws org.lsst.ccs.drivers.commons.DriverException
```
    Enables or disables a channel.
    
    Parameters:
    
    modId - The module registration ID
    
    chan - The channel number
    
    state - The enabled state to set: true or false
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readValue
```
public double[] readValue(int modId,
                          int chan,
                          int count)
                   throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads the data values for several channels.
    
    Parameters:
    
    modId - The module registration ID
    
    chan - The first channel number
    
    count - The number of channels
    
    Returns:
    
    The array of data values
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readValue
```
public double readValue(int modId,
                        int chan)
                 throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads the data value for a channel.
    
    Parameters:
    
    modId - The module registration ID
    
    chan - The channel number
    
    Returns:
    
    The data value
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readValue
```
public double[] readValue(int modId)
                   throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads the data values for all channels.
    
    Parameters:
    
    modId - The module registration ID
    
    Returns:
    
    The array of data values
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException

Class Maq20

Field Summary

Fields inherited from class org.lsst.ccs.drivers.modbus.Modbus

Constructor Summary

Method Summary

Methods inherited from class org.lsst.ccs.drivers.modbus.Modbus

Methods inherited from class java.lang.Object

Field Detail

NUM_MODULES

MOD_TYPE_UNKNOWN

MOD_TYPE_JTC

MOD_TYPE_KTC

MOD_TYPE_TTC

MOD_TYPE_RSTC

MOD_TYPE_RTD

MOD_TYPE_MVD

MOD_TYPE_VD

MOD_TYPE_VS

MOD_TYPE_ID

MOD_TYPE_IS

RANGE_TC_T_400

RANGE_TC_T_220

RANGE_TC_J_760

RANGE_TC_J_393

RANGE_TC_J_199

RANGE_TC_K_1350

RANGE_TC_K_651

RANGE_TC_K_332

RANGE_TC_R_1750

RANGE_TC_R_990

RANGE_TC_S_1750

RANGE_TC_S_970

RANGE_RTD_850

RANGE_RTD_200

RANGE_RTD_100

RANGE_VOLT_60

RANGE_VOLT_40

RANGE_VOLT_20

RANGE_VOLT_10

RANGE_VOLT_5

RANGE_MVOLT_2000

RANGE_MVOLT_1000

RANGE_MVOLT_250

RANGE_MVOLT_100

RANGE_MVOLT_50

RANGE_MAMP_0_20

RANGE_MAMP_4_20

Constructor Detail

Maq20

Method Detail

open

moduleExists

getModuleName

getModuleType

getSerialNumber

getDateCode

getFwRevision

getIPAddress

setIPAddress

getSubnetMask

setSubnetMask

readTemperature

register

getModuleId

getNumInputs

getNumRanges

getRange

setRange

isEnabled

enable

readValue

readValue

readValue