Skip to end of metadata
Go to start of metadata
Autor

Logo

Status

UNSTABLE

Version2021.06.10
Min. LB Version

LB 2.0.0.3

Downloadhttps://github.com/Woersty/LoxBerry-Plugin-Icon-Watchdog/archive/refs/tags/2021.06.10.zip
ZweckDas Plugin überwacht die Symbole eines Miniservers und stellt sie nach einem Firmware-Update des Miniservers wieder her.
Optional kann das Plugins eigene SVG Symbole relativ einfach in Loxone integrieren.
LanguagesEN, DE
DiskussionLoxForum-Thema
 Version History...

Inhalt



Download

https://github.com/Woersty/LoxBerry-Plugin-Icon-Watchdog/archive/refs/tags/2021.06.10.zip

Funktion des Plugins

Das Plugin dient dazu, die images.zip Datei auf dem Loxone Miniserver zu überwachen.
Diese Datei enthält die Symbole, welche in der Visualisierung zu sehen sind.

Bei jedem Miniserver-Firmware-Update wird diese Datei überschrieben und eigene Icons / Symbole fehlen wieder.
Damit ich diese nicht immer wieder händisch auf den Miniserver kopieren muss, habe ich das Plugin gebaut.

Weiterhin bietet das Plugin die Möglichkeit, eigene Symbole relativ einfach in die Loxone App einzubinden.

Installation

Das Plugin wird normal über die Plugin-Verwaltung installiert.
Im Tutorial Video wird dies kurz gezeigt.
Hier der Link dazu: https://github.com/Woersty/LoxBerry-Plugin-Icon-Watchdog/archive/refs/tags/2021.06.10.zip

Updates

Das Plugin unterstützt automatische Updates. 
Dabei werden die vorhandenen Daten beibehalten.

Konfigurationsoptionen

Keine

Einrichtung in der Loxone Config Software

In der Loxone Config muss man zuerst die gewünschten neue Symbole anlegen.
Es gibt drei Typen. Raumsymbole, Kategoriesymbole und Statussymbole.

Einrichtung / Verwendung des Plugins

Die Informationen zu den in der Loxone Config angelegten Symbolen sind in der .Loxone Projektdatei enthalten.

Diese Datei wird ins Plugin importiert. Anschließend zeig das Plugin alle konfigurierten Symbole und die dazugehörigen Symbole an.

Wird kein Symbol gefunden, wird der Eintrag rot dargestellt.
Änderbare, eigene Symbole, für die ein Symbol-Bild vorhanden ist, werden grün angezeigt.
Die Standard-Symbole, welche von Loxone ausgeliefert wurden, werden grau dargestellt sind aber nicht editierbar.

Anleitungsvideo

Es gibt auf YouTube ein Video, welches die Grundinstallation und erste Verwendung erklärt.
Das Video hat deutsche und englische Untertitel. Diese bitte entsprechend der Sprache auswählen.

Bedienung

Nach der Ersteinrichtung empfehle ich folgende Schritte für das Hinzufügen neuer Symbole:

-Laden der aktuellen Konfiguration aus dem Miniserver

-Anlegen der gewünschten Symbole in der Loxone Config - dabei nichts in den Symboleditor malen - nur OK drücken

-Speichern des Projektes mit der Diskette oben links in der Loxone Config 

-Import des Projektes in das Plugin durch Drag&Drop in die grüne Box (oder klicken in selbige)

-Durch einen Klick auf  werden die konfigurierten Symbole im Plugin dargestellt.

-Jetzt können neue SVG-Dateien per Drag&Drop in die blaue Box importiert werden (oder klicken in selbige)

-Dann auf ein Symbol, welches geändert werden soll klicken und aus dem Symbol-Browser das Symbol aussuchen

-Wenn man alle neuen Symbole zugeordnet hat nochmal auf klicken. (Achtung! Der Miniserver bootet neu.)

Eigene Symbolbilder - Was ist eine SVG - Datei und wie mache ich die?

SVG bedeutet skalierbare Vektrorgrafik.

Die Symbole, welche das Plugin verarbeiten kann müssen ein paar Voraussetzungen erfüllen.
Bei Nichterfüllung wird das Plugin die Grafik ablehnen.

