com.ergotech.vib.servers.melsec

Class MelsecServer

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.melsec.MelsecServer

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener

Direct Known Subclasses:

MelsecBinary, MelsecDInt, MelsecFloat, MelsecString

public class MelsecServer
extends PLCServer

Server for Melsec

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	ADDRESS_REGEX
static int	maxBlockSize The maximum allowable block size for an address block.

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
MelsecServer() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddress() Returns the PLC address.
int	getByteOffset() Returns the offset of the register of this server.
boolean	getByteSwapString() Returns whether strings are byte-swapped.
int	getDeviceCode() Returns the device code of this server.
static java.lang.String	getErrorString(int errorCode) Maps error codes to error strings.
int	getMemoryAddress()
int	getValueType() Returns the value type for this server.
boolean	isConfigured() Returns true if the configuration of this server is complete.
static void	outByteSwap(int value, int swapFormat, byte[] buf, int offset) This method will swap the bytes in the value according to the swap format.
void	setAddress(java.lang.String address) Sets the PLC address.
void	setByteSwapString(boolean byteSwapString) Sets whether strings are byte-swapped.
void	setLength(int length) sets the number of bytes that need to be read to satisfy this server.
void	setValueFrom(byte[] image, int offset, int quality) Update the value of the server from an address block Response: 0xD0 0x00 - 3E frame response message header 0x00 - network number 0xFF pc number 0xFF 0x03 - request destination module I/O number 0x00 - request destination module station number 0x06 0x00 - response data length (from after here to the end of the message).
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 message is correct.

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

configure, destroy, fromBCD, fromBCD, getAddressType, getBit, getBitCount, getDefaultQualityForLocation, getDeviceName, getDeviceServer, getDirty, getLength, getOptimizeReads, getOutputBytes, getPLCAddressBlock, getSigned, getStaticLocationFor, getStationAddress, getSwapStyle, inByteSwap, isBCD, isDirty, isSimilar, isTriggerOnThread, propertyChange, setAddressType, setBCD, setBit, setBitCount, setDeviceName, setDirty, setOptimizeReads, setOutputBytes, setSigned, setStationAddress, setSwapStyle, 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

ADDRESS_REGEX

public static final java.lang.String ADDRESS_REGEX

See Also:

Constant Field Values

maxBlockSize

public static int maxBlockSize

The maximum allowable block size for an address block.

Constructor Detail

MelsecServer

public MelsecServer()

Default constructor.

Method Detail

getAddress

public java.lang.String getAddress()

Returns the PLC address.

Returns:

the PLC address.

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.

getByteSwapString

public boolean getByteSwapString()

Returns whether strings are byte-swapped.

getDeviceCode

public int getDeviceCode()

Returns the device code of this server.

getErrorString

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

Maps error codes to error strings.

Parameters:

the - error code

Returns:

the error String

getMemoryAddress

public int getMemoryAddress()

Returns:

the memoryAddress

getValueType

public int getValueType()

Returns the value type for this server.

Returns:

one of the enumerated value types

isConfigured

public boolean isConfigured()

Description copied from class: PLCServer

Returns true if the configuration of this server is complete. This is called before attempting to add the server to an Address Block or a device.

Overrides:

isConfigured in class PLCServer

Returns:

true if the server is fully configured, otherwise false.

outByteSwap

public static void outByteSwap(int value,
                               int swapFormat,
                               byte[] buf,
                               int offset)

This method will swap the bytes in the value according to the swap format. This is subclassed to account for the byte-ordering of the read (lsb first).

Parameters:

value - the value to swap

swapFormat - the swap style to use, the should be on of the defined types WORDSWAP, NOSWAP, BYTESWAP, BOTHSWAP

buf - the bytes are swapped into the buffer which is assumed to have enough space to hold them

offset - the starting offset in the buffer

setAddress

public void setAddress(java.lang.String address)
                throws PLCException

Sets the PLC address. We use regular expressions to find the longest string that doesn't have number. (^[A-Z#]*) and then sequentially compare that the to start addresses so that we can map to the device code.

Parameters:

address - The new value.

Throws:

PLCException

setByteSwapString

public void setByteSwapString(boolean byteSwapString)

Sets whether strings are byte-swapped.

setLength

public void setLength(int length)

sets the number of bytes that need to be read to satisfy this server.

Overrides:

setLength 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 Response: 0xD0 0x00 - 3E frame response message header 0x00 - network number 0xFF pc number 0xFF 0x03 - request destination module I/O number 0x00 - request destination module station number 0x06 0x00 - response data length (from after here to the end of the message). 0x00 0x00 - completion code response data words

Specified by:

setValueFrom in class PLCServer

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 message is correct.

Specified by:

validateResponse in class PLCServer

Throws:

PLCException