Schnellstart¶
Diese Seite führt von einer leeren App bis zu einer ersten funktionierenden Dashboard-Konfiguration.
Voraussetzungen¶
- Android Studio mit aktuellem Android-SDK
- eine lauffähige App-Installation auf Gerät oder Emulator
- mindestens ein erreichbarer JSON- oder PNG-Endpoint
Die drei Konfigurationsquellen¶
Die App unterstützt drei Wege, eine Konfiguration zu beziehen:
- direkte URL auf eine Dashboard-JSON
- URL auf eine
index.jsonmit mehreren Profilen - lokale JSON-Datei aus dem Gerätespeicher
Minimale Dashboard-JSON¶
Die kleinste sinnvolle Konfiguration besteht aus einem Widget mit Status-Endpoint:
{
"schemaVersion": 1,
"dashboard": {
"title": "Mein Smart Home"
},
"widgets": [
{
"id": "ping",
"layout": {
"order": 10,
"size": "1/1"
},
"content": {
"mode": "icon_text",
"icon": {
"name": "wifi",
"defaultColor": "#0E7490"
},
"title": {
"mode": "static",
"value": "Server"
},
"value": {
"mode": "path",
"value": "status",
"fallback": "unbekannt"
}
},
"status": {
"request": {
"url": "https://example.org/api/ping"
}
}
}
]
}
Direkte URL laden¶
- App starten
- Einstellungsseite öffnen
- URL zur Dashboard-JSON eintragen
Speichern und ladenauslösen- Die App validiert die Datei, cached sie lokal und aktualisiert anschliessend alle Statusendpoints
index.json laden¶
Wenn die URL statt einer Dashboard-Datei eine index.json liefert:
- die URL wird gespeichert
- ein Profildialog mit allen Profilen erscheint
- das zuletzt verwendete Profil ist vorselektiert, falls es noch existiert
- nach der Auswahl wird die eigentliche Dashboard-JSON geladen und gecacht
Ein vollständiges Beispiel steht auf Index-JSON.
Datei vom Gerät öffnen¶
Auf der Einstellungsseite kann alternativ eine lokale JSON-Datei geöffnet werden.
Wichtig:
- die Datei wird gelesen und validiert
- die Konfiguration wird lokal gecacht
- gespeicherte URL und gespeicherte Profil-ID werden gelöscht
Was beim Start passiert¶
Beim Start verwendet die App diese Reihenfolge:
- gespeicherte URL und gespeicherte Profil-ID laden
- vorhandenen lokalen Cache lesen
- wenn Cache vorhanden ist: Cache sofort anzeigen und danach Status aktualisieren
- wenn kein Cache vorhanden ist, aber eine URL existiert: Quelle neu laden
- wenn gar nichts vorhanden ist: Einstellungsseite anzeigen
Theme einstellen¶
Im Reiter Farben der Einstellungsseite kann das App-Theme umgeschaltet werden:
AutoLightDarkCustom
Im Custom-Modus lassen sich die Theme-Farben inklusive Gruppenhervorhebung direkt über Farbpicker anpassen oder als JSON-Template importieren.
Debug-Refresh aktivieren¶
Im Reiter Debug kann aktiviert werden, dass vor jedem Datenabruf zuerst die Konfiguration neu von der gespeicherten URL geladen wird. Das hilft beim schnellen Feintuning der Dashboard-JSON.