Überblick aller Komponenten-Provider

Als eine Art Referenz und Erklärung zu den in NeuroomNet verfügbaren Providern werden in den folgenden Unterabschnitten alle derzeit in NeuroomNet verfügbaren Provider mit deren Einstellungsmöglichkeiten und Erklärungen aufgelistet. Dabei werden insbesondere folgende wichtige Informationen angegeben:

• Klassifikation: Klassifikation des Providers in aktiv und passiv:
  • Aktive Provider (Komponenten): Aktive Provider korrespondieren zu aktiven Komponenten, d.h. Komponenten, die von sich aus den NeuroomNet-Server kontaktieren. Nach erster solcher Kontaktaufnahme legt NeuroomNet die Komponente an Modul Setup (z.B. anhand der MAC-Adresse der Komponente, worüber diese Komponente in Zukunft automatisch erkannt werden kann, selbst bei mittlerweile geänderter IP-Adresse).
  • Passive Provider (Komponenten): Passive Provider korrespondieren zu passiven Komponenten, d.h. welche i.d.R. manuell im Modul Setup des NeuroomNet Servers angelegt werden inkl. Kontaktinformationen (wie z.B. über die IP-Adresse der Komponente). Die entsprechenden Komponenten verbinden sich i.d.R. nicht selbstständig mit dem NeuroomNet-Server.
• Netzwerk / Kommunikation: Beschreibt, wie Komponenten des Providers in NeuroomNet hinsichtlich Erreichbarkeit im Netzwerk konfiguriert werden können (betrifft vor allem passive Komponenten, weil hier NeuroomNet wissen muss, wie es die jeweiligen Komponenten erreichen kann).
• Aktionen: Auflistung aller Provider-spezifischen (NeuroomNet-)Aktionen . Die Standard-Aktionen, die jede Komponente hat ("Enforce Warning Level" und "Reset Warning Level"), sind in dieser Auflistung nicht enthalten.
• Ereignisse: Auflistung aller Provider-spezifischen (NeuroomNet-)Ereignisse. Das Standard-Ereignis, welches jede Komponente hat ("State has changed"), ist in dieser Auflistung nicht enthalten.

Allgemeine / Provider-unabhängige Felder

Folgende Felder gibt es für Komponenten eines jeden Providers:

• Typ: (Optionale) Angabe eines (benutzerdefinierten) Komponententyps, siehe Zusammenspiel Provider und Komponententypen
• Beschreibung: (Optionale) textuelle Beschreibung der Komponente
• Besondere Regeln für Warnungslevel: Optional: Abhängig von eingehenden Ereignissen können für Komponenten automatisch bestimmte Warnungslevel gesetzt werden, siehe Warnungslevel pflegen
• Gerätespannung (in Volt):, Stromverbrauch (in Ampere), Leistung (in Watt): (Optionale) Angaben zur Gerätespannung, Stromverbrauch und Leistung des durch die Komponente repräsentierten Geräts. Es reicht hier eine Eingabe von entweder [Leistung] oder [Gerätespannung und Stromverbrauch] (die Leistung wird im letzteren Fall dann aus Gerätespannung multipliziert mit Stromverbrauch berechnet). Die Leistung (oder Gerätespannung * Stromverbrauch) des Geräts wird im Modul Status Historie verwendet zur Berechnung des tatsächlich aufgetretenen Stromverbrauchs und der resultierenden Stromkosten. Siehe hierzu Berechnung der Kilowattstunden und des Strompreises

Provider Heatmap (ehemals Camera)

Mit Provider Heatmap (ehemals Camera) werden (Hardware-)Kameras des Herstellers Xovis angesprochen über ein proprietären Protokoll zur Zählung eingehender und ausgehender Menschen an Eingängen / Ausgängen.

• Klassifikation: Passiv
• Netzwerk / Kommunikation: IP-Adresse
• Aktionen: Reset Counters
• Ereignisse: Keine; die Kameras werden derzeit nur proprietär vom Heatmap-Modul angesprochen (und dort gepollt)

Provider Digital Signage Player

Mit Provider Digital Signage Player werden Software-Digital-Signage-Player von NeuroomNet angesprochen, welche jeweils auf einem Rechner (Windows, Linux, Android) im Netzwerk installiert sind. Die Kommunikation erfolgt über ein proprietäres Protokoll von NeuroomNet. Detailliertere Dokumentation: Modul Digital Signage

