org.lsst.ccs.drivers.dataforth

Class Maq20

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.modbus.Modbus

org.lsst.ccs.drivers.dataforth.Maq20

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

public class Maq20
extends org.lsst.ccs.drivers.modbus.Modbus

Routines for controlling a Dataforth MAQ20 DAQ system.

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Maq20.ModuleType Public constants.

Nested classes/interfaces inherited from class org.lsst.ccs.drivers.modbus.Modbus

org.lsst.ccs.drivers.modbus.Modbus.ConnType

Nested classes/interfaces inherited from class org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.ascii.Ascii.DataBits, org.lsst.ccs.drivers.ascii.Ascii.FlowCtrl, org.lsst.ccs.drivers.ascii.Ascii.Option, org.lsst.ccs.drivers.ascii.Ascii.Parity, org.lsst.ccs.drivers.ascii.Ascii.StopBits, org.lsst.ccs.drivers.ascii.Ascii.Terminator

Field Summary

Fields

Modifier and Type	Field and Description
static int	NUM_MODULES
static int	OPER_ANALOG
static int	OPER_ANALOUT
static int	OPER_DISCRETE

Constructor Summary

Constructors

Constructor and Description
Maq20() Constructor.

Method Summary

Modifier and Type	Method and Description
Maq20AnalogIn	getAnalIn(int modId) Gets the analog input object for a module.
Maq20Analog	getAnalog(int modId) Gets the common analog object for a module.
Maq20AnalogOut	getAnalOut(int modId) Gets the analog output object for a module.
String	getDateCode(int modId) Gets the date code.
Maq20DiscreteFreq	getDiscFreq(int modId) Gets the discrete frequency object for a module.
Maq20DiscretePulse	getDiscPulse(int modId) Gets the discrete pulse object for a module.
Maq20DiscretePWM	getDiscPWM(int modId) Gets the discrete PWM object for a module.
Maq20Discrete	getDiscrete(int modId) Gets the discrete object for a module.
String	getFwRevision(int modId) Gets the firmware revision number.
String	getIPAddress() Gets the IP address.
int	getModuleId(String serial) Gets a module's ID, given its serial number.
int[]	getModuleIds() Gets all valid module IDs.
String	getModuleName(int modId) Gets the module name.
int	getModuleOpType(int modId) Gets the module operation type.
static int	getModuleOpType(Maq20.ModuleType modType) Gets the module operation type.
Maq20.ModuleType	getModuleType(int modId) Gets the module type.
int	getNumInputs(int modId) Gets the number of input channels for a module.
int	getNumOutputs(int modId) Gets the number of output channels for a module.
String	getSerialNumber(int modId) Gets the serial number.
String	getSubnetMask() Gets the subnet mask.
boolean	moduleExists(int modId) Tests whether a module exists.
void	open(org.lsst.ccs.drivers.modbus.Modbus.ConnType type, String ident, int parm1, int parm2) Opens a connection to the device.
int	readRegister(short addr) Reads a register.
int	readRegisterPair(short addr) Reads an integer from a pair of registers in big-endian order.
short[]	readRegisters(short addr, short count) Reads a set of registers.
double	readTemperature() Reads the board temperature.
void	register(String... serial) Registers the modules.
void	saveParameters() Saves the board parameters.
void	setAddressMode(boolean mode) Sets whether entity numbers are direct addresses.
void	setIPAddress(String ipAddr) Sets the IP address.
void	setSubnetMask(String mask) Sets the subnet mask.
void	writeRegister(short addr, short value) Writes a single register.
void	writeRegisterPair(short addr, int value) Writes an integer to a pair of registers in big-endian order.
void	writeRegisters(short addr, short[] value) Writes a set of registers.

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

isAddressMode, open, open, open, readCoils, readDiscretes, readInputs, readRegisters, writeCoil, writeCoils, writeRegister, writeRegisters

Methods inherited from class org.lsst.ccs.drivers.ascii.Ascii

close, closeSilent, flush, getTimeout, isOpen, makeDataCharacteristics, open, open, openFtdi, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, openSerial, read, read, readBytes, readBytes, setCommandTerm, setDefaultParm, setMultidrop, setOptions, setResponseTerm, setTerminator, setTimeout, setTimeout, write, writeBytes, writeBytes

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

See Also:

Constant Field Values

OPER_ANALOG

public static final int OPER_ANALOG

See Also:

Constant Field Values

OPER_ANALOUT

public static final int OPER_ANALOUT

See Also:

Constant Field Values

OPER_DISCRETE

public static final int OPER_DISCRETE

See Also:

Constant Field Values

Constructor Detail

Maq20

public Maq20()

Constructor.

Method Detail

open

public void open(org.lsst.ccs.drivers.modbus.Modbus.ConnType type,
                 String ident,
                 int parm1,
                 int parm2)
          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; port name for serial

parm1 - The first device parameter: port number for network; baud rate for FTDI or serial

parm2 - The second device parameter: unused for network; data characteristics for FTDI or serial

Throws:

org.lsst.ccs.drivers.commons.DriverException

