Common service to maintain a set of communication channels to an industrial PLC device. Includes no drivers, user needs to supply their own set, via the respective configuration options.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| Drivers Location(s) | drivers-locations | | | Comma-separated list of files/folders and/or URLs containing the driver JAR, and its dependencies (if any). For example '/var/tmp/plc4j-driver-example-0.10.0.jar'
This property expects a comma-separated list of resources. Each of the resources may be of any of the following types: directory, file, URL.
Supports Expression Language: true (will be evaluated using Environment variables only) |
| Protocol Code | protocol-code | | | Protocol driver to be used, to create connections to the PLC device. Not necessary to set, if there is only one protocol driver in the classpath. |
| Transport Code | transport-code | | | Transport driver to be used, to create connections to the PLC device. If unset, the protocol driver's default transport will be used. |
| Transport Location | transport-location | | | Location or address of the PLC device. This is sometimes an IP:port kind of address, sometimes a file path, sometimes a hardware port name. Please check the transport driver's documentation for details. If you wish, you can enter the full connection URI here. |
| Authentication Strategy | authentication-strategy | No Authentication | - No Authentication
 - Password Authentication
| Strategy to be used during out-of-band authentication. Only effective for a limited set of drivers, as some of them require authentication data to be specified as connection parameters. Please check the driver documentation. |
| Username | username | | | Username to be used during authentication with the PLC device.
This Property is only considered if the [Authentication Strategy] Property has a value of "Password Authentication". |
| Password | password | | | Password to be used during authentication with the PLC device. Leave it blank, if the user has no password.
Sensitive Property: true
This Property is only considered if the [Authentication Strategy] Property has a value of "Password Authentication". |
| Max Wait Time | max-wait-time | 15 seconds | | The maximum amount of time, that the pool will wait before failing, when there are no available connections to be returned. |
| Max Total Connections | max-total-connections | 8 | | The maximum number of active connections, that can be allocated from this pool at the same time. Unset it for no limit. |
| Time Between Eviction Runs | time-between-eviction-runs | | | The number of milliseconds to sleep between runs of the idle connection eviction thread. When unset, idle connections will not be evicted. |
| Min Evictable Idle Time | min-evictable-idle-time | 30 minutes | | The minimum amount of time, a connection may sit idle in the pool, before it is eligible for eviction.
This Property is only considered if the [Time Between Eviction Runs] Property has a value specified. |