Skip to main content
Version: Next

Modbus RTU

Description​

The adapter allows to connect devices supporting Modbus RTU.

Configuration​

The following configuration options are available when creating an adapter:

PLC Address​

This field requires the PLC address in form of the IP without the prefixed protocol (e.g., 192.168.34.56).

Polling Interval​

The polling interval requires a number in milliseconds, which represents the interval in which the adapter will poll the PLC for new data. For instance, a polling interval of 1000 milliseconds will configure the adapter to send a request to the PLC every second.

Supported Transports​

The following transports are supported by this adapter:

  • tcp
  • serial

Transport Metadata​

Required​

tcp

Advanced​

tcp

  • keep-alive: Should keep-alive packets be sent? (BOOLEAN)
  • no-delay: Should packets be sent instantly or should we give the OS some time to aggregate data. (BOOLEAN)
  • default-timeout: Timeout after which a connection will be treated as disconnected. (INT)

Protocol Metadata​

Required​

Optional​

  • request-timeout: Default timeout for all types of requests. (INT)
  • unit-identifier: Unit-identifier that identifies the target PLC (On RS485 multiple Modbus Devices can be listening). Defaults to 1. (INT)

Tags​

The syntax to define tags is based on the PLC4X syntax, see https://plc4x.apache.org/users/protocols/s7.html. Address Pattern:

propertyName=%{Memory-Area}{start-address}:{Data-Type}[{array-size}]

temperature=%I0.0:INT

Best Practices​

Instead of creating a large event containing all nodes that should be available in StreamPipes, consider to group the fields logically into smaller adapters. This will ease the definition of pipelines for users and eases future modifications.

Last updated on by Dominik Riemer