.NET RuleEngine-Pipeline Configuration API
Die RuleEngine-API ist eine .NET-Bibliothek, mit der Sie RuleEngine-Pipelines des TwinCAT Analytics StorageProvider programmatisch erstellen, laden, ändern und speichern können — ohne den grafischen Configurator zu verwenden. Ein typischer Anwendungsfall ist das automatisierte Anlegen vieler gleichartiger Pipelines (z. B. je Maschine oder Anlagenteil). Ein Beispiel dazu finden Sie im nächsten Kapitel. Nachfolgend werden wesentliche Bestandteile beschrieben.
PipelineHandler — Verwaltung der Pipelines
Zentraler Einstiegspunkt. Über ihn verwalten Sie den Bestand an Pipelines.
Eigenschaft | Beschreibung |
|---|---|
LocalRuleEnginePipelineTemplates | Auflistung aller lokal vorhandenen Pipeline-Vorlagen. Die Vorlagen werden bei jedem Zugriff neu aus dem lokalen Ablageverzeichnis (%AppData%\Beckhoff\TwinCAT Analytics Storage Provider\LocalRuleEnginePipelineCmds, JSON-Dateien) eingelesen. |
Methode | Beschreibung |
|---|---|
CreateRuleEnginePipeline() | Neue, leere Pipeline anlegen. |
LoadPipelineFromPipelineID(Guid) | Vorhandene Pipeline über ihre ID laden. |
LoadPipelineFromPath(string) | Pipeline aus einer Konfigurationsdatei laden. |
LoadPipelineFromJson(string) | Pipeline aus einem JSON-String laden. |
LoadPipelineFromInfo(IPipelineInfo) | Pipeline aus einer Übersichtsinformation laden. |
RemovePipeline(Guid) | Pipeline löschen |
Über IPipelineInfo erhalten Sie kompakte Metainformationen zu den vorhandenen Pipelines (z. B. Name und ID), ohne die vollständige Konfiguration laden zu müssen.
RuleEngine-Pipeline (IRuleEnginePipeline) — die Konfiguration
Die Pipeline ist der Container für eine vollständige Aufzeichnungs- und Verarbeitungskonfiguration.
Eigenschaft | Beschreibung |
|---|---|
PipelineAlias | Sprechender Name der Pipeline. |
PipelineID | Eindeutige GUID der Pipeline. |
StorageProvider | GUID des StorageProviders, auf dem die Pipeline betrieben wird. |
MqttInputSources | Alle enthaltenen MQTT-InputSources. |
Rules | Alle auf Pipeline-Ebene enthaltenen Rules. |
Recordings | Alle auf Pipeline-Ebene enthaltenen Recordings. |
Methode | Beschreibung |
|---|---|
SetPipelineAlias(string alias) | Setzt den Anzeigenamen der Pipeline. |
SetPipelineID(Guid pipelineID) | Setzt die eindeutige ID der Pipeline. Über die ID wird beim Speichern gesteuert, ob eine vorhandene Pipeline überschrieben (gleiche ID) oder als Kopie angelegt wird (neue ID). |
SetStorageProvider(Guid storageProvider) | Legt den Ziel-StorageProvider fest. |
AddMqttInputSource(out IMqttSource source) | Fügt eine neue MQTT-InputSource hinzu und gibt sie zurück. |
AddRule(out IRule rule) | Fügt eine neue Rule auf Pipeline-Ebene hinzu und gibt sie zurück. |
AddRecording(out IRecording recording) | Fügt ein neues Recording auf Pipeline-Ebene hinzu und gibt es zurück. |
RemoveNode(IPipelineNode node) | Entfernt einen Knoten (InputSource, Rule oder Recording) aus der Pipeline. |
SaveConfig(string directory = null) | Speichert die Pipeline als JSON-Konfiguration; ohne Angabe wird das Standardverzeichnis verwendet. |
ValidateConfiguration() | Prüft die Pipeline auf Vollständigkeit und Konsistenz. |
InputSource (IMqttSource) — die Datenquelle
Die MQTT-Source beschreibt, woher die Daten einer Pipeline stammen.
Eigenschaft | Beschreibung |
|---|---|
ID | Interne Kennung des Knotens innerhalb der Pipeline. |
NodeAlias | Anzeigename der InputSource |
Broker | GUID des MQTT-Brokers, über den die Daten empfangen werden. |
Topic | MQTT-Topic, das abonniert wird. |
SystemID | GUID des Quellsystems, dem die Daten zugeordnet sind. |
CycleTime | Zykluszeit, in der die Daten eintreffen. |
ParentNodes | Übergeordnete Knoten |
ChildNodes | Untergeordnete Knoten |
OutputSymbols | Die aus dem Knoten ausgehenden Symbole. |
Methode | Beschreibung |
|---|---|
SetNodeAlias(string alias) | Setzt den Anzeigenamen der InputSource. |
SetBroker(Guid brokerGuid) | Legt den zu verwendenden MQTT-Broker fest. |
SetTopic(string topic) | Setzt das MQTT-Topic |
SetSystemID(Guid systemID) | Ordnet die Source einem Quellsystem zu. |
SetCycleTime(TimeSpan cycleTime) | Setzt die Zykluszeit der eingehenden Daten. |
AddRule(out IRule rule) | Erzeugt eine neue Rule als untergeordneten Knoten und gibt sie zurück. |
AddChild(IRule rule) | Hängt eine bereits vorhandene Rule als untergeordneten Knoten an. |
CreateSymbol(string symbolName, string dataType, out IConfigSymbol symbol) | Legt ein neues Eingangssymbol mit Namen und Datentyp an und gibt es zurück. |
ValidateConfiguration() | Validiert die Konfiguration des Knotens. |
Rule (IRule) — die Verarbeitung
Eine Regel definiert, wie die Daten einer InputSource verarbeitet werden.
Eigenschaft | Beschreibung |
|---|---|
ID | Interne Kennung des Knotens innerhalb der Pipeline. |
NodeAlias | Anzeigename der Rule |
Nodes | Alle in der Rule enthaltenen Knoten (Conditions und Actions). |
Trigger | Alle der Rule zugeordneten Trigger. |
TriggerEnable | Gibt an, ob die Rule triggergesteuert ausgeführt wird. |
DataProcessingRange | Zeitfenster der Daten, das bei Auslösung verarbeitet wird. |
ParentNodes | Übergeordnete Knoten |
ChildNodes | Untergeordnete Knoten |
OutputSymbols | Die aus dem Knoten ausgehenden Symbole. |
Methode | Beschreibung |
|---|---|
SetNodeAlias(string alias) | Setzt den Anzeigenamen der Rule. |
AddCondition<T>() | Fügt eine Condition des angegebenen Typs hinzu (z. B. IEventbasedCondition, ITimebasedCondition) und gibt sie zurück. |
AddAction<T>() | Fügt eine Action des angegebenen Typs hinzu (z. B. IMinMaxAvgAction, IDownsamplingAction) und gibt sie zurück. |
RemoveNode(IRuleNode node) | Entfernt eine Condition oder Action aus der Rule. |
AddTrigger<T>() | Fügt einen Trigger des angegebenen Typs hinzu (z. B. ITimebasedTrigger, IEventbasedTrigger) und gibt ihn zurück. |
RemoveTrigger(ITrigger trigger) | Entfernt einen Trigger aus der Rule. |
SetDataProcessingRange(TimeSpan dataProcessingRange) | Legt das zu verarbeitende Zeitfenster fest. Das ist nur möglich, wenn ein Recording als InputSource für die Rule dient. |
SetUseAllData() | Legt fest, dass alle anfallenden Daten verarbeitet werden statt, eines begrenzten Zeitfensters. Das ist nur möglich, wenn ein Recording als InputSource für die Rule dient. |
AddRecording(out IRecording recording) | Erzeugt ein neues Recording unterhalb der Rule und gibt es zurück. |
AddChild(IRecording recording) | Hängt ein bereits vorhandenes Recording als untergeordneten Knoten an. |
RenameSymbol(IConfigSymbol symbol, string name) | Vergibt einen abweichenden Namen für ein Ausgangssymbol der Rule. |
ResetSymbolName(IConfigSymbol symbol) | Setzt einen zuvor geänderten Symbolnamen auf den Originalnamen zurück. |
ValidateConfiguration() | Validiert die Konfiguration des Knotens. |
Recording (IRecording) — die Aufzeichnung
Das Recording legt fest, welche Daten in welchem Storage abgelegt werden.
Eigenschaft | Beschreibung |
|---|---|
ID | Interne Kennung des Knotens innerhalb der Pipeline. |
NodeAlias | Anzeigename des Recordings |
RecordName | Record-Name der Aufzeichnung |
StorageGuid | GUID des Ziel-Storages, in den geschrieben wird. |
CycleTime | Zykluszeit, mit der aufgezeichnet wird. |
CleanupMode | Aktive Aufräumstrategie (kein Cleanup, zeitbasiert oder datenmengenbasiert) |
CleanupInterval | Größe des Ringpuffers bei zeitbasiertem Cleanup. |
CleanupSizeMB | Maximale Datenmenge in MB bei datenmengenbasiertem Cleanup. |
InputSymbols | Verfügbare Eingangssymbole des übergeordneten Knotens, aus denen ausgewählt werden kann. |
ParentNodes | Übergeordnete Knoten |
ChildNodes | Untergeordnete Knoten |
OutputSymbols | Die aus dem Knoten ausgehenden Symbole. |
Methode | Beschreibung |
|---|---|
SetNodeAlias(string alias) | Setzt den Alias des Recordings. |
SetRecordName(string recordName) | Setzt den Record-Namen. |
SetStorageGuid(Guid storageGuid) | Legt den Ziel-Storage fest. |
SetCustomCycleTime(TimeSpan cycleTime) | Setzt eine abweichende Zykluszeit. |
RemoveCustomCycleTime() | Entfernt die abweichende Zykluszeit; es gilt wieder die originale Zykluszeit. |
SetTimebasedCleanup(TimeSpan ringbufferSize) | Aktiviert zeitbasiertes Cleanup mit der angegebenen Ringpuffergröße. |
SetDatabasedCleanup(int cleanupSizeMB) | Aktiviert datenmengenbasiertes Cleanup mit der angegebenen Maximalgröße in MB. |
RemoveCleanup() | Deaktiviert das automatische Aufräumen. |
UseSymbol(IConfigSymbol symbol) | Nimmt ein einzelnes Symbol in das Recording auf. |
RemoveSymbol(IConfigSymbol symbol) | Entfernt ein einzelnes Symbol aus dem Recording. |
UseAllSymbols(int lastConditionID = 0) | Nimmt alle verfügbaren Symbole auf. Optional kann die ID einer Condition angegeben werden, sodass alle Symbole dieser Condition aufgezeichnet werden. |
RemoveAllSymbols() | Entfernt alle ausgewählten Symbole. |
AddRule(out IRule rule) | Erzeugt eine nachgelagerte Rule unterhalb des Recordings und gibt sie zurück. |
AddChild(IRule rule) | Erzeugt eine neue Rule als untergeordneten Knoten und gibt sie zurück. |
ValidateConfiguration() | Validiert die Konfiguration des Knotens. |