ModbusProtocolDeviceService (kura 1.0.0 API)

Field Summary

Fields
Modifier and Type Field and Description

static String SERVICE_NAME
name of this service

Fields
Modifier and Type	Field and Description
`static String`	`SERVICE_NAME` name of this service

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`configureConnection(Properties connectionConfig)` Configure access to the physical device.
`void`	`connect()` attempt to connect to the field device using the provided configuration.
`void`	`disconnect()` attempt to disconnect from the field device.
`ModbusCommEvent`	`getCommEventCounter(int unitAddr)` Modbus function 11 (0x0B) Get a status word and an event count from the device. Return values in a ModbusCommEvent.
`ModbusCommEvent`	`getCommEventLog(int unitAddr)` Modbus function 12 (0x0C) Get a status word, an event count, a message count and a list of event bytes from the device. Return values in a ModbusCommEvent.
`int`	`getConnectStatus()` for expedience, can test the status of the connection prior to attempting a command.
`String`	`getProtocolName()` returns the protocol name for the specific protocol implemented.
`boolean[]`	`readCoils(int unitAddr, int dataAddress, int count)` Modbus function 01 Read 1 to 2000 contiguous status of coils from the attached field device.
`boolean[]`	`readDiscreteInputs(int unitAddr, int dataAddress, int count)` Modbus function 02 Read 1 to 2000 contiguous status of discrete inputs from the attached field device.
`boolean[]`	`readExceptionStatus(int unitAddr)` Modbus function 07 read the content of 8 Exception Status outputs in the field device.
`int[]`	`readHoldingRegisters(int unitAddr, int dataAddress, int count)` Modbus function 03 Read contents of 1 to 125 contiguous block of holding registers from the attached field device.
`int[]`	`readInputRegisters(int unitAddr, int dataAddress, int count)` Modbus function 04 Read contents of 1 to 125 contiguous block of input registers from the attached field device.
`String`	`toString()` returns the unit name given in the configureProtocol call.
`void`	`writeMultipleCoils(int unitAddr, int dataAddress, boolean[] data)` Modbus function 15 (0x0F) write multiple coils in a sequence of coils to either ON or OFF in the attached field device.
`void`	`writeMultipleRegister(int unitAddr, int dataAddress, int[] data)` Modbus function 16 (0x10) write a block of contiguous registers (1 to 123) in the attached field device.
`void`	`writeSingleCoil(int unitAddr, int dataAddress, boolean data)` Modbus function 05 write a single output to either ON or OFF in the attached field device.
`void`	`writeSingleRegister(int unitAddr, int dataAddress, int data)` Modbus function 06 write a single holding register in the attached field device.

- Field Detail
  - SERVICE_NAME
```
static final String SERVICE_NAME
```
    name of this service
- Method Detail
  - toString
```
String toString()
```
    returns the unit name given in the configureProtocol call. Prior to configuration, this method will return the built-in name of the protocol, the same as returned by getProtocolName.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    assigned unit name
    See Also:
    Object.toString()
  - getProtocolName
```
String getProtocolName()
```
    returns the protocol name for the specific protocol implemented. This name should follow Java member naming conventions, so the first (or only) part of the name should be all lower case, all subsequent parts to the name should begin with an upper case and continue with lower case.
    
    Returns:
    name following the above rules
  - configureConnection
```
void configureConnection(Properties connectionConfig)
                         throws ModbusProtocolException
```
    Configure access to the physical device.
    
    Parameters:
    connectionConfig - (key/value pairing directly from configuration file)
    
    connectionType : PROTOCOL_CONNECTION_TYPE_SERIAL("SERIAL") or PROTOCOL_CONNECTION_TYPE_ETHER_TCP("ETHERTCP")
    
    for SERIAL mode :
    port : Name of the port ("/dev/ttyUSB0")
    baudRate : baudrate
    stopBits : number of stopbits
    parity : parity mode (0=none, 1=odd, 2=even)
    bitsPerWord : number of bits per word
    serialMode : Serial Mode : SERIAL_232("RS232") or SERIAL_485("RS485").
    if SERIAL_485
    serialGPIOswitch : pin number as a filename in "/sys/class/gpio/"
    serialGPIOrsmode : pin number as a filename in "/sys/class/gpio/"
    
    for ETHERNET mode :
    port : TCP port to be used
    ipAddress : the 4 octet IP address of the field device (xxx.xxx.xxx.xxx)
    
    Modbus properties :
    transmissionMode : modbus transmission mode, can be RTU or ASCII, in Ethernet mode only RTU is supported
    respTimeout : Timeout in milliseconds on a question/response request.
    
    Throws:
    
    ModbusProtocolException(INVALID_CONFIGURATION) - unspecified problem with the configuration
    
    ModbusProtocolException
  - getConnectStatus