• Klassifikation: Aktiv
• Netzwerk / Kommunikation: -
• Aktionen:
  • Activate playlist
  • Activate schedule
  • Change display parameters
  • End blackout
  • Refresh schedule
  • Start blackout
• Ereignisse: Request to switch signage input source

Provider DMX

Mit Provider DMX werden DMX-Geräte angesprochen, welche per ArtNet oder DMX angesteuert werden können.

• Klassifikation: Passiv
• Netzwerk / Kommunikation: IP-Adresse
• Aktionen:
  • WriteChannel
  • WriteChannels
  • Write
• Ereignisse: -

Provider Email-Server

Mit Provider Email-Server werden E-Mail-Relay-Server per SMTP angesprochen, um aus NeuroomNet-Skripten heraus automatisch E-Mails zu versenden.

• Klassifikation: Passiv
• Netzwerk / Kommunikation:
  • Server URI: Hostname oder IP-Adresse des SMTP-Relay-Servers
  • Port: SMTP-Port — Standard: 587 für STARTTLS, 465 für direkte SSL/TLS-Verbindung
  • SSL/TLS: Direkte SSL/TLS-Verbindung (Port 465). Wenn nicht aktiviert, wird STARTTLS verwendet (Port 587).
  • Zertifikatsfehler ignorieren: Akzeptiert ungültige oder selbstsignierte Zertifikate — Achtung: unsicher, nur für Testzwecke!
  • Anmeldedaten: Name eines in der Serverkonfiguration hinterlegten Secret-Eintrags (Benutzername + Passwort)
• Aktionen:
  • E-Mail versenden — Parameter:
    • Absender (from): Absenderadresse
    • Empfänger (to): Empfängeradressen, kommagetrennt
    • Betreff (subject): E-Mail-Betreff
    • Nachricht (body): E-Mail-Text
• Ereignisse:
  • E-Mail sent — wird nach erfolgreichem Versand ausgelöst. Keine Parameter.
  • Send failed — wird ausgelöst, wenn der Versand fehlschlägt. Parameter:
    • errorMessage: Fehlermeldung des Mailservers oder der Netzwerkschicht
    • errorType: Fehlertyp — "auth" bei Authentifizierungsfehlern, "timeout" bei Verbindungs-Timeout, "network" bei sonstigen Netzwerkfehlern

Die Anmeldedaten (Benutzername und Passwort) werden nicht direkt in der Komponente gespeichert, sondern als benannte Einträge in der Serverkonfiguration (config.email.json, Abschnitt secrets) hinterlegt. Im Komponentenfeld „Anmeldedaten" wird der Name dieses Eintrags angegeben.

Für Installationen mit eigenem CA-Zertifikat (Unternehmens-PKI) kann in der Serverkonfiguration unter tls.caFile der Pfad zur CA-Zertifikatsdatei angegeben werden. Damit kann die Zertifikatsprüfung aktiv bleiben, ohne auf das unsichere „Zertifikatsfehler ignorieren" zurückgreifen zu müssen.

Provider Exhibit

Mit Provider Exhibit wird Exponate-Software auf (überlicherweise Exponate-)PCs, die mittels der Exponate API von NeuroomNet fernsteuerbar ist, angesprochen (anstatt oder zusätzlich zur Steuerung mittels Provider / Software PC-Client).

• Klassifikation: Aktiv
• Netzwerk / Kommunikation: VendorId (= eindeutige Kennzeichnung des Exponats)
• Aktionen:
  • Log User on or off
  • Reboot the Computer
  • Restart the Exhibit Software
  • Shutdown the computer
• Ereignisse:
  • Animation for RFID-Readers
  • Day of Birth changed
  • New Gender selected
  • Preferred User Language changed
  • Status Report

Provider HTTP

Mit Provider HTTP können beliebige Geräte oder Web-Endpunkte angesprochen werden, die sich über HTTP- oder HTTPS-Anfragen (GET, POST, PUT, DELETE) steuern oder abfragen lassen.

