Processor able to read data from industrial PLCs using Apache PLC4X
plc4x, source, read
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Connection Pool Service | connection-pool-service | Controller Service API: PLC4XConnectionPool Implementations: GenericPLC4XConnectionPool ProxyPLC4XConnectionPool StandardPLC4XConnectionPool | The Controller Service that is used to obtain connection to the PLC device. | |
| Record Writer | record-writer | Controller Service API: RecordSetWriterFactory Implementations: ScriptedRecordSetWriter CSVRecordSetWriter FreeFormTextRecordSetWriter AvroRecordSetWriter ParquetRecordSetWriter XMLRecordSetWriter JsonRecordSetWriter RecordSetWriterLookup | Specifies the Controller Service to use for writing results to a FlowFile. The Record Writer may use Inherit Schema to emulate the inferred schema behavior, i.e. an explicit schema need not be defined in the writer, and will be supplied by the same logic used to infer the schema from the column types. | |
| Request Timeout | request-timeout | 10 seconds | The maximum amount of time allowed for reading data from PLC. Fraction of milliseconds are rounded up. | |
| Schema Cache Size | schema-cache-size | 1 | Maximum number of entries in the cache. Can improve performance when addresses change dynamically. |
Supports Sensitive Dynamic Properties: No
Dynamic Properties allow the user to specify both the name and value of a property.
| Name | Value | Description |
|---|---|---|
| Record field name | Address of the register to be read from | Address Map for linking record fields to PLC registers. Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
| Name | Description |
|---|---|
| success | Successfully processed |
| failure | An error occurred while processing |
| Name | Description |
|---|---|
| plc4x.read.row.count | Number of rows written into the output FlowFile |