Common service to maintain a set of communication channels to an industrial PLC device. Includes all standard device and transport protocol drivers, that come with PLC4X.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| Protocol Name | protocol-code | | - Siemens S7 (Basic) [s7]
- Simulated PLC4X Datasource [simulated]
- Modbus TCP [modbus-tcp]
- CAN open [canopen]
- Allen Bradley ETH [ab-eth]
- EthernetIP [eip]
- KNXNet/IP [knxnet-ip]
- Beckhoff TwinCat ADS [ads]
- PLC4X (Proxy-Protocol) [plc4x]
- Generic CAN [genericcan]
- Modbus ASCII [modbus-ascii]
- Opcua [opcua]
- Modbus RTU [modbus-rtu]
| Protocol driver to be used, to create connections to the PLC device. |
| Transport Name | transport-code | | - PCAP(NG) Playback Transport [pcap]
- Raw Ethernet Transport [raw]
- Passive Raw Ethernet Transport [raw-passive]
- Serial Port Transport [serial]
- IP/TCP Transport [tcp]
- UDP Datagram Transport [udp]
| 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. |