com.intelligt.modbus.jlibmodbus

Class Modbus

java.lang.Object

com.intelligt.modbus.jlibmodbus.Modbus

public final class Modbus
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Modbus.LogLevel logging.Level wrapper.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASCII_CODE_COLON
static int	ASCII_CODE_CR
static int	ASCII_CODE_LF
static int	BROADCAST_ID
static int	COIL_VALUE_OFF
static int	COIL_VALUE_ON
static int	DEFAULT_READ_TIMEOUT
static int	MAX_CONNECTION_TIMEOUT
static int	MAX_FIFO_COUNT
static int	MAX_PDU_LENGTH
static int	MAX_READ_COIL_COUNT
static int	MAX_READ_REGISTER_COUNT
static int	MAX_REGISTER_VALUE
static int	MAX_RESPONSE_TIMEOUT
static int	MAX_RTU_ADU_LENGTH
static int	MAX_SERVER_ADDRESS
static int	MAX_START_ADDRESS
static int	MAX_WRITE_COIL_COUNT
static int	MAX_WRITE_REGISTER_COUNT
static int	MIN_PDU_LENGTH
static int	MIN_SERVER_ADDRESS
static int	MIN_START_ADDRESS
static int	PROTOCOL_ID
static int	TCP_DEFAULT_ID
static int	TCP_PORT
static int	TRANSACTION_ID_MAX_VALUE

Method Summary

Modifier and Type	Method and Description
static boolean	checkEndAddress(int value) validates end address for read/write end address = start address + quantity
static boolean	checkReadCoilCount(int value) validates number of coils for read
static boolean	checkReadRegisterCount(int value) validates number of registers for read
static boolean	checkRegisterValue(int value) validates register value
static boolean	checkServerAddress(int serverAddress) validates address of server
static boolean	checkStartAddress(int value) validates start address for read/write
static boolean	checkWriteCoilCount(int value) validates number of coils for write
static boolean	checkWriteRegisterCount(int value) validates number of registers for write
static int	fromCoil(boolean c) converts boolean to ON/OFF value
static int	getAsciiMsgDelimiter()
static Modbus.LogLevel	getLogLevel() getter for log level
static String	getVersion() getter for the version of the library.
static boolean	isAutoIncrementTransactionId() returns autoIncrementTransactionId variable
static boolean	isLoggingEnabled()
static Logger	log() getter for default logger
static void	setAsciiInputDelimiter(int asciiMsgDelimiter)
static void	setAutoIncrementTransactionId(boolean autoIncrementTransactionId) activates auto increment of TransactionId field. if you do not use ModbusTCP, invocation has no effect.
static void	setLogLevel(Modbus.LogLevel level) changes the log level for all loggers used
static boolean	toCoil(int s) converts ON/OFF value to boolean

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_CONNECTION_TIMEOUT

public static final int MAX_CONNECTION_TIMEOUT

See Also:

Constant Field Values

MAX_RESPONSE_TIMEOUT

public static final int MAX_RESPONSE_TIMEOUT

See Also:

Constant Field Values

MAX_PDU_LENGTH

public static final int MAX_PDU_LENGTH

See Also:

Constant Field Values

MIN_PDU_LENGTH

public static final int MIN_PDU_LENGTH

See Also:

Constant Field Values

MAX_RTU_ADU_LENGTH

public static final int MAX_RTU_ADU_LENGTH

See Also:

Constant Field Values

MAX_REGISTER_VALUE

public static final int MAX_REGISTER_VALUE

See Also:

Constant Field Values

MIN_START_ADDRESS

public static final int MIN_START_ADDRESS

See Also:

Constant Field Values

MAX_START_ADDRESS

public static final int MAX_START_ADDRESS

See Also:

Constant Field Values

MAX_READ_COIL_COUNT

public static final int MAX_READ_COIL_COUNT

See Also:

Constant Field Values

MAX_WRITE_COIL_COUNT

public static final int MAX_WRITE_COIL_COUNT

See Also:

Constant Field Values

MAX_READ_REGISTER_COUNT

public static final int MAX_READ_REGISTER_COUNT

See Also:

Constant Field Values

MAX_WRITE_REGISTER_COUNT

public static final int MAX_WRITE_REGISTER_COUNT

See Also:

Constant Field Values

MAX_FIFO_COUNT

public static final int MAX_FIFO_COUNT

See Also:

