kernel.modbus.ModbusPortConfiguration Interface Reference

Inheritance diagram for kernel.modbus.ModbusPortConfiguration:

Collaboration diagram for kernel.modbus.ModbusPortConfiguration:

Public Member Functions
String	getEncoding ()
void	setEncoding (String encoding)
String	getPortName ()
void	setPortName (String portName)
SerialParameters	getSerialParameters ()
void	setBaudRate (int baudRate) throws IllegalArgumentException
void	setDataBits (int dataBits)
void	setStopBits (int stopBits)
void	setParityBits (int parityBits)
Public Member Functions inherited from kernel.serial_ports.PortConfiguration
int	getBaudRate ()
int	getDataBits ()
int	getParityBits ()
int	getStopBits ()

Public Attributes
String	ASCII_ENCODING = Modbus.SERIAL_ENCODING_ASCII
String	RTU_ENCODING = Modbus.SERIAL_ENCODING_RTU
int	BAUD_RATE_19200 = 19200
Public Attributes inherited from kernel.serial_ports.PortConfiguration
int	DATABITS_8 = RXTXPort.DATABITS_8
int	BAUD_RATE_9600 = 9600
int	PARITY_NONE = RXTXPort.PARITY_NONE
int	STOPBITS_1 = RXTXPort.STOPBITS_1

Detailed Description

A wrapper to configure serial ports using the MODBUS protocol

Definition at line 10 of file ModbusPortConfiguration.java.

Member Function Documentation

String kernel.modbus.ModbusPortConfiguration.getEncoding

(

)

Returns

the encoding used

Implemented in kernel.modbus.StandaloneModbusPortConfiguration.

String kernel.modbus.ModbusPortConfiguration.getPortName

(

)

Returns

The name of the port to use

Implemented in kernel.modbus.StandaloneModbusPortConfiguration.

SerialParameters kernel.modbus.ModbusPortConfiguration.getSerialParameters

(

)

Returns

An instance of SerialParameters that MODBUS can then parse in order to establish a connection.

Implemented in kernel.modbus.StandaloneModbusPortConfiguration.

void kernel.modbus.ModbusPortConfiguration.setBaudRate

(

int

baudRate

)

throws IllegalArgumentException

Parameters

baudRate

The desired Baud rate

Exceptions

IllegalArgumentException

If the baud rate is less than 0, or some un-allowed value

Implemented in kernel.modbus.StandaloneModbusPortConfiguration.

void kernel.modbus.ModbusPortConfiguration.setDataBits

(

int

dataBits

)

Parameters

dataBits

The data bits in an RS232 frame

Implemented in kernel.modbus.StandaloneModbusPortConfiguration.

void kernel.modbus.ModbusPortConfiguration.setEncoding

(

String

encoding

)

Parameters

encoding

The string encoding to use

Implemented in kernel.modbus.StandaloneModbusPortConfiguration.

void kernel.modbus.ModbusPortConfiguration.setParityBits

(

int

parityBits

)

Parameters

parityBits

The number of parity bits

Implemented in kernel.modbus.StandaloneModbusPortConfiguration.

void kernel.modbus.ModbusPortConfiguration.setPortName

(

String

portName

)

Parameters

portName

The port name to use

Implemented in kernel.modbus.StandaloneModbusPortConfiguration.

void kernel.modbus.ModbusPortConfiguration.setStopBits

(

int

stopBits

)

Parameters

stopBits

The number of stop bits in the RS232 connection

Implemented in kernel.modbus.StandaloneModbusPortConfiguration.

Member Data Documentation

String kernel.modbus.ModbusPortConfiguration.ASCII_ENCODING = Modbus.SERIAL_ENCODING_ASCII

Represents a serial encoding where data is transmitted in ASCII characters.

Definition at line 16 of file ModbusPortConfiguration.java.

int kernel.modbus.ModbusPortConfiguration.BAUD_RATE_19200 = 19200

The desired baud rate. Currently, the baud rate for the PVCi gauge is set to the recommended rate of 19200 bits per second.

Definition at line 29 of file ModbusPortConfiguration.java.

String kernel.modbus.ModbusPortConfiguration.RTU_ENCODING = Modbus.SERIAL_ENCODING_RTU

Short for "Remote Terminal Unit," this encoding represents the data encoding used by the PVCi IGC3 gauge, where data is sent in binary with a 16-bit cyclic redundancy check (CRC) placed after the message

Definition at line 23 of file ModbusPortConfiguration.java.

---

The documentation for this interface was generated from the following file:

• ModbusPortConfiguration.java