setAddressMode

public void setAddressMode(boolean mode)

Sets whether entity numbers are direct addresses. This routine is a no-op since address mode is always set and should not be changed.

Overrides:

setAddressMode in class org.lsst.ccs.drivers.modbus.Modbus

Parameters:

mode - Whether or not address mode is to be set

readRegisters

public short[] readRegisters(short addr,
                             short count)
                      throws org.lsst.ccs.drivers.commons.DriverException

Reads a set of registers.

Parameters:

addr - The first register address

count - The number of registers to read

Returns:

An array of register values

Throws:

org.lsst.ccs.drivers.commons.DriverException

readRegister

public int readRegister(short addr)
                 throws org.lsst.ccs.drivers.commons.DriverException

Reads a register.

Parameters:

addr - The register address

Returns:

The read value as a signed integer

Throws:

org.lsst.ccs.drivers.commons.DriverException

readRegisterPair

public int readRegisterPair(short addr)
                     throws org.lsst.ccs.drivers.commons.DriverException

Reads an integer from a pair of registers in big-endian order.

Parameters:

addr - The first register address

Returns:

The combined integer

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeRegister

public void writeRegister(short addr,
                          short value)
                   throws org.lsst.ccs.drivers.commons.DriverException

Writes a single register.

Parameters:

addr - The register address

value - The value to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeRegisters

public void writeRegisters(short addr,
                           short[] value)
                    throws org.lsst.ccs.drivers.commons.DriverException

Writes a set of registers.

Parameters:

addr - The first register address

value - The array of values to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeRegisterPair

public void writeRegisterPair(short addr,
                              int value)
                       throws org.lsst.ccs.drivers.commons.DriverException

Writes an integer to a pair of registers in big-endian order.

Parameters:

addr - The first register address

value - The integer to write

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 Maq20.ModuleType 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

getModuleOpType

public int getModuleOpType(int modId)
                    throws org.lsst.ccs.drivers.commons.DriverException

Gets the module operation type.

Parameters:

modId - The module registration ID

Returns:

The module operation type

Throws:

org.lsst.ccs.drivers.commons.DriverException

getModuleOpType

public static int getModuleOpType(Maq20.ModuleType modType)

Gets the module operation type.

Parameters:

modType - The module type

Returns:

The module operation type

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

saveParameters

public void saveParameters()
                    throws org.lsst.ccs.drivers.commons.DriverException

Saves the board parameters. This includes the communications and file server parameters

Throws:

org.lsst.ccs.drivers.commons.DriverException

register

public void register(String... serial)
              throws org.lsst.ccs.drivers.commons.DriverException

Registers 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, given its serial number.

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

getModuleIds

public int[] getModuleIds()
                   throws org.lsst.ccs.drivers.commons.DriverException

Gets all valid module IDs.

Returns:

An array of the existing module IDs

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

getNumOutputs

public int getNumOutputs(int modId)
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the number of output channels for a module.

Parameters:

modId - The module registration ID

Returns:

The number of output channels

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAnalIn

public Maq20AnalogIn getAnalIn(int modId)
                        throws org.lsst.ccs.drivers.commons.DriverException

Gets the analog input object for a module.

Parameters:

modId - The module registration ID

Returns:

The analog input object

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAnalOut

public Maq20AnalogOut getAnalOut(int modId)
                          throws org.lsst.ccs.drivers.commons.DriverException

Gets the analog output object for a module.

Parameters:

modId - The module registration ID

Returns:

The analog output object

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAnalog

public Maq20Analog getAnalog(int modId)
                      throws org.lsst.ccs.drivers.commons.DriverException

Gets the common analog object for a module.

Parameters:

modId - The module registration ID

Returns:

The analog object

Throws:

org.lsst.ccs.drivers.commons.DriverException

getDiscrete

public Maq20Discrete getDiscrete(int modId)
                          throws org.lsst.ccs.drivers.commons.DriverException

Gets the discrete object for a module.

Parameters:

modId - The module registration ID

Returns:

The discrete object

Throws:

org.lsst.ccs.drivers.commons.DriverException

getDiscFreq

public Maq20DiscreteFreq getDiscFreq(int modId)
                              throws org.lsst.ccs.drivers.commons.DriverException

Gets the discrete frequency object for a module.

Parameters:

modId - The module registration ID

Returns:

The discrete frequency object

Throws:

org.lsst.ccs.drivers.commons.DriverException

getDiscPulse

public Maq20DiscretePulse getDiscPulse(int modId)
                                throws org.lsst.ccs.drivers.commons.DriverException

Gets the discrete pulse object for a module.

Parameters:

modId - The module registration ID

Returns:

The discrete pukse object

Throws:

org.lsst.ccs.drivers.commons.DriverException

getDiscPWM

public Maq20DiscretePWM getDiscPWM(int modId)
                            throws org.lsst.ccs.drivers.commons.DriverException

Gets the discrete PWM object for a module.

Parameters:

modId - The module registration ID

Returns:

The discrete PWM object

Throws:

org.lsst.ccs.drivers.commons.DriverException