FB_ALY_ActiveRecordings
The FB_ALY_ActiveRecordings is a client FB for monitoring the active recordings of a Storage Provider instance. The FB provides methods to start and stop monitoring. The active recordings found are output at arrRecordings with the corresponding status information.
Syntax
Definition:
FUNCTION_BLOCK FB_ALY_ActiveRecordings
VAR_INPUT
stConfig : ST_ALY_SP_Config;
END_VAR
VAR_IN_OUT
arrRecordings : ARRAY [*] OF ST_RecordingStatus;
END_VAR
VAR_OUTPUT
bError : BOOL;
ipResultMessage : I_TcMessage;
eConnectionState : ETcIotMqttClientState;
bIsMonitoring : BOOL;
nActiveRecordings : UDINT;
nReceivedMessages : ULINT;
END_VAR
Inputs
Inputs/outputs
Name | Type | Description |
|---|---|---|
arrRecordings | ARRAY [*] OF ST_RecordingStatus | List of active recordings found |
Outputs
Name | Type | Description |
|---|---|---|
bError | BOOL | Becomes TRUE when an error situation occurs. |
ipResultMessage | I_TcMessage | Message interface of the TwinCAT 3 EventLogger, which provides further information about the return value. |
eConnectionState | ETcIotMqttClientState | Specifies the state of the connection between client and broker as an enumeration ETcIotMqttClientState. |
bIsMonitoring | BOOL | Becomes TRUE as soon as monitoring is started. |
nActiveRecordings | UDINT | Number of active recordings found |
nReceivedMessages | ULINT | Number of MQTT messages received |
Methods
Name | Definition location | Description |
|---|---|---|
Local | Method for background communication with the TwinCAT driver. The method must be called cyclically. | |
Local | Starts the monitoring of active recordings | |
Local | Stops the monitoring of active recordings |
Development Environment | Target platform | PLC libraries to include |
|---|---|---|
TwinCAT v3.1.4022.25 | PC or CX (x64, x86, Arm®) | Tc3_AnalyticsStorageProvider |