com.ergotech.vib.servers.modbus

Class ModbusServer

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

com.ergotech.vib.manipulators.SimpleManipulator

com.ergotech.vib.servers.plc.PLCServer

com.ergotech.vib.servers.modbus.ModbusServer

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener

Direct Known Subclasses:

Modbus0XServer, ModbusDInt, ModbusFloat, ModbusInt, ModbusPresetSingleRegisterServer, ModbusString

public class ModbusServer
extends PLCServer

This is the implementation of the Modbus protocol. This base class supports reading/writing 4X registers. Modbus devices are set up as flat memory spaces. The "registers", usually 3x and 4x addresses are 16 bit words. The coils (discrete outputs or 0x references) and the discrete (1x read references) are referenced by the bit. The count by convention from the user point of view starts at 1, from the modbus viewpoint it starts at zero. So for a 4x references the register 40001 will read the first word of the 4x address block. For 1x registers the address 10001 will read the first BIT of the 1x block. Modbus can't, per se, read bits, but reads bytes. All this becomes somewhat confusing since I want to use a similar address block object and a similar device reader for both address types. To accomodate this I provide a convetion to the offset from zero of the 16 bit word ("getWordReg") and a bit number within this word. For 3x and 4x the "getWordReg" returns the register-1, for bits it returns (reg-1)/16. For regs the bit returns 0, or some arbitrary value, for bits it return (reg%16). For completeness there is a bitCount, so that I can read an arbitary number of bits (<16) from a word or bit field. To make all this work, the server itself has the job of decoding the incoming array of values from the PLC.

Nested Class Summary

Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource

SimpleDataSource.NameEditorData

Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource

DataSource.Writable

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATA_OFFSET The location of the DATA in a Modbus message.
static int	DEC_REG Used to determine if the register was set as hex or decimal.
static int	FUNCTION The location of the FUNCTION in a Modbus message.
static int	FUNCTION_CODE_3X The function code for 3X registers.
static int	FUNCTION_CODE_4X The function code for 4X registers.
static int	HEX_REG_0x Used to determine if the register was set as hex or decimal.
static int	HEX_REG_OTHER Used to determine if the register was set as hex or decimal.
static int	ICL_STYLE Used to determine if the register was set as % (ICLinks Style).
static int	OCTAL_REG Used to determine if the register was set as hex or decimal.
static int	PERCENT_STYLE Used to determine if the register was set as %MW (Premium style).
static int	REGISTER_0X The register type 0x
static int	REGISTER_1X The register type 1x
static int	REGISTER_3X The register type 3x
static int	REGISTER_4X The register type 4x
static java.lang.String[]	registerTypeNames The names of the various register types.

Fields inherited from class com.ergotech.vib.servers.plc.PLCServer

BINARY_VALUE, BOOLEAN_VALUE, BOTHSWAP, BYTESWAP, cvsRev, DOUBLE_WORD_VALUE, FLOAT_VALUE, NOSWAP, STRING_VALUE, WORD_VALUE, WORDSWAP

Fields inherited from class com.ergotech.vib.manipulators.Manipulator

UPDATE_DISPLAYED_VALUE, VALUE_INPUT

Fields inherited from class com.ergotech.vib.servers.SimpleDataSource

customTimer, EXPORT_READ_ONLY, EXPORT_READ_WRITE, NO_EXPORT, requiresSyncWrite, sharedTimer, syncWriteTimeout, timebase

Fields inherited from class com.ergotech.vib.servers.DataSource

autoSuspend, AUTOSUSPEND_DEFAULT, AUTOSUSPEND_NEVER, AUTOSUSPEND_NO_LISTENERS, AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES, colorHi, colorHiHi, colorLo, colorLoLo, colorNormal, connectors, consoleLogger, currentColor, currentValue, debugLevel, DEFAULT_AUTOSUSPEND, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
ModbusServer() Create the ModbusServer.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddressType() Return the address type.
int	getByteOffset() Returns the offset of the register of this server.
static java.lang.String	getErrorString(byte errorCode) Maps error codes to error strings.
java.lang.String	getReg() Gets the registerNumber of the server.
int	getRegisterType() Returns the register type for this server.
int	getSwapStyle() This returns the 32 bit swap style.
int	getValueType() Returns the value type for this server.
boolean	isConfigured() Checks the address to make sure that this server is configured.
void	setReg(java.lang.String register) Sets the registerNumber of the server.
void	setRegisterType(int registerType) Set the register type for this server.
void	setSwapStyle(int swapStyle) This sets the 32 bit swap style.
void	setValueFrom(byte[] image, int offset, int quality) Update the value of the server from an address block.
void	setValueType(int valueType) Set the value type for this server.
java.lang.String	toString() returns a string representation of this server.
PLCDataBlock	validateResponse(PLCDataBlock msgOut, PLCDataBlock msgIn) Returns true if the response to a write message is correct.

Methods inherited from class com.ergotech.vib.servers.plc.PLCServer

configure, destroy, fromBCD, fromBCD, getBit, getBitCount, getDefaultQualityForLocation, getDeviceName, getDeviceServer, getDirty, getLength, getOptimizeReads, getOutputBytes, getPLCAddressBlock, getSigned, getStaticLocationFor, getStationAddress, inByteSwap, isBCD, isDirty, isSimilar, isTriggerOnThread, outByteSwap, propertyChange, setAddressType, setBCD, setBit, setBitCount, setDeviceName, setDirty, setLength, setOptimizeReads, setOutputBytes, setSigned, setStationAddress, setTimebase, setTriggerOnThread, setValueObject, shouldBeAdded, start, stop, toBCD, toBCD, triggerRead, triggerValueChanged, valueChanged, VIBEvent

