API Overview: Unterschied zwischen den Versionen
Lh (Diskussion | Beiträge) |
Fn (Diskussion | Beiträge) |
||
| Zeile 32: | Zeile 32: | ||
**[https://github.com/gudesystems/port.py Ports schalten] | **[https://github.com/gudesystems/port.py Ports schalten] | ||
**[https://github.com/gudesystems/check_gude.py Sensor Werte auslesen] | **[https://github.com/gudesystems/check_gude.py Sensor Werte auslesen] | ||
| + | **[https://github.com/gudesystems/upload.py Deploy firmware updates, configuration and/or ssl certificates] | ||
|- | |- | ||
|'''CLI'''<br />''Command Line Interface'' | |'''CLI'''<br />''Command Line Interface'' | ||
Aktuelle Version vom 14. Mai 2024, 16:22 Uhr
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 |
| |
| 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 |
||
| SNMP | SNMPv2 / SNMPv3 | Lesen/Schreiben Zustand der Ports (Relais oder eFuses) Lesen/Schreiben Namen der Ports (Relais oder eFuses) |
Positiv: Einsatz in SNMP Umgebung erwünscht Negativ: Gerät nicht komplett konfigurierbar |
||
| Modbus TCP | Modbus TCP | Lesen/Schreiben Zustand der Ports (Relais oder eFuses) Lesen Zustand der Eingänge |
Positiv: Einsatz in ModbusTCP Umgebung erwünscht Negativ: Gerät nicht komplett konfigurierbar |
||
| MQTT |
MQTT | Verteilung von Nachrichten über MQTT-Broker Verteilung von Sensordaten über MQTT-Broker |
Positiv: Publish von Daten lokal oder in der Cloud Positiv: Vollständiger Funktionsumfang durch CLI |
||