API Overview

Dies ist eine Übersicht über die GUDE API (Application Programming Interface) zur Steuerung und zum Zugriff auf GUDE Geräte mit verschiedenen Protokollen.

Unsere APIs sind modular aufgebaut und somit einheitlich für alle GUDE Geräte zu verwenden. Wir verwenden eine REST-API. Die Geräte können automatisch über die folgenden fünf verschiedenen Schnittstellen angesprochen werden, die unterschiedliche Möglichkeiten zur Steuerung und zum Zugriff auf die Konfigurationsdaten und Statusinformationen bieten. Nur http und die Konsole (telnet und seriell) bieten vollen Zugriff auf das Gerät.

Aus Erfahrung mit unzähligen realisierten Kundenprojekten sind folgende Basisfunktionen bei einer Integration wichtig:

• Schalten der Ausgänge: Ein und Aus
• Portstatus: Ein oder Aus
• Messdaten: Stromstärke, Spannung, Strom und Stromverbrauch + Fehlerstrom (RCM)
• Status des Überspannungsschutzes
• Plug&Play-Sensordaten: Temperatur, Luftfeuchte und Luftdruck

Übersicht EPC/ENC APIs
Protkoll	Transport	Funktions-Umfang	Pros / Cons	Weitere Informationen
CGI/JSON	HTTP / HTTPS	Lesen/Schreiben aller Konfigurationsdaten Lesen/Schreiben aller Statusinformationen	Pros: Vollständiger Funktionsumfang Cons: Braucht HTTP Blibliotheken und JSON Parse	EPC HTTP Interface HTTP JSON Sensor Data Demo Source-Code Ports schalten Sensor Werte auslesen
CLI Command Line Interface	Telnet / SSH / Serial / HTTP / HTTPS	Lesen/Schreiben aller Konfigurationsdaten Lesen/Schreiben aller Statusinformationen	Pros: Vollständiger Funktionsumfang, einfacher Umgang
SNMP	SNMPv2 / SNMPv3	Lesen/Schreiben Zustand der Powerports (Relais oder eFuses) Lesen/Schreiben Namen der Powerports (Relais oder eFuses) Lesen/Schreiben Zustand der Port Startkonfiguration Lesen/Schreiben Zustand Buzzer Lesen/Schreiben Konfiguration der Stromquellen Lesen/Schreiben Konfiguration des Lüfters Lesen Messwerte externer Sensoren Lesen Messwerte aller Energiesensoren Lesen NTP Zeit und Status Rücksetzen der Energiezähler Lesen Zustand Overvoltage Protection	Pros: Stark im SNMP Umfeld Cons: nicht alle Gerätefunktionen nutzbar
Modbus TCP	Modbus TCP	Lesen/Schreiben Zustand der Powerports (Relais oder eFuses) Lesen Zustand der Eingänge Lesen/Schreiben Konfiguration der Stromquellen Lesen/Schreiben Konfiguration des Lüfters Lesen Messwerte externer Sensoren Lesen Messwerte aller Energiesensoren Lesen Zustand Overvoltage Protection	Pros: Stark im ModbusTCP Umfeld Cons: nicht alle Gerätefunktionen nutzbar	ModbusTCP
MQTT	MQTT	Lesen/Schreiben aller Konfigurationsdaten Lesen/Schreiben aller Statusinformationen Ausführen von Konsolenkommandos	Pros: Vollständiger Funktionsumfang, einfach Umgang