ConsumePLC

Description:

Processor able to read data from industrial PLCs using Apache PLC4X subscriptions

Tags:

plc4x, source, subscription, event, read

Properties:

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.
Subscription Type	subscription-type	Notify on Value Changes	Notify on Value Changes Cyclic Polling of Registers Listen to Events and Signals	Specifies the kind of events this processor is subscribed for. The subscription types available for each driver are usually stated in their documentation.
Cyclic Polling Interval	subscription-cyclic-polling-interval	1 second		A time interval for polling. This Property is only considered if the [Subscription Type] Property has a value of "Cyclic Polling of Registers".
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.
Queue Size	event-queue-size			Maximum number of events to be registered, between scheduling intervals. If the amount of incoming events exceed this limit, new events are dropped, until the next FlowFile is emitted. Unset it for no limit.
Batch Size	event-batch-size			Maximum number of records to be produced per FlowFile. Unset it for no limit.
Request Timeout	request-timeout	10 seconds		The maximum amount of time allowed for reading data from PLC. Fraction of milliseconds are rounded up.

Dynamic Properties:

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 subscribed to	Address Map for linking record fields to PLC registers. Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)

Relationships:

Name	Description
success	Successfully processed

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
plc4x.listen.row.count	Number of rows written into the output FlowFile
plc4x.listen.lastEvent	Time elapsed from last subscription event (ms)

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations: