com.ergotech.vib.servers.modbus

Class Modbus0XServer

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

com.ergotech.vib.servers.modbus.Modbus0XServer

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener

Direct Known Subclasses:

Modbus1XServer

public class Modbus0XServer
extends ModbusServer

This is the implementation of the Modbus protocol. This class supports reading/writing 0X registers. 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.

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 java.lang.String	cvsRev

Fields inherited from class com.ergotech.vib.servers.modbus.ModbusServer

DATA_OFFSET, DEC_REG, FUNCTION, FUNCTION_CODE_3X, FUNCTION_CODE_4X, HEX_REG_0x, HEX_REG_OTHER, ICL_STYLE, OCTAL_REG, PERCENT_STYLE, REGISTER_0X, REGISTER_1X, REGISTER_3X, REGISTER_4X, registerTypeNames

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

BINARY_VALUE, BOOLEAN_VALUE, BOTHSWAP, BYTESWAP, 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
Modbus0XServer() Create the Modbus0XServer.

Method Summary

Modifier and Type	Method and Description
int	getByteOffset() Returns the offset of the register of this server.
java.lang.String	getReg() Gets the registerNumber of the server.
void	setReg(java.lang.String register) Sets the registerNumber of the server.
void	setValueFrom(byte[] image, int offset, int quality) Update the value of the server from an address block.

Methods inherited from class com.ergotech.vib.servers.modbus.ModbusServer

getAddressType, getErrorString, getRegisterType, getSwapStyle, getValueType, isConfigured, setRegisterType, setSwapStyle, setValueType, toString, validateResponse

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

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Constructor Detail

Modbus0XServer

public Modbus0XServer()

Create the Modbus0XServer.

Method Detail

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.

Overrides:

getByteOffset in class ModbusServer

Returns:

the register offset of the server.

getReg

public java.lang.String getReg()

Gets the registerNumber of the server.

Overrides:

getReg in class ModbusServer

Returns:

the register number of the server.

setReg

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

Sets the registerNumber of the server.

Overrides:

setReg in class ModbusServer

Parameters:

newValue - The new value.

Throws:

PLCException

See Also:

DataSource#setParameters

setValueFrom

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

Update the value of the server from an address block.

Overrides:

setValueFrom in class ModbusServer

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