```
int getConnectStatus()
```
    for expedience, can test the status of the connection prior to attempting a command. A connection status of CONNECTED does not assure that a subsequent command will succeed.
    All protocols must implement this method.
    
    Returns:
    current connection status as defined in KuraConnectionStatus.
  - connect
```
void connect()
             throws ModbusProtocolException
```
    attempt to connect to the field device using the provided configuration. Attempts to connect before configuring the connection or any issues with connecting to the field device will result in an exception being thrown. This includes things like a networking failure in the case of a protocol configured to access the field device of a network.
    Refer to getConnectStatus to determine if the connection is completed.
    All protocols must implement this method.
    
    Throws:
    
    ModbusProtocolException(INVALID_CONFIGURATION) - this operates on the basic assumption that access to a device should exist, if the device is unreachable, it is interpreted as a failure of the configuration.
    
    ModbusProtocolException
  - disconnect
```
void disconnect()
                throws ModbusProtocolException
```
    attempt to disconnect from the field device. This should close any port used exclusively for this protocol to talk with its attached device. Attempting to close an already closed connection is not invalid.
    All protocols must implement this method.
    
    Throws:
    
    ModbusProtocolException
    See Also:
    getConnectStatus()
  - readCoils
```
boolean[] readCoils(int unitAddr,
                  int dataAddress,
                  int count)
                    throws ModbusProtocolException
```
    Modbus function 01
    Read 1 to 2000 contiguous status of coils from the attached field device.
    
    Parameters:
    unitAddr - modbus slave address (must be unique in the range 1 - 247)
    dataAddress - starting address
    count - quantity of coils
    
    Returns:
    an array of booleans representing the requested data points. true for a given point if the point is set, false otherwise.
    
    Throws:
    
    ModbusProtocolException(NOT_CONNECTED) - current connection is in a status other than CONNECTED
    
    ModbusProtocolException(TRANSACTION_FAILURE) - should include a protocol specific message to help clarify the cause of the exception
    
    ModbusProtocolException
  - readDiscreteInputs
```
boolean[] readDiscreteInputs(int unitAddr,
                           int dataAddress,
                           int count)
                             throws ModbusProtocolException
```
    Modbus function 02
    Read 1 to 2000 contiguous status of discrete inputs from the attached field device.
    
    Parameters:
    unitAddr - modbus slave address (must be unique in the range 1 - 247)
    dataAddress - starting address
    count - quantity of inputs
    
    Returns:
    an array of booleans representing the requested data points. true for a given point if the point is set, false otherwise.
    
    Throws:
    
    ModbusProtocolException(NOT_CONNECTED) - current connection is in a status other than CONNECTED
    
    ModbusProtocolException(TRANSACTION_FAILURE) - should include a protocol specific message to help clarify the cause of the exception
    
    ModbusProtocolException
  - writeSingleCoil
```
void writeSingleCoil(int unitAddr,
                   int dataAddress,
                   boolean data)
                     throws ModbusProtocolException
```
    Modbus function 05
    write a single output to either ON or OFF in the attached field device.
    
    Parameters:
    unitAddr - modbus slave address (must be unique in the range 1 - 247)
    dataAddress - Output address.
    data - Output value (boolean) to write.
    
    Throws:
    
    ModbusProtocolException(NOT_CONNECTED) - current connection is in a status other than CONNECTED
    
    ModbusProtocolException(TRANSACTION_FAILURE) - should include a protocol specific message to help clarify the cause of the exception
    
    ModbusProtocolException
  - writeMultipleCoils
```
void writeMultipleCoils(int unitAddr,
                      int dataAddress,
                      boolean[] data)
                        throws ModbusProtocolException
```
    Modbus function 15 (0x0F)
    write multiple coils in a sequence of coils to either ON or OFF in the attached field device.
    
    Parameters:
    unitAddr - modbus slave address (must be unique in the range 1 - 247)
    dataAddress - Starting Output address.
    data - Outputs value (array of boolean) to write.
    
    Throws:
    
    ModbusProtocolException(NOT_CONNECTED) - current connection is in a status other than CONNECTED
    
    ModbusProtocolException(TRANSACTION_FAILURE) - should include a protocol specific message to help clarify the cause of the exception
    
    ModbusProtocolException
  - readHoldingRegisters
```
int[] readHoldingRegisters(int unitAddr,
                         int dataAddress,
                         int count)
                           throws ModbusProtocolException
```
    Modbus function 03
    Read contents of 1 to 125 contiguous block of holding registers from the attached field device.
    
    Parameters:
    unitAddr - modbus slave address (must be unique in the range 1 - 247)
    dataAddress - starting address
    count - quantity of registers (maximum 0x7D)
    
    Returns:
    an array of int representing the requested data points (data registers on 2 bytes).
    
    Throws:
    
    ModbusProtocolException(NOT_CONNECTED) - current connection is in a status other than CONNECTED
    
    ModbusProtocolException(TRANSACTION_FAILURE) - should include a protocol specific message to help clarify the cause of the exception
    
    ModbusProtocolException
  - readInputRegisters
