SmartWeb

Über SmartWeb

1. Übersicht

SmartWeb ist eine lokale Bridge-Server-App für Android-Geräte.

Ihre Hauptaufgaben sind:

- Überprüfung des SmartThings-Authentifizierungsstatus und Unterstützung bei zugehörigen API-Aufrufen.

- Bereitstellung allgemeiner HTTP-Proxy-Funktionalität.

- Öffnen einer Seite in einem WebView (Browser) zum Anzeigen des finalen HTML-Codes.

- Schnittstelle zwischen SmartThings Edge-Treibern, lokalen Webseiten und Automatisierungsskripten.

2. Grundlegende Informationen

- Standardport: 8088

- Standard-Adressformat: http://Geräte-IP:8088

Beispiel:

- http://192.168.219.137:8088

3. Bildschirmaufbau

3.1 Server-Tab

Im Server-Tab können Sie den Status des Bridge-Servers und die Verwendung wichtiger APIs einsehen.

Beispiele für angezeigte Inhalte:

- Bridge-Server-Adresse

- /api/forward-Nutzungsformat

- /api/web-Nutzungsformat

- SmartThings-Authentifizierungsstatus-API

- Hintergrundausführungs-API für WebViews

3.2 Registerkarte „Einstellungen“

Auf der Registerkarte „Einstellungen“ können Sie die für die Nutzung der App erforderlichen Umgebungseinstellungen und -status überprüfen.

Beispiele:

- Status der Ausnahme bei der Akkuoptimierung

- Status der Benachrichtigungsberechtigungen

- Protokolle anzeigen/kopieren

- App-Versionsinformationen

4. Wichtige APIs

4.1 POST /api/ping

Beschreibung: Überprüft kurz den Bridge-Server-Status und den SmartThings-Authentifizierungsstatus.

Methode:

- Nur POST

Beispiel:

POST http://deviceIP:8088/api/ping

Beispielantwort:

{

"battery": 86,

"bridgeDevice": "phone",

"bridgeVersion": "Version: 2026.05.15",

"serverStartTime": "05/14 03:00",

"stOauthConnected": true,

"accessTokenExpiresAt": 1778773965000,

"accessTokenMinutesLeft": 1332

}

4.2 GET /api/smartthings/devices

Beschreibung:

Gibt eine Liste von SmartThings-Geräten in einem einfachen Format zurück.

Methode:

- Nur GET

Beispiel:

GET http://deviceIP:8088/api/smartthings/devices

Beispielantwort:

{

"items": [

{

"deviceId": "...",

"label": "Google Home Mini Library",

"name": "Google Home"

}

] }

Verwendung:

- Ermittlung der Geräte-ID anhand des Gerätenamens

- Suche nach Lautsprechernamen

- Auswahl von Geräten anhand von Bezeichnungen

4.3 GET /api/forward?url=origin_address

Beschreibung:

Ein Standard-HTTP-Proxy.

Methode:

- Nur GET

Beispiel:

GET http://deviceIP:8088/api/forward?url=https://api.smartthings.com/v1/devices

Verwendung:

- JSON-API-Aufrufe

- Lesen statischer HTML-Seiten

- SmartThings REST-API-Aufrufe

Funktionen:

- Übergibt die meisten Anfrageheader

- Verwendet automatisch Anmeldeinformationen, falls der Authorization-Header beim Aufruf der SmartThings-APIs fehlt

- Führt kein JavaScript aus

- Kann anfällig für Validierungsseiten von Cloudflare/Browsern sein

Achtung:

- Nicht geeignet für Websites, die JavaScript-Ausführung erfordern

4.4 GET oder POST /api/web?url=origin_address

Beschreibung: Öffnet die Seite in einer WebView und gibt das endgültige HTML zurück.

Methode:

- GET oder POST

Verwendung:

- Websites, die JavaScript benötigen

- Cloudflare-Validierungsseiten

- Websites, die nicht über /api/forward geladen werden

Beispiel:

GET http://deviceIP:8088/api/web?url=https://

Oder:

