Skip to content

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:

  1. direkte URL auf eine Dashboard-JSON
  2. URL auf eine index.json mit mehreren Profilen
  3. 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

  1. App starten
  2. Einstellungsseite öffnen
  3. URL zur Dashboard-JSON eintragen
  4. Speichern und laden auslösen
  5. 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:

  1. die URL wird gespeichert
  2. ein Profildialog mit allen Profilen erscheint
  3. das zuletzt verwendete Profil ist vorselektiert, falls es noch existiert
  4. 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:

  1. gespeicherte URL und gespeicherte Profil-ID laden
  2. vorhandenen lokalen Cache lesen
  3. wenn Cache vorhanden ist: Cache sofort anzeigen und danach Status aktualisieren
  4. wenn kein Cache vorhanden ist, aber eine URL existiert: Quelle neu laden
  5. wenn gar nichts vorhanden ist: Einstellungsseite anzeigen

Theme einstellen

Im Reiter Farben der Einstellungsseite kann das App-Theme umgeschaltet werden:

  • Auto
  • Light
  • Dark
  • Custom

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.

Erste sinnvolle nächste Schritte