Beim Provider HTTP werden die zu sendenden Nachrichten nicht wie beim Provider Network über Geräteprotokolle (PRT) definiert, sondern direkt als Aktionsparameter übergeben (Methode, Endpunkt, Body). Alternativ lassen sich Aktionen über Aliase in einem Komponententyp vordefinieren: Dazu legt man einen Komponententyp (im Reiter Komponententypen) an und definiert dort für die Aktion „Request senden" die gewünschten Alias-Varianten. Diese Aliase können dann bequem in Skriptblöcken als Aktionen aufgerufen werden.

• Klassifikation: Passiv
• Netzwerk / Kommunikation:
  • Servername oder IP-Adresse: Hostname oder IP-Adresse, optional mit Port — z. B. 192.168.1.1:8080 oder api.example.com:443
  • HTTPS/SSL verwenden: Aktiviert HTTPS für alle Anfragen dieser Komponente
  • Zertifikatsfehler ignorieren: Akzeptiert ungültige oder selbstsignierte Zertifikate — Achtung: unsicher, nur für Testzwecke!
  • Standard-HTTP-Header (JSON): Optionale Vorgabe von HTTP-Headern als JSON-Objekt, die bei jeder Anfrage dieser Komponente automatisch mitgesendet werden, z. B. {"Authorization": "Bearer meinToken"}
• Aktionen:
  • Request senden — Parameter:
    • Methode (method): GET, POST, PUT oder DELETE
    • Endpunkt (endPoint): Optionaler relativer Pfad, der an die Serveradresse angehängt wird
    • SSL-Override (ssl): Überschreibt die Komponenteneinstellung für diese einzelne Anfrage
    • Header-Override (headers): Zusätzliche HTTP-Header als JSON-Objekt; werden mit den Standardheadern der Komponente zusammengeführt
    • Content-Type (contentType): Für POST/PUT-Anfragen; Standard: application/x-www-form-urlencoded
    • Inhalt (content): Für POST/PUT-Anfragen der zu sendende Body-Text
• Ereignisse:
  • Response received — wird nach jeder HTTP-Antwort ausgelöst, unabhängig vom Statuscode. Parameter:
    • statusCode: HTTP-Statuscode (z. B. 200, 404, 500)
    • body: Antwort-Body als UTF-8-Text
    • headers: Alle Antwort-Header als JSON-Objekt
  • Request failed — wird bei Verbindungsfehlern ausgelöst. Parameter:
    • errorMessage: Fehlermeldung
    • errorType: Fehlertyp — "timeout", "ssl" oder "network"

Hinweis zur Unterscheidung der Ereignisse: HTTP-Fehlerantworten wie 404 oder 500 sind gültige HTTP-Antworten und lösen das Ereignis Response received aus (nicht Request failed). Das Ereignis Request failed wird nur bei echten Verbindungsproblemen ausgelöst, bei denen gar keine HTTP-Antwort empfangen wird — z. B. Host nicht erreichbar, SSL-Handshake fehlgeschlagen oder Timeout.

Im Folgenden ein Beispiel der Definition von Aktionen für eine Komponente mit Provider HTTP durch einen zugehörigen Komponententyp mit Aliasen:

In diesem Fall handelt es sich um bestimmte, real existierende IP-Steckdosen, die z.B. auch via Webbrowser mit Kommandos wie folgt steuerbar sind: http://192.168.0.1/hidden.htm?M0:O1=On.

Für Installationen mit eigenem CA-Zertifikat (Unternehmens-PKI) kann in der Serverkonfiguration unter tls.caFile der Pfad zur CA-Zertifikatsdatei angegeben werden, die dann für HTTPS-Verbindungen verwendet wird.

Provider KNX

Mit Provider KNX werden (Hardware-)Geräte (Steckdosen oder Licht) über das Protokoll KNX angesprochen.

• Klassifikation: Passiv
• Netzwerk / Kommunikation:
  • Name der Komponente
  • KNX/IP Interface / Gateway (IP)
  • KNX Adresse
  • Datenpunkttyp
• Aktionen:
  • Send Data to Actor
• Ereignisse:
  • Data received from Sensor

Provider Master Link

Mit Provider Master Link werden isMaster über eine proprietäre Schnittstelle von NeuroomNet angesprochen.

• Klassifikation: Passiv
• Netzwerk / Kommunikation: Proxy-Adresse (= URL des isMaster)
• Aktionen:
  • [Benutzerdefiniert in der isMaster Administration und im isMaster]
• Ereignisse:
  • [Benutzerdefiniert in der isMaster Administration und im isMaster]