Constant Field Values

MIN_SERVER_ADDRESS

public static final int MIN_SERVER_ADDRESS

See Also:

Constant Field Values

MAX_SERVER_ADDRESS

public static final int MAX_SERVER_ADDRESS

See Also:

Constant Field Values

TCP_PORT

public static final int TCP_PORT

See Also:

Constant Field Values

PROTOCOL_ID

public static final int PROTOCOL_ID

See Also:

Constant Field Values

TCP_DEFAULT_ID

public static final int TCP_DEFAULT_ID

See Also:

Constant Field Values

BROADCAST_ID

public static final int BROADCAST_ID

See Also:

Constant Field Values

ASCII_CODE_CR

public static final int ASCII_CODE_CR

See Also:

Constant Field Values

ASCII_CODE_LF

public static final int ASCII_CODE_LF

See Also:

Constant Field Values

ASCII_CODE_COLON

public static final int ASCII_CODE_COLON

See Also:

Constant Field Values

COIL_VALUE_ON

public static final int COIL_VALUE_ON

See Also:

Constant Field Values

COIL_VALUE_OFF

public static final int COIL_VALUE_OFF

See Also:

Constant Field Values

TRANSACTION_ID_MAX_VALUE

public static final int TRANSACTION_ID_MAX_VALUE

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT

See Also:

Constant Field Values

Method Detail

getVersion

public static String getVersion()

getter for the version of the library.

Returns:

a string representing the version

setAsciiInputDelimiter

public static void setAsciiInputDelimiter(int asciiMsgDelimiter)

getAsciiMsgDelimiter

public static int getAsciiMsgDelimiter()

getLogLevel

public static Modbus.LogLevel getLogLevel()

getter for log level

Returns:

current log level

setLogLevel

public static void setLogLevel(Modbus.LogLevel level)

changes the log level for all loggers used

Parameters:

level - - LogLevel instance

See Also:

Modbus.LogLevel

isLoggingEnabled

public static boolean isLoggingEnabled()

log

public static Logger log()

getter for default logger

Returns:

default logger

toCoil

public static boolean toCoil(int s)

converts ON/OFF value to boolean

Parameters:

s - 0xFF00 of 0x0000

Returns:

true if s equals 0xFF00, else false

fromCoil

public static int fromCoil(boolean c)

converts boolean to ON/OFF value

Parameters:

c - a coil value

Returns:

0xFF00 if coil value is true, else 0x0000

checkServerAddress

public static boolean checkServerAddress(int serverAddress)

validates address of server

Parameters:

serverAddress - - The modbus server address

Returns:

"true" if serverAddress is correct, else "false".

checkReadRegisterCount

public static boolean checkReadRegisterCount(int value)

validates number of registers for read

Parameters:

value - - register count

Returns:

"true" if quantity is correct, else "false".

checkWriteRegisterCount

public static boolean checkWriteRegisterCount(int value)

validates number of registers for write

Parameters:

value - - register count

Returns:

"true" if quantity is correct, else "false".

checkReadCoilCount

public static boolean checkReadCoilCount(int value)

validates number of coils for read

Parameters:

value - - coil count

Returns:

"true" if quantity is correct, else "false".

checkWriteCoilCount

public static boolean checkWriteCoilCount(int value)

validates number of coils for write

Parameters:

value - - coil count

Returns:

"true" if quantity is correct, else "false".

checkStartAddress

public static boolean checkStartAddress(int value)

validates start address for read/write

Parameters:

value - - start address

Returns:

"true" if start address is correct, else "false".

checkEndAddress

public static boolean checkEndAddress(int value)

validates end address for read/write end address = start address + quantity

Parameters:

value - - end address

Returns:

"true" if end address is correct, else "false".

checkRegisterValue

public static boolean checkRegisterValue(int value)

validates register value

Parameters:

value - - value of register

Returns:

"true" if register value is correct, else "false".

isAutoIncrementTransactionId

public static boolean isAutoIncrementTransactionId()

returns autoIncrementTransactionId variable

Returns:

"true" if autoincrement of TransactionId field is enabled, else "false".

setAutoIncrementTransactionId

public static void setAutoIncrementTransactionId(boolean autoIncrementTransactionId)

activates auto increment of TransactionId field. if you do not use ModbusTCP, invocation has no effect.

Parameters:

autoIncrementTransactionId - - new value of the autoIncrementTransactionId variable