node-red-contrib-lcc

Dies ist ein node-RED Plug-in, welches eine Verbindung zu WALDNERs Lab Control Center herstellt und somit die Verarbeitung von LCC Daten via node-RED ermöglicht.

Inhalt

Mit diesem Plug-in werden sechs Nodes hinzugefügt: zwei Konfigurationsnodes und vier Nodes, die Sie im Flow-Editor aus der linken Palette platzieren können.

Nodes

Alle Nodes müssen zunächst mit einem Raum konfiguriert werden.

1. Sensor values

Übermittelt gemessene Sensorwerte aus dem LCC.

Die Node "sensor values" nimmt in den Feldern Device, Functional Unit und Function je einen Filter entgegen, sodass eine Sensorfunktion spezifiziert wird. Diese Felder müssen ausgefüllt werden. Es werden jeweils alle gemäß den vorigen Auswahlen verfügbaren Optionen zur Auswahl angeboten.

Setzen Sie das Häkchen am Feld Live Data, werden nach Deployment am Ausgang dieser Node alle neuen Sensordaten des spezifizerten Sensors aus dem LCC als node-RED-Nachricht ausgegeben. Diese folgen dem Format Sensor values.

Außerdem kann der Sensor valus-Node, um historische Sensordaten zu erhalten, an ihren Eingang eine Liste zweier Daten geschickt werden, d.h. eine Nachricht, deren Payload diesem Format folgt [startDatum, endDatum]. Hierbei können das Start- und Enddatum jedem üblichen Format entsprechen, z.B.: YYYY-MM-DDTHH:mm:ss.sssZ (ISO global) oder YYYY-MM-DDTHH:mm (wird als GMT interpretiert). Die Sensor values-Node gibt dann in schneller Folge alle Datenpunkte aus diesem Zeitraum in chronologischer Reihenfolge an ihrem Ausgang aus.

2. Alarms

Übermittelt Alarme über überquerte Grenzwerte aus dem LCC.

Die Node "alarms" muss ebenso mittels drei Filter auf eine Sensorfunktion spezifiziert werden. Am Ausgang dieser Node erscheinen immer dann Nachrichten, wenn sich der Zustand des letzten Sensorwertes hinsichtlich der im LCC konfigurierten Grenzwerte ändert. Es wird also eine Nachricht ausgegeben, wenn der Messwert einen Grenzwert über- bzw. unterschreitet und wenn der Messwert den Grenzwertbereich wieder verlässt. Diese Nachrichten folgen dem Schema für Alarme.

3. Device status

Übermittelt Statusveränderungen von Geräten oder Functional Units aus dem LCC.

Das Filterfeld Device ist notwenig — das Feld Functional Unit hingegen optional.

Sofern Functional Unit nicht ausgefüllt wurde, werden Statusupdates über das gesamte Device ausgegeben. Falls Functional Unit ausgefüllt ist, beziehen sich die Statusupdates auf das Functional Unit im Spezifischen. Statusupdates bezeichnen eine Veränderung im Status wie operate, shutdown und sleep. Diese folgen dem Status-Schema.

4. Ext status

Übermittelt Veränderungen im Verbindungszustand einer Extension.

An dieser Node müssen drei Filterfelder konfiguriert werden, um einen konkrete Sensor auszuwählen. Sinnvollerweise sollte eine Extension gewählt werden. Nun erhalten Sie am Ausgang der Node Nachrichten, wenn sich der Verbindungszustand der Extension ändert — d.h. wenn diese an- oder abgesteckt wurde. Diese Nachrichten folgen ebenfalls dem Status-Schema.

Konfigurationsnodes

Diese müssen nicht gesondert beachtet werden. Im node-RED Flow-Editor ist das Aufsezten der Konfigurationsnodes in die Einstellungen der normalen Nodes integriert.

1. oauth2

Die oauth2-connection-Node ist für die Autorisierung dieses Plug-ins gegenüber des LCCs zuständig. Während der Einstellung eines Raumes werdne Sie dazu aufgefordert, eine Connection auszuwählen. Falls Sie noch keine erstellt haben, erstellen Sie jetzt eine. Diese erfordert eine Client ID und ein Client Secret. Mittels dieser vollführen die Nodes automatisch eine Autorisierung, sobald sie deployt werden.

2. lcc-room

*!Sie müssen nach der Erstellung eines Raumes einmal ihren Flow deployen, damit die Geräte des Raumes in den Nodes zur Auswahl stehen!

Für jede Node ist ein LCC-Raum erforderlich. Beim Konfigurieren einer Node werden Sie dazu aufgefordert einen Raum auszuwählen bzw. zu erstellen. Ein Raum erfordert eine Raum ID sowie eine Connection.

Je Raum wird eine Verbindung zum LCC geöffnet, durch diese die Ereignisse für die Nodes kommen.

Sie können beliebig viele Räume erstellen und somit Ereignisse aus allen Räumen nebeneinander verarbeiten.

Dokumente

• README

Sie lesen es gerade.

• LICENSE

Siehe LICENSE.md.

Beispiele

Unsere Flow-Beispiele können Sie im Flow-Editor über das Menüfeld oben rechts unter Import (alternativ drücken Sie ctrl+i) im Reiter Beispiele importieren. Hierfür benötigen Sie das Plug-in @flowfuse/node-red-dashboard.

Fehlerbehandlung

Ein rotes Dreieck an der oberen rechten Ecke einer Node weist Sie darauf hin, dass Sie nicht alle erforderlichen Konfigurationsfelder der Node ausgefüllt haben.

Darüber hinaus wird der Status jeder Node nachdem diese deployt wurde unter ihr im Flow-Editor angezeigt. Hier tauchen Fehler der Autorisierung, Verbindung oder Konfiguration mit hilfreichen Details auf. In den meisten Fällen sollten Sie einen grünen Kreis mit dem Wort "connected" sehen.

Schemata

Sensor values

message {
  topic: ,
  payload: {
    value: number,
    timestamp: ISODateTime
  }
}

Alarms

message {
  topic: browsePath,
  payload: {
    severity: string (one of: 'INFO', 'WARNING', 'ERROR'),
    timestamp: ISODateTime,
    message: string,
    status: string,
    active: boolean,
    acknowledged: boolean,
    confirmed: boolean,
    reported: boolean,
  }
}

Status

message {
  topic: browsePath,
  payload: {
    value: string,
    timestamp: ISODateTime
  }
}

Versionsanforderungen

• node-RED Version >= 5.0.0
• node.js Version >= 22.0.0