```
int[] readInputRegisters(int unitAddr,
                       int dataAddress,
                       int count)
                         throws ModbusProtocolException
```
    Modbus function 04
    Read contents of 1 to 125 contiguous block of input registers from the attached field device.
    
    Parameters:
    unitAddr - modbus slave address (must be unique in the range 1 - 247)
    dataAddress - starting address
    count - quantity of registers (maximum 0x7D)
    
    Returns:
    an array of int representing the requested data points (data registers on 2 bytes).
    
    Throws:
    
    ModbusProtocolException(NOT_CONNECTED) - current connection is in a status other than CONNECTED
    
    ModbusProtocolException(TRANSACTION_FAILURE) - should include a protocol specific message to help clarify the cause of the exception
    
    ModbusProtocolException
  - writeSingleRegister
```
void writeSingleRegister(int unitAddr,
                       int dataAddress,
                       int data)
                         throws ModbusProtocolException
```
    Modbus function 06
    write a single holding register in the attached field device.
    
    Parameters:
    unitAddr - modbus slave address (must be unique in the range 1 - 247)
    dataAddress - Output address.
    data - Output value (2 bytes) to write.
    
    Throws:
    
    ModbusProtocolException(NOT_CONNECTED) - current connection is in a status other than CONNECTED
    
    ModbusProtocolException(TRANSACTION_FAILURE) - should include a protocol specific message to help clarify the cause of the exception
    
    ModbusProtocolException
  - readExceptionStatus
```
boolean[] readExceptionStatus(int unitAddr)
                              throws ModbusProtocolException
```
    Modbus function 07
    read the content of 8 Exception Status outputs in the field device.
    
    Parameters:
    unitAddr - modbus slave address (must be unique in the range 1 - 247)
    
    Throws:
    
    ModbusProtocolException(NOT_CONNECTED) - current connection is in a status other than CONNECTED
    
    ModbusProtocolException(TRANSACTION_FAILURE) - should include a protocol specific message to help clarify the cause of the exception
    
    ModbusProtocolException
  - getCommEventCounter
```
ModbusCommEvent getCommEventCounter(int unitAddr)
                                    throws ModbusProtocolException
```
    Modbus function 11 (0x0B)
    Get a status word and an event count from the device.
    Return values in a ModbusCommEvent.
    
    Parameters:
    unitAddr - modbus slave address (must be unique in the range 1 - 247)
    
    Throws:
    
    ModbusProtocolException(NOT_CONNECTED) - current connection is in a status other than CONNECTED
    
    ModbusProtocolException(TRANSACTION_FAILURE) - should include a protocol specific message to help clarify the cause of the exception
    
    ModbusProtocolException
    See Also:
  - getCommEventLog
```
ModbusCommEvent getCommEventLog(int unitAddr)
                                throws ModbusProtocolException
```
    Modbus function 12 (0x0C)
    Get a status word, an event count, a message count and a list of event bytes from the device.
    Return values in a ModbusCommEvent.
    
    Parameters:
    unitAddr - modbus slave address (must be unique in the range 1 - 247)
    
    Throws:
    
    ModbusProtocolException(NOT_CONNECTED) - current connection is in a status other than CONNECTED
    
    ModbusProtocolException(TRANSACTION_FAILURE) - should include a protocol specific message to help clarify the cause of the exception
    
    ModbusProtocolException
    See Also:
  - writeMultipleRegister
```
void writeMultipleRegister(int unitAddr,
                         int dataAddress,
                         int[] data)
                           throws ModbusProtocolException
```
    Modbus function 16 (0x10)
    write a block of contiguous registers (1 to 123) in the attached field device.
    
    Parameters:
    unitAddr - modbus slave address (must be unique in the range 1 - 247)
    dataAddress - Output address.
    data - Registers value (array of int converted in 2 bytes values) to write.
    
    Throws:
    
    ModbusProtocolException(NOT_CONNECTED) - current connection is in a status other than CONNECTED
    
    ModbusProtocolException(TRANSACTION_FAILURE) - should include a protocol specific message to help clarify the cause of the exception
    
    ModbusProtocolException

Interface ModbusProtocolDeviceService

Field Summary

Method Summary

Field Detail

SERVICE_NAME

Method Detail

toString

getProtocolName

configureConnection

getConnectStatus

connect

disconnect

readCoils

readDiscreteInputs

writeSingleCoil

writeMultipleCoils

readHoldingRegisters

readInputRegisters

writeSingleRegister

readExceptionStatus

getCommEventCounter

getCommEventLog

writeMultipleRegister