Mit Bruno verifizieren

Verwenden Sie die Bruno-Collection, um Authentifizierung, Geräteabfragen, Relaissteuerung, RS485-Übertragung und Abfrage von Befehlsergebnissen zu überprüfen. Im Vergleich zu den beiden curl-Anfragen deckt dieser Weg mehr ab, und die integrierten Assertions bestätigen die Antwortstruktur automatisch, statt JSON manuell zu vergleichen.

Vor dem Start

• Bereiten Sie clientId und clientSecret vor.
• Aktivieren Sie device:read; aktivieren Sie device:control oder device:config nur, wenn Sie Relais- oder RS485-Anfragen ausführen.
• Stellen Sie sicher, dass das Zielgerät und das Relais sicher gesteuert werden können.
• Noch keine Hardware oder Zugangsdaten? Kontaktieren Sie support@svnwi.com, um Test-Zugangsdaten und verfügbare Demo-Gerätemodelle anzufordern — Sie müssen keine Hardware im Voraus kaufen.

1. Bruno installieren

Laden Sie die Bruno-Desktop-App herunter. Installieren Sie für CI oder Umgebungen ohne Oberfläche die CLI:

npm install -g @usebruno/cli
bru --version

2. Collection abrufen

Sie benötigen nur den Ordner examples/bruno aus dem SDK-Repository, nicht das gesamte Repository. Verwenden Sie einen Sparse Checkout, um nur diesen Teil abzurufen:

git clone --filter=blob:none --sparse https://github.com/svnwi/wlte-openapi-sdk.git
cd wlte-openapi-sdk
git sparse-checkout set examples/bruno

Öffnen Sie diesen Ordner in der Bruno-Desktop-App:

examples/bruno/WLTE-OpenAPI/

3. Zugangsdaten konfigurieren

Die im Repository committete Datei environments/quickstart.bru enthält nur Platzhalter, daher ist es sicher, dass sie in der Git-Historie erscheint. Echte Zugangsdaten kommen in eine lokale Kopie, die niemals committet wird:

cd examples/bruno/WLTE-OpenAPI
cp environments/quickstart.bru environments/quickstart.local.bru

Öffnen Sie environments/quickstart.local.bru und ersetzen Sie nur:

clientId     ->  your_client_id
clientSecret ->  your_client_secret

Wählen Sie in Bruno die Umgebung quickstart.local. Collection-Skripte füllen accessToken, deviceId und commandId automatisch aus; relayIndex ist standardmäßig 1.

quickstart.local.bru ist bereits über .gitignore ausgeschlossen — ändern Sie diese Regel nicht.

4. Nur-Lese-Verifizierung durchführen

Führen Sie diese Anfragen in dieser Reihenfolge aus:

Reihenfolge	Anfrage	Zweck
1	00-auth / Auth	Access Token erhalten
2	01-device-queries / 01-list-devices	Zugängliche Geräte bestätigen und deviceId automatisch ausfüllen
3	01-device-queries / 02-get-device-real-time-status	Zustand eines Geräts aktualisieren und lesen
4	01-device-queries / 03-list-profiles	Gerätetypdefinitionen abfragen, um Fähigkeiten zu bestätigen
5	01-device-queries / 04-get-device-config	Aktuelle Konfiguration lesen (Baudrate, Jog-Dauer usw.)

Die integrierten Assertions bestätigen den HTTP-Status und die Antwortstruktur.

5. Optional: Gerätesteuerung überprüfen

Gerätebefehle ändern den tatsächlichen Hardwarezustand. Fahren Sie nur fort, wenn der API Client über die entsprechende Berechtigung verfügt und der Vorgang sicher ist; wählen Sie die benötigten Anfragen aus:

Reihenfolge	Anfrage	Zweck	Erforderliche Berechtigung
6	02-relay-control / 01-turn-relay-on	Ein Relais einschalten	device:control
7	02-relay-control / 02-turn-relay-off	Ein Relais ausschalten	device:control
8	02-relay-control / 03-jog-relay	Einen Jog auslösen	device:control
9	02-relay-control / 04-set-relay-jog-time	Jog-Dauer festlegen (ändert nicht den aktuellen Relaiszustand)	device:config
10	02-relay-control / 05-control-multiple-relays	Mehrere Relais in einer Anfrage steuern	device:control
11	04-rs485 / 01-rs485-transceive	RS485-Passthrough-Daten senden (erfordert ein RS485-fähiges Gerät)	device:control
12	04-rs485 / 02-set-rs485-baud-rate	RS485-Baudrate einstellen	device:config
13	03-command-result / 01-get-command-result	Endergebnis mit der commandId aus einem vorherigen Schritt abfragen	device:read

Überspringen Sie diesen gesamten Abschnitt für reine Nur-Lese-Integrationen. Setzen Sie vor dem Testen von RS485-Anfragen rs485DeviceId auf ein Gerät, das RS485 tatsächlich unterstützt (standardmäßig wird das erste gefundene Gerät verwendet, nur zur Navigation in der Collection, was keine RS485-Unterstützung impliziert).

Verwendung über die Kommandozeile

Die CLI ermöglicht die Auswahl der auszuführenden Ordner nach Pfad, sodass Sie Nur-Lese-Verifizierung und Gerätesteuerung als zwei separate Befehle statt eines halten können, der versehentlich Relaisvorgänge auslösen könnte:

cd examples/bruno/WLTE-OpenAPI

# Nur-Lese-Verifizierung: liest nur Daten, ändert nie den Gerätezustand
bru run --env-file environments/quickstart.local.bru \
  00-auth 01-device-queries

# Steuerungsverifizierung: bedient tatsächlich Relais und RS485-Geräte — stellen Sie zuerst sicher, dass dies sicher ist
bru run --env-file environments/quickstart.local.bru \
  02-relay-control 04-rs485 03-command-result

Führen Sie bru run --env quickstart nicht ohne Pfade aus

Ohne Ordnerpfad führt bru run alle Anfragen der Collection rekursiv aus, einschließlich Relais-Ein/Aus, Jog und RS485-Befehlen — auch wenn Sie nur eine Nur-Lese-Prüfung wollten. Geben Sie die Ordner immer explizit an, wie oben gezeigt.

Für eine erste Integration ist die Desktop-App praktischer, um Umgebungsvariablen, Assertions und Antwortinhalte zu untersuchen. Die CLI eignet sich besser für wiederholte Verifizierung oder CI.

Verifizierungsergebnis

Nach Abschluss dieser Seite haben Sie Folgendes überprüft:

• Authentifizierung des API Client
• Gerätezugriff, Echtzeitstatus, Konfiguration und Typdefinitionen
• Optional: Relaissteuerung, RS485-Übertragung und Abfrage von Befehlsergebnissen

Überwachen Sie kein gesamtes Konto durch wiederholte Anfragen an ein einzelnes Gerät. Verwenden Sie Gerätelisten für Massenansichten und WebSocket-Ereignisse für kontinuierliche Änderungen.

Nächste Schritte

• SDK integrieren
• Häufige Fehler ansehen
• REST API oder WebSocket wählen