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(S) und die Konsole (Command Line Interface) bieten vollen Zugriff auf das Gerät.

Aus Erfahrung mit erfolgreich realisierten Kundenprojekten sind folgende Basisfunktionen bei einer Integration wichtig:

• Ein- und Ausschalten der Ausgänge
• Reset Funktion pro Ausgang
• Abfrage des Port-Zustands
• Messdaten: Spannung, Strom + Fehlerstrom (RCM), Stromverbrauch, Energiezähler (ein Zähler rücksetzbar)
• Status des Überspannungsschutzes (Over Voltage Protection)
• Externe Sensordaten: Temperatur, Luftfeuchtigkeit und Luftdruck

Übersicht APIs
Protokoll	Transport	Funktions-Umfang	Positiv / Negativ	Weitere Informationen
CGI/JSON	HTTP(S)	Lesen/Schreiben aller Konfigurationsdaten Lesen/Schreiben aller Statusinformationen	Positiv: Vollständiger Funktionsumfang Negativ: Braucht HTTP(S) Bibliotheken und JSON Parser	EPC HTTP Interface HTTP JSON Sensor Data Demo Source-Code Ports schalten Sensor Werte auslesen Deploy firmware updates, configuration and/or ssl certificates
CLI Command Line Interface	Telnet / SSH / MQTT HTTP(S) / RS232	Lesen/Schreiben aller Konfigurationsdaten Lesen/Schreiben aller Statusinformationen	Positiv: Vollständiger Funktionsumfang Positiv: einfacher Umgang	Konsole
SNMP	SNMPv2 / SNMPv3	Lesen/Schreiben Zustand der Ports (Relais oder eFuses) Lesen/Schreiben Namen der Ports (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	Positiv: Einsatz in SNMP Umgebung erwünscht Negativ: Gerät nicht komplett konfigurierbar	SNMP
Modbus TCP	Modbus TCP	Lesen/Schreiben Zustand der Ports (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	Positiv: Einsatz in ModbusTCP Umgebung erwünscht Negativ: Gerät nicht komplett konfigurierbar	ModbusTCP
MQTT	MQTT	Verteilung von Nachrichten über MQTT-Broker Verteilung von Sensordaten über MQTT-Broker Ausführen von Konsolenkommandos	Positiv: Publish von Daten lokal oder in der Cloud Positiv: Vollständiger Funktionsumfang durch CLI	MQTT