PLC4X (Proxy) (TCP)

Connection String Options

Name

Type

Default Value

Required

Description

Name

PLC4X (Proxy-Protocol)

Code

plc4x

Maven Dependency

 
<dependency>
  <groupId>org.apache.plc4x</groupId>
  <artifactId>plc4j-driver-plc4x</artifactId>
  <version>0.12.0</version>
</dependency>

Default Transport

tcp

Supported Transports

  • tcp

Config options:

remote-connection-string

STRING

URL-Encoded connection string to use on the proxy side to reach the given PLC.

request-timeout

INT

5000

Default timeout for all types of requests.

Transport config options:

tcp

tcp.keep-alive

BOOLEAN

false

Should keep-alive packets be sent?

tcp.no-delay

BOOLEAN

true

Should packets be sent instantly or should we give the OS some time to aggregate data.

tcp.default-timeout

INT

1000

Timeout after which a connection will be treated as disconnected.

Connection String Options

Name Value Description

Supported Operations:

read

write

subscribe

Individual Resource Address Format

Connection String

The plc4x protocol connection has the following connection string format:-

plc4x:{transport}://{ip-address/hostname}:{port}?remote-connection-string={url-encoded-connection-string}

An example connection string would look like:-

plc4x://127.0.0.1?remote-connection-string=simulated%3A%2F%2Flocalhost

Note the transport, port and option fields are optional. The remote connection string: simulated://localhost is encoded as simulated%3A%2F%2Flocalhost

General Format

The address format is simply the address format of the used remote connection. So if you specify a remote connection as simulated, please follow the address format of that driver.