Suche

    Dashboard

    Das System.Dashboard.ips.php-Skript ist eine zentrale Meldungsanzeige für die TileVisu. Jedes andere Skript kann mit einer einzigen Zeile eine Meldung hinzufügen – zum Beispiel „Batteriestatus überprüfen!“ oder „1 Blitzer gemeldet!“. Die Meldungen erscheinen gesammelt in einer Kachel, lassen sich per Klick bestätigen, verschwinden auf Wunsch zu einem festen Zeitpunkt von selbst und können sogar direkt zu einer passenden Seite der Visualisierung springen.

    Kachel Meldungen in der TileVisu mit fünf Meldungen in den Farben der Meldungstypen, jeweils mit Icon, Zeitstempel und OK-Schaltfläche
    Meldungskachel in der TileVisu mit allen Meldungstypen

    Wie alles begann

    Die Idee stammt aus dem Jahr 2010: Damals hat Horst im Forum seine Meldungsanzeige im WebFront vorgestellt, die später von lueralba für den Raspberry Pi angepasst wurde. Ich habe das Skript ab 2017 für mich weiterentwickelt und um vieles ergänzt: Meldungstypen mit eigenen Farben, ein Meldungstyp zum Seitenwechsel, die Auswahl der Reihenfolge, Zeitstempel und das Bestätigen per WebHook.

    Mit der neuen TileVisu kam 2023 eine eigene Kachel-Variante dazu, und mit der Version 7.0 habe ich das Skript komplett auf die TileVisu umgestellt und dabei kräftig entschlackt. Die Version 8.0 räumt die Schnittstelle auf: Meldungstypen haben jetzt sprechende Namen, Meldungen lassen sich über einen Schlüssel aktualisieren statt doppelt anlegen, und auf Wunsch geht zusätzlich eine Push-Nachricht an die TileVisu.

    Hinweis: Das Skript unterstützt nur noch die TileVisu, nicht mehr das WebFront. Mit Version 8.0 heißen die Aktionen zum Löschen remove und clear statt removeType und removeAll – bestehende Aufrufe bitte anpassen.

    Meldungstypen

    Jede Meldung hat einen Typ, der ihre Farbe bestimmt. Angegeben wird er als Name, aus Kompatibilitätsgründen werden auch weiterhin die Zahlen 0–4 akzeptiert:

    TypZahlBedeutungFarbe
    info0Info – Status, zur Kenntnisgrün
    error1Fehler – etwas ist kaputtrot
    warn2Warnung – bitte im Auge behaltengelb
    task3Aufgabe – etwas muss erledigt werdenblau
    event4Ereignis – etwas ist passiert (Anruf, Download …)orange

    Zu jeder Meldung lässt sich außerdem ein Icon angeben, zum Beispiel phone. Verwendet werden die Icons der TileVisu (Font Awesome), ohne Angabe wird message genommen. Standardmäßig sortiert das Skript die Meldungen nach Wichtigkeit: Fehler, Warnung, Ereignis, Aufgabe, Info.

    Voraussetzungen

    • Symcon ab Version 8.1 mit TileVisu
    • Meine Symcon Skript-Bibliothek ab Version 3.0 (__autoload.php, System.Functions.ips.php ab v5, System.Locals.ips.php)
    • Ein WebHook für die OK-Schaltflächen und für Meldungen mit Verlinkung (siehe Installation)

    Installation

    1. Skript anlegen: In Symcon ein neues Skript erstellen und den Inhalt von System.Dashboard.ips.php hineinkopieren.
    2. TileVisu eintragen: In der System.Locals.ips.php unter __WWX['VID_TV'] die ID der eigenen TileVisu hinterlegen, sie wird für das Springen zu Objekten benötigt.
    3. Skript ausführen: Einmal in der Konsole ausführen. Dabei entstehen die Variablen Meldungen (die Kachel), Meldungstyp (zum Löschen aller Meldungen eines Typs), Meldungsnummer und die versteckte Variable Daten.
    4. WebHook einrichten: Im WebHook Control einen Hook /hook/msg anlegen, der auf das Skript zeigt. Darüber laufen das Bestätigen per OK und das Springen zu einem Objekt.
    5. Kachel platzieren: Die Variable Meldungen in der TileVisu anzeigen.

    Ein erneutes manuelles Ausführen setzt alle Objekte wieder auf den Ausgangszustand und löscht dabei alle Meldungen.

    Meldungen aus eigenen Skripten

    Alle Aktionen laufen über IPS_RunScriptWaitEx mit der ID des Dashboard-Skripts, hier als 12345 angenommen.

    Meldung hinzufügen

    $number = IPS_RunScriptWaitEx(12345, [
        'action'    => 'add',
        'text'      => 'Batteriestatus überprüfen!',
        'type'      => 'warn',
        'image'     => 'car-battery',
        'removable' => true,
        'expires'   => time() + 3600,
    ]);
    

    Zurückgegeben wird die Nummer der neuen Meldung, bei einem Fehler 0. Bis auf text sind alle Parameter optional:

    ParameterBedeutung
    textMeldungstext
    typeMeldungstyp (siehe oben), Standard ist info
    imageName des Icons, Standard ist message
    removabletrue, wenn die Meldung per Klick auf OK gelöscht werden darf
    expiresZeitpunkt als Unix-Timestamp, zu dem die Meldung automatisch gelöscht wird
    openID eines Objekts der TileVisu, zu dem ein Klick auf den Meldungstext springt (bei jedem Meldungstyp)
    keyEindeutiger Schlüssel, z. B. battery. Gibt es schon eine Meldung mit diesem Schlüssel, wird sie aktualisiert statt neu angelegt
    pushtrue, um zusätzlich eine Push-Nachricht an die TileVisu zu schicken (bei key nur beim ersten Anlegen)

    Meldung mit Sprung in die Visualisierung

    $number = IPS_RunScriptWaitEx(12345, [
        'action' => 'add',
        'text'   => 'Anruf in Abwesenheit',
        'type'   => 'event',
        'image'  => 'phone',
        'open'   => 23456,
        'push'   => true,
    ]);
    

    Die ID bei open muss zu einem Objekt (Kategorie, Link usw.) gehören, das in der konfigurierten TileVisu vorhanden ist.

    Meldung über einen Schlüssel pflegen

    Mit key kann ein Skript dieselbe Meldung immer wieder aufrufen, ohne dass sich Duplikate ansammeln – praktisch für Zustände, die sich ändern:

    IPS_RunScriptWaitEx(12345, [
        'action' => 'add',
        'key'    => 'battery',
        'text'   => "$count Batterien schwach!",
        'type'   => 'warn',
        'image'  => 'car-battery',
    ]);
    

    Meldungen löschen

    // Eine bestimmte Meldung über ihre Nummer
    $success = IPS_RunScriptWaitEx(12345, ['action' => 'remove', 'number' => $number]);
    
    // Eine Meldung über ihren Schlüssel
    $success = IPS_RunScriptWaitEx(12345, ['action' => 'remove', 'key' => 'battery']);
    
    // Alle Meldungen eines Typs, z. B. alle Warnungen
    $success = IPS_RunScriptWaitEx(12345, ['action' => 'remove', 'type' => 'warn']);
    
    // Alle Meldungen
    $success = IPS_RunScriptWaitEx(12345, ['action' => 'clear']);
    

    Bei Erfolg wird 1 zurückgegeben, sonst 0.

    Meldungen abfragen

    // Anzahl aller Meldungen bzw. der Meldungen eines Typs
    $count = (int) IPS_RunScriptWaitEx(12345, ['action' => 'count']);
    $count = (int) IPS_RunScriptWaitEx(12345, ['action' => 'count', 'type' => 'error']);
    
    // Gibt es eine Meldung mit diesem Schlüssel? (1 oder 0)
    $exist = (int) IPS_RunScriptWaitEx(12345, ['action' => 'count', 'key' => 'battery']);
    
    // Typ der wichtigsten vorhandenen Meldung, z. B. 'error', oder 'none'
    $status = IPS_RunScriptWaitEx(12345, ['action' => 'status']);
    

    Mit status lässt sich zum Beispiel eine Ampel oder ein Kachel-Icon passend zur dringendsten Meldung einfärben.

    Konfiguration

    Im Abschnitt „Konfiguration“ lässt sich die Darstellung anpassen:

    EinstellungBedeutung
    $tvidID der TileVisu, standardmäßig aus __WWX['VID_TV']
    $fifotrue: älteste Meldung zuerst, false: neueste Meldung zuerst
    $prioNach Wichtigkeit sortieren, innerhalb eines Typs gilt $fifo
    $maxageMaximales Alter in Tagen je Meldungstyp, danach wird automatisch aufgeräumt (0 = nie)
    $nomsgHinweis anzeigen, wenn keine Meldung vorhanden ist
    $noicoIcons ausblenden
    $nobrd, $nobgdRahmen bzw. Hintergrund der Meldungen ausblenden
    $bfortOK-Schaltfläche vor dem Text anzeigen (nur zusammen mit $noico)
    $typesNamen und Farben der Meldungstypen
    $DEBUGDebug-Ausgaben einschalten

    Fragen und Anregungen gerne in meinem Forum-Thread zur Skript-Bibliothek .