POST http://deviceIP:8088/api/web

Content-Type: application/json

{

"url": "https://",

"timeoutMs": 20000

}

Antwort:

- HTML-Body (text/html) bei Erfolg

- Fehlermeldung bei Fehler

Funktionen:

- Öffnet die Seite wie ein echter Browser

- JavaScript-Ausführung möglich

- Langsam, aber robust

Timeout-Parameter:

- timeout: Sekunden

- timeoutSeconds: Sekunden

- timeoutMs: Millisekunden

Beispiel:

- ?timeout=20

- ?timeoutSeconds=20

- ?timeoutMs=20000

Hinweis:

- Die Antwort ist der HTML-Body selbst, nicht JSON.

- Der Aufrufer muss den HTML-Code parsen, um die benötigten Werte zu erhalten.

4.5 GET oder POST /api/webview/run

Beschreibung:

Führt eine Seite in einer WebView im Hintergrund für einen festgelegten Zeitraum aus.

Methode:

- GET oder POST

Anwendungsfälle:

- Eine bestimmte Seite für einen festgelegten Zeitraum im Hintergrund ausführen.

- JavaScript-Operationen/Seitenausführung fortsetzen.

Beispiel:

GET http://deviceIP:8088/api/webview/run?url=http://hubaddress:port&timeout=60

Funktionen:

- Bis zu 5 Seiten gleichzeitig ausführen.

- Überschüssige Anfragen werden in einer Warteschlange gespeichert.

4.6 GET /api/webview/stop

Beschreibung:

Beendet die Ausführung einer im Hintergrund laufenden WebView.

Methode:

- Wird aktuell als GET verwendet

5. Unterschied zwischen /api/forward und /api/web

/api/forward

- Standard-HTTP-Proxy

- Schnell

- Geeignet für JSON-/API-Aufrufe

- Führt kein JavaScript aus

- Geeignet für statische Seiten/allgemeine APIs

/api/web - Browserbasiertes Lesen über WebView - Langsam, aber robust - JavaScript ausführbar

- Unterstützt Cloudflare/Browser-Validierungsseiten

- Geeignet für Seiten, die einen Browser benötigen

Empfohlene Kriterien:

- Allgemeine APIs/Statische Seiten: /api/forward

- Seiten, die in einem Browser geöffnet werden müssen: /api/web

6. Zusammenfassung der zulässigen Methoden

Nur POST

- /api/ping

- /api/smartthings/token

- /api/smartthings/access-token

Nur GET

- /api/smartthings/devices

- /api/forward

GET oder POST - /api/web - /api/webview/run

Zum Beenden

- /api/webview/stop

7. Erklärung des bridgeDevice-Werts

Das bridgeDevice für /api/ping ist eines der folgenden:

- tv

- pad

- phone

Bestimmungskriterien:

- tv: Android TV / Leanback-Geräte

- pad: smallestScreenWidthDp >= 600

- phone: Andere

8. Anwendungsbeispiele

8.1 Serverstatus prüfen

POST /api/ping

8.2 Geräteliste prüfen

GET /api/smartthings/devices

8.3 Allgemeiner API-Proxy

GET /api/forward?url=https://api.smartthings.com/v1/devices

8.4 Websites lesen, die einen Browser erfordern

GET /api/web?url=https://

9. Zusammenfassung

SmartWeb ist ein lokaler Bridge-Server, der auf Android-Geräten ausgeführt wird.

Wichtigste Funktionen:

- SmartThings-Authentifizierungsstatus prüfen

- Einfache Gerätelisten-API

- Standard-HTTP-Proxy (/api/forward)

- WebView-basiertes Browserlesen (/api/web)

- WebView im Hintergrund ausführen (/api/webview/run)

Insbesondere ermöglicht die Funktion /api/web das Lesen von Seiten, die über Standard-HTTP-Anfragen schwer zugänglich sind, mithilfe eines Browsers.

• ↗Es spielt eine Rolle bei der Überprüfung des SmartThings-Authentifizierungsstatus und bei der Unterstützung zugehöriger API-Aufrufe.