Provider Network

Mit Provider Network können beliebige Geräte, welche sich per TCP, UDP oder Telnet und durch Zeichen- oder Bytefolgen (via PRT) steuern lassen, angesprochen.

Die konkreten Nachrichten (eingehend und ausgehend) sind in einer PRT-Datei definiert (siehe Reiter Geräteprotokolle).

Siehe Technische Dokumentation / Detail-Informationen zu TCP und UDP bei Provider Network für Details.

• Klassifikation: Passiv
• Netzwerk / Kommunikation:
  • IP-Adresse
  • TCP, UDP oder Telnet
  • Translation rule-set (PRT)
  • ID (wird derzeit nicht genutzt; für mögliche Verwendungen in der Zukunft soll hier eine eindeutige Zeichenfolge eingegeben werden)
• Aktionen:
  • [wie im PRT definiert]
• Ereignisse:
  • [wie im PRT definiert]

Provider PC-Client

Mit Provider PC-Client werden PCs, auf welchen die PC-Client Software von NeuroomNet installiert ist, angesprochen.

• Klassifikation: Aktiv
• Netzwerk / Kommunikation: MAC-Adresse
• Aktionen:
  • Reboot
  • Wake-On-LAN
  • Disable all serial ports
  • Enable all serial ports
  • Power Off
  • [und noch viele mehr]
• Ereignisse: -

Provider PJLINK

Mit Provider PJLINK werden Video-Projektoren oder Bildschirme über das PJLINK-Protokoll angesprochen.

• Klassifikation: Passiv
• Netzwerk / Kommunikation: IP-Adresse
• Aktionen:
  • Choose input
  • Get lamp hours
  • Get error state
  • Power Off
  • Power On
  • Set mute
• Ereignisse:
  • Current input line
  • Error states
  • Lamp hour information
  • Mute state
  • Power status

Provider RFID Reader

Mit Provider RFID Reader werden (Hardware-)RFID-Reader IS-CC-RFID-2.0 von NeuroomNet über ein proprietäres Protokoll angesprochen.

Detailliertere Dokumentation: https://neuroom.net/rfid/

• Klassifikation: Aktiv
• Netzwerk / Kommunikation: Mac-Adresse
• Aktionen:
  • Active Attraction
  • Deactivate Attraction
  • IDLE Animation
  • Switch all LEDs off
  • Reboot and update to latest Firmware
  • Restart RFID Unit
• Ereignisse:
  • RFID detected
  • RFID input changed
  • RFID lost

Provider Serial

Mit Provider Serial werden Geräte angesprochen, welche per RS-232 Kabel an einem per IP-Adresse konfigurierten PC angeschlossen sind und sich über Zeichen- oder Bytefolgen (via PRT) steuern lassen.

Die konkreten Nachrichten (eingehend und ausgehend) sind in einer PRT-Datei definiert (siehe Reiter Geräteprotokolle).

• Klassifikation: Passiv
• Netzwerk / Kommunikation:
  • IP-Adresse
  • Translation rule-set (PRT)
  • ID (wird derzeit nicht genutzt; für mögliche Verwendungen in der Zukunft soll hier eine eindeutige Zeichenfolge eingegeben werden)
• Aktionen:
  • [wie im PRT definiert]
• Ereignisse:
  • [wie im PRT definiert]

Provider SNMP

Mit Provider SNMP werden Geräte angesprochen, welche per SNMP-Protokoll über eine IP-Adresse gesteuert werden können.

• Klassifikation: Passiv

• Netzwerk / Kommunikation: IP-Adresse

• Aktionen:

  • [wie im PRT definiert]

• Ereignisse:

  • [wie im PRT definiert]

Provider Software API

Mit Provider Software API werden PCs oder Software angesprochen, welche über ein von Synergie entwickeltes Protokoll (die sog. Software API) ferngesteuert werden können.

Über diese Software API, welche eine Art von Verallgemeinerung der Exhibit API darstellt, kann der NeuroomNet-Server dynamisch über verfügbare Aktionen und Ereignisse auf dem jeweiligen PC oder Software informieren werden und kann entsprechend ferngesteuert werden.

• Klassifikation: Passiv
• Netzwerk / Kommunikation: IP-Adresse
• Aktionen:
  • [über die Software API definiert]
• Ereignisse:
  • [über die Software API definiert]