Methods inherited from class com.ergotech.vib.manipulators.Manipulator

getInPortNames, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, valueInput

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTrace, tick

Methods inherited from class com.ergotech.vib.servers.DataSource

addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBooleanValue, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getScriptEngine, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, performScriptSubstitutions, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DATA_OFFSET

public static final int DATA_OFFSET

The location of the DATA in a Modbus message.

See Also:

Constant Field Values

DEC_REG

public static final int DEC_REG

Used to determine if the register was set as hex or decimal. We will present the value in the same form.

See Also:

Constant Field Values

FUNCTION

public static final int FUNCTION

The location of the FUNCTION in a Modbus message.

See Also:

Constant Field Values

FUNCTION_CODE_3X

public static final int FUNCTION_CODE_3X

The function code for 3X registers.

See Also:

Constant Field Values

FUNCTION_CODE_4X

public static final int FUNCTION_CODE_4X

The function code for 4X registers.

See Also:

Constant Field Values

HEX_REG_0x

public static final int HEX_REG_0x

Used to determine if the register was set as hex or decimal. We will present the value in the same form.

See Also:

Constant Field Values

HEX_REG_OTHER

public static final int HEX_REG_OTHER

Used to determine if the register was set as hex or decimal. We will present the value in the same form.

See Also:

Constant Field Values

ICL_STYLE

public static final int ICL_STYLE

Used to determine if the register was set as % (ICLinks Style). We will present the value in the same form.

See Also:

Constant Field Values

OCTAL_REG

public static final int OCTAL_REG

Used to determine if the register was set as hex or decimal. We will present the value in the same form.

See Also:

Constant Field Values

PERCENT_STYLE

public static final int PERCENT_STYLE

Used to determine if the register was set as %MW (Premium style). We will present the value in the same form.

See Also:

Constant Field Values

REGISTER_0X

public static final int REGISTER_0X

The register type 0x

See Also:

Constant Field Values

REGISTER_1X

public static final int REGISTER_1X

The register type 1x

See Also:

Constant Field Values

REGISTER_3X

public static final int REGISTER_3X

The register type 3x

See Also:

Constant Field Values

REGISTER_4X

public static final int REGISTER_4X

The register type 4x

See Also:

Constant Field Values

registerTypeNames

public static java.lang.String[] registerTypeNames

The names of the various register types.

Constructor Detail

ModbusServer

public ModbusServer()

Create the ModbusServer.

Method Detail

getAddressType

public java.lang.String getAddressType()

Return the address type. For example "0x", "1x", "3x", "4x", etc. The class name is also used to differentiat different types.

Overrides:

getAddressType in class PLCServer

getByteOffset

public int getByteOffset()

Returns the offset of the register of this server. The value is always returned in 8-bit bytes regardless of the length of the word.

Specified by:

getByteOffset in class PLCServer

Returns:

the register offset of the server.

getErrorString

public static java.lang.String getErrorString(byte errorCode)

Maps error codes to error strings.

Parameters:

the - error code

Returns:

the error String

getReg

public java.lang.String getReg()

Gets the registerNumber of the server.

Returns:

the register number of the server.

getRegisterType

public int getRegisterType()

Returns the register type for this server.

Returns:

one of the enumerated register types

getSwapStyle

public int getSwapStyle()

This returns the 32 bit swap style. There are four choices, no swap, word swap, byte swap or both word and byte swap.

Overrides:

getSwapStyle in class PLCServer

getValueType

public int getValueType()

Returns the value type for this server.

Returns:

one of the enumerated value types

isConfigured

public boolean isConfigured()

Checks the address to make sure that this server is configured.

Overrides:

isConfigured in class PLCServer

Returns:

true if the server is fully configured, otherwise false.

See Also:

PLCServer.isConfigured()

setReg

public void setReg(java.lang.String register)
            throws PLCException

Sets the registerNumber of the server.

Parameters:

newValue - The new value.

Throws:

PLCException

See Also:

DataSource#setParameters

setRegisterType

public void setRegisterType(int registerType)

Set the register type for this server. This should be one of the enumerations above.

Parameters:

valueType - the value type for this server

setSwapStyle

public void setSwapStyle(int swapStyle)

This sets the 32 bit swap style. There are four choices, no swap, word swap, byte swap or both word and byte swap.

Overrides:

setSwapStyle in class PLCServer

setValueFrom

public void setValueFrom(byte[] image,
                         int offset,
                         int quality)
                  throws java.lang.ArrayIndexOutOfBoundsException

Update the value of the server from an address block.

Specified by:

setValueFrom in class PLCServer

Parameters:

image - the registers read from the PLC. This is the raw register values in PLC format. That is, no swapping, or other processing.

offset - the offset from the start of the image of the raw register data.

quality - the quality flag for the data

Throws:

java.lang.ArrayIndexOutOfBoundsException

setValueType

public void setValueType(int valueType)

Set the value type for this server. This should be one of the enumerations above.

Parameters:

valueType - the value type for this server

toString

public java.lang.String toString()

returns a string representation of this server.

Overrides:

toString in class PLCServer

Returns:

a string description of this server

validateResponse

public PLCDataBlock validateResponse(PLCDataBlock msgOut,
                                     PLCDataBlock msgIn)
                              throws PLCException

Returns true if the response to a write message is correct.

Specified by:

validateResponse in class PLCServer

Throws:

PLCException