org.lsst.ccs.drivers.pluto

Class Pluto

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.modbus.Modbus

org.lsst.ccs.drivers.pluto.Pluto

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

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

Routines for controlling a Pluto PLC system.

Author:

Owen Saxton

Nested Class Summary

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	DATA_TYPE_GLOBAL Public constants.
static int	DATA_TYPE_LOCAL_MEMORY Public constants.
static int	DATA_TYPE_LOCAL_PARAMETER Public constants.
static int	DATA_TYPE_LOCAL_REGISTER Public constants.
static int	NUM_ADD_AREAS Public constants.
static int	NUM_DTP_AREAS Public constants.
static int	NUM_MODULES Public constants.

Constructor Summary

Constructors

Constructor and Description
Pluto() Constructor.

Method Summary

Modifier and Type	Method and Description
void	configDataArea(int area, int pluto, int dataId) Configures an additional data area.
void	configStart(int nodeMask, int areaMask, int timeout, int cycleTime) Starts a gateway configuration.
void	configWrite() Writes the configuration.
void	open(org.lsst.ccs.drivers.modbus.Modbus.ConnType type, String ident, int parm1, int parm2) Opens a connection to the device.
void	open(String ident) Opens a connection to the device.
void	open(String ident, int parm) Opens a connection to the device.
int	readAdditionalData(int area) Reads additional data.
int	readAreaBit(int area, int bit) Reads a bit from a data-to-Pluto area.
int	readAreaBits(int area) Reads all bits from a data-to-Pluto area.
int	readAreaRegister(int area, int reg) Reads a register from a data-to-Pluto area.
int	readGlobalData(int pluto) Reads global data.
int	readLocalData(int pluto, int type, int addr) Reads local data.
int	readModuleStatus() Reads module status.
void	setAddressMode(boolean mode) Sets whether entity numbers are direct addresses.
void	writeAreaBit(int area, int bit, int value) Writes a bit to a data-to-Pluto area.
void	writeAreaBits(int area, int value) Writes all bits to a data-to-Pluto area.
void	writeAreaRegister(int area, int reg, int value) Writes a register to a data-to-Pluto area.

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

Public constants.

See Also:

Constant Field Values

NUM_ADD_AREAS

public static final int NUM_ADD_AREAS

Public constants.

See Also:

Constant Field Values

NUM_DTP_AREAS

public static final int NUM_DTP_AREAS

Public constants.

See Also:

Constant Field Values

DATA_TYPE_GLOBAL

public static final int DATA_TYPE_GLOBAL

Public constants.

See Also:

Constant Field Values

DATA_TYPE_LOCAL_MEMORY

public static final int DATA_TYPE_LOCAL_MEMORY

Public constants.

See Also:

Constant Field Values

DATA_TYPE_LOCAL_REGISTER

public static final int DATA_TYPE_LOCAL_REGISTER

Public constants.

See Also:

Constant Field Values

DATA_TYPE_LOCAL_PARAMETER

public static final int DATA_TYPE_LOCAL_PARAMETER

Public constants.

See Also:

Constant Field Values

Constructor Detail

Pluto

public Pluto()

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 connection type

ident - The host name or IP address

parm1 - The port number

parm2 - Unused

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(String ident)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the device.

Parameters:

ident - The host name or IP address

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(String ident,
                 int parm)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the device.

Parameters:

ident - The host name or IP address

parm - The port number

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

readModuleStatus

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

Reads module status.

Returns:

The 32-bit status word with a bit set for each module present

Throws:

org.lsst.ccs.drivers.commons.DriverException

readGlobalData

public int readGlobalData(int pluto)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads global data.

Parameters:

pluto - The pluto number of the module (0 - 31)

Returns:

The 32-bit data value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readAdditionalData

public int readAdditionalData(int area)
                       throws org.lsst.ccs.drivers.commons.DriverException

Reads additional data.

Parameters:

area - The area number of the data (0 - 31)

Returns:

The 32-bit additional data value

Throws:

org.lsst.ccs.drivers.commons.DriverException

configStart

public void configStart(int nodeMask,
                        int areaMask,
                        int timeout,
                        int cycleTime)

Starts a gateway configuration.

Parameters:

nodeMask - Bit mask of expected nodes

areaMask - Bit mask of enabled data areas (0 - 15)

timeout - Data to pluto timeout (ms)

cycleTime - Data to pluto cycle time (ms)

configDataArea

public void configDataArea(int area,
                           int pluto,
                           int dataId)

Configures an additional data area.

Parameters:

area - The data area number (0 - 31)

pluto - The pluto number

dataId - The ID of the data

configWrite

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

Writes the configuration.

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeAreaBit

public void writeAreaBit(int area,
                         int bit,
                         int value)
                  throws org.lsst.ccs.drivers.commons.DriverException

Writes a bit to a data-to-Pluto area.

Parameters:

area - The area number (0 - 3)

bit - The bit number (0 - 15)

value - The value to set (0 or 1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeAreaBits

public void writeAreaBits(int area,
                          int value)
                   throws org.lsst.ccs.drivers.commons.DriverException

Writes all bits to a data-to-Pluto area.

Parameters:

area - The area number (0 - 3)

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

readAreaBit

public int readAreaBit(int area,
                       int bit)
                throws org.lsst.ccs.drivers.commons.DriverException

Reads a bit from a data-to-Pluto area.

Parameters:

area - The area number (0 - 3)

bit - The bit number (0 - 15)

Returns:

The bit value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readAreaBits

public int readAreaBits(int area)
                 throws org.lsst.ccs.drivers.commons.DriverException

Reads all bits from a data-to-Pluto area.

Parameters:

area - The area number (0 - 3)

Returns:

The read value

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeAreaRegister

public void writeAreaRegister(int area,
                              int reg,
                              int value)
                       throws org.lsst.ccs.drivers.commons.DriverException

Writes a register to a data-to-Pluto area.

Parameters:

area - The area number (0 - 3)

reg - The register number (0 or 1)

value - The value to set (16-bit)

Throws:

org.lsst.ccs.drivers.commons.DriverException

readAreaRegister

public int readAreaRegister(int area,
                            int reg)
                     throws org.lsst.ccs.drivers.commons.DriverException

Reads a register from a data-to-Pluto area.

Parameters:

area - The area number (0 - 3)

reg - The register number (0 or 1)

Returns:

The register value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readLocalData

public int readLocalData(int pluto,
                         int type,
                         int addr)
                  throws org.lsst.ccs.drivers.commons.DriverException

Reads local data.

Parameters:

pluto - The pluto number of the module (0 - 31)

type - The type of data to read (0 - 3)

addr - The address of the data

Returns:

The 32-bit data value

Throws:

org.lsst.ccs.drivers.commons.DriverException