org.lsst.ccs.drivers.modbus

Class Modbus

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.modbus.Modbus

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

public class Modbus
extends org.lsst.ccs.drivers.ascii.Ascii

Communicates via the Modbus protocol on a serial line or network socket

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Modbus.ConnType Private & package data.

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

Constructor Summary

Constructors

Constructor and Description
Modbus()

Method Summary

Modifier and Type	Method and Description
boolean	isAddressMode() Returns whether entity numbers are direct addresses.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type, String ident, int parm1, int parm2) Opens a connection to the Modbus.
void	open(Modbus.ConnType type, String ident) Opens a connection to the Modbus.
void	open(Modbus.ConnType type, String ident, int parm1) Opens a connection to the Modbus.
void	open(Modbus.ConnType type, String ident, int parm1, int parm2) Opens a connection to the Modbus.
byte[]	readCoils(short dAddr, short cNmbr, short count) Reads a set of coils
byte[]	readDiscretes(short dAddr, short iNmbr, short count) Reads a set of discrete inputs
short[]	readInputs(short dAddr, short rNmbr, short count) Reads a set of input registers
short[]	readRegisters(short dAddr, short rNmbr, short count) Reads a set of holding registers
void	setAddressMode(boolean mode) Sets whether entity numbers are direct addresses.
void	setExceptionMap(Map<Integer,String> map) Sets the additional exception description map.
void	writeCoil(short dAddr, short cNmbr, boolean value) Writes a coil
void	writeCoils(short dAddr, short cNmbr, short count, byte[] value) Writes a set of coils
void	writeRegister(short dAddr, short rNmbr, short value) Writes a holding register
void	writeRegisters(short dAddr, short rNmbr, short[] value) Writes a set of holding registers

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

close, closeSilent, flush, getConnTimeout, getTimeout, isDropEcho, isOpen, makeDataCharacteristics, open, open, openFtdi, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, openSerial, read, read, readBytes, readBytes, setCommandTerm, setConnTimeout, setConnTimeout, setDefaultBaud, setDefaultParm, setDefaultPort, 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

Constructor Detail

Modbus

public Modbus()

Method Detail

open

public void open(Modbus.ConnType type,
                 String ident,
                 int parm1,
                 int parm2)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the Modbus.

Parameters:

type - The type of connection to make

ident - The device identifier: host name or IP address for network; port name for serial

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

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(Modbus.ConnType type,
                 String ident,
                 int parm1)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the Modbus.

Parameters:

type - The type of connection to make

ident - The device identifier: host name or IP address for network; port name for serial

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(Modbus.ConnType type,
                 String ident)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the Modbus.

Parameters:

type - The type of connection to make

ident - The device identifier: host name or IP address for network; port name for serial

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type,
                 String ident,
                 int parm1,
                 int parm2)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the Modbus. This overrides Ascii.open, so doesn't support Ascii Modbus

Overrides:

open in class org.lsst.ccs.drivers.ascii.Ascii

Parameters:

type - The type of connection to make

ident - The device identifier: host name or IP address for network; port name for serial

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

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

setAddressMode

public void setAddressMode(boolean mode)

Sets whether entity numbers are direct addresses. The usual Modbus convention is that holding register numbers, etc, start from 1, so that 1 has to be subtracted in order to generate the actual address. However, some devices provide the direct address in their documentation.

Parameters:

mode - Whether or not address mode is to be set

isAddressMode

public boolean isAddressMode()

Returns whether entity numbers are direct addresses.

Returns:

Whether or not address mode is set

setExceptionMap

public void setExceptionMap(Map<Integer,String> map)

Sets the additional exception description map.

Parameters:

map - The map of additional codes to descriptions

readCoils

public byte[] readCoils(short dAddr,
                        short cNmbr,
                        short count)
                 throws org.lsst.ccs.drivers.commons.DriverException

Reads a set of coils

Parameters:

dAddr - The Modbus address of the device

cNmbr - The number of the first coil to read

count - The number of coils to read

Returns:

The array of read coil values, one per bit

Throws:

org.lsst.ccs.drivers.commons.DriverException

readDiscretes

public byte[] readDiscretes(short dAddr,
                            short iNmbr,
                            short count)
                     throws org.lsst.ccs.drivers.commons.DriverException

Reads a set of discrete inputs

Parameters:

dAddr - The Modbus address of the device

iNmbr - The number of the first input to read

count - The number of inputs to read

Returns:

The array of read discrete values, one per bit

Throws:

org.lsst.ccs.drivers.commons.DriverException

readRegisters

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

Reads a set of holding registers

Parameters:

dAddr - The Modbus address of the device

rNmbr - The number of the first register to read

count - The number of registers to read

Returns:

The array of read register values

Throws:

org.lsst.ccs.drivers.commons.DriverException

readInputs

public short[] readInputs(short dAddr,
                          short rNmbr,
                          short count)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads a set of input registers

Parameters:

dAddr - The Modbus address of the device

rNmbr - The number of the first register to read

count - The number of registers to read

Returns:

The array of read register values

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeRegister

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

Writes a holding register

Parameters:

dAddr - The Modbus address of the device

rNmbr - The number of the register to write

value - The (16-bit) value to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeCoil

public void writeCoil(short dAddr,
                      short cNmbr,
                      boolean value)
               throws org.lsst.ccs.drivers.commons.DriverException

Writes a coil

Parameters:

dAddr - The Modbus address of the device

cNmbr - The number of the coil to write

value - The value (false = off, true = on) to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeRegisters

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

Writes a set of holding registers

Parameters:

dAddr - The Modbus address of the device

rNmbr - The number of the first register to write

value - The array of register values to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeCoils

public void writeCoils(short dAddr,
                       short cNmbr,
                       short count,
                       byte[] value)
                throws org.lsst.ccs.drivers.commons.DriverException

Writes a set of coils

Parameters:

dAddr - The Modbus address of the device

cNmbr - The number of the first coil to write

count - The number of coil values to write

value - The array of coil values to write

Throws:

org.lsst.ccs.drivers.commons.DriverException