Diese sind derzeit:
-Maximale Größe 25kB - man sollte aber versuchen unter 3 kB zu bleiben. Tipp: https://vecta.io/nano zum Verkleinern der Dateigröße.
-Die viewBox Einstellung muss 0 0 32 32 sein

Ich empfehle daher, sich durch einen Klick auf  eine Beispieldatei herunterzuladen und diese anzupassen.

Als Editor bietet sich zum Beispiel Inkscape an.

Eine einfache Methode, neue Bilder zu erstellen ist, sich eine Bitmap-Grafik als Basis zu nehmen und in ein SVG zu konvertieren.
Dazu verwende ich immer convertio.co. 

BMP zu SVG: https://convertio.co/de/bmp-svg/

Manchmal werden so gewandelte SVG in Inkscape nicht korrekt dargestellt.
Dann kann man versuchen, sie nach EPS und zurück zu wandeln: https://convertio.co/de/svg-eps/ sowie https://convertio.co/de/eps-svg/

Eigene Icons einreichen

Gern können eigene Symbole an mich gesendet werden, damit ich sie ins Plugin aufnehme.
Hierbei bitte Copyrights beachten, wenn es sich nicht um eigene Symbole handelt!
Lizenzpflichtige Symbole kann ich nicht nicht verwenden.
Bitte nur "lizenzfreie" Symbole einsenden. 
Die eMail Adresse ist 

Besonderheit, wenn man schon eigene Symbole gemalt hat

Wenn man schon eigene Symbole in der Loxone Config gezeichnet hat, werden diese als Pixelgrafiken / Bitmaps gespeichert.

Diese haben den Nachteil, dass sie eine unschöne Auflösung und Detailgenauigkeit haben.

Wenn man die Symbole nun direkt gegen SVG Dateien austauschen will, muss die Bitmap-Information aus dem Loxone Projekt entfernt werden.

Dazu lädt man das aktuelle Programm aus dem Miniserver in die Loxone Config und speichert es auf dem lokalen Rechner ab.

Diese Datei wird dann in das Plugin importiert. Nach dem Import gibt es einen Link zum Herunterladen des konvertierten Projekts:

Dieses konvertierte Projekt muss man nun wieder in der Loxone Config laden und in den Miniserver zurückspeichern.

Diese Schritte sind nur nötig, wenn man im Symbol-Editor der Loxone Config etwas gemalt hat.

Die aktuelle Version hat einen Bug - bitte das Projekt nicht in die Loxone Config zurückimportieren.
Programme im Programm-Baustein laufen sonst wegen fehlender Zeilenumbrüche nicht mehr.
Ich fixe das mit einem Update, kann aber beschädigte Programme nicht mehr wiederherstellen,
hier ist nur eine manuelle Wiederherstellung aus einem Backup möglich.

Roadmap

In einer dieser ersten Version gibt es erstmal nur wenige Symbole, es ist jedoch geplant, weitere Symbole durch Plugin Updates zur Verfügung zu stellen.

Fragen stellen und Fehler melden

Bitte Fehler direkt als Issues in GitHub melden oder wenn du keinen eigenen Zugang hast, im Forum melden, ich mache dann gegebenenfalls einen Fehlerbericht daraus.

Known issues / Bekannte Probleme

Leider gibt es ein paar Probleme, wenn man Symbole welche schon in der App verwendet wurden ändert.

Durch die Caching Funktionalität kommt es hier zu falschen Darstellungen von alten Symbolen.

Im Browser hilft es, den Cache zu löschen, bei der App, kann eine Neuinstallation der App helfen, falls das Neuanlegen des Miniservers nicht reicht.

Eine andere Möglichkeit ist, ein neues Symbol in der Loxone Config zu erstellen und dies dann zuzuordnen.


Das Plugin startet den Miniserver ungefragt neu, wenn beim Klicken auf eine Änderung an der images.zip festgestellt wird.
Das kann durch Hinzufügen eigener Symbole oder durch ein vorheriges Miniserver Update der Fall sein.

Es läuft außerdem um 20 Uhr ein täglicher Zeitjob, der die images.zip prüft.
Diese Reboots werden als "Manuelle Neustarts" in der Loxone App dargestellt.