Metainformationen zur Seite

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Nächste Überarbeitung
Vorhergehende Überarbeitung
plugins:message_center:start [2022/12/30 14:13] – angelegt Ronald Markseplugins:message_center:start [2023/01/03 23:22] (aktuell) Ronald Markse
Zeile 1: Zeile 1:
-====== Message Center  ======+====== Message Center ======
  
 ++++ Version History... | ++++ Version History... |
 +
 +Version 0.0.3:
 +
 +  * Fix error message text to indicate that express is missing
 +  * Use a logger and Loglevel from plugin settings
 +  * fix message sending during installation
 +  * use async mqtt npm package
 +
 +Version 0.0.2:
 +
 +  * Problem mit MQTT Reconnect behoben
 +  * Problem mit dem Update des Plugins behoben der während der Installation auftrat.
 +  * Korrektes MQTT Topic in den Einstellungen
 +  * Möglichkeit die Meldungen automatisch zu lesen und zu bestätigen
  
 Version 0.0.1: Version 0.0.1:
 +
   * Initiale Version   * Initiale Version
  
-https://github.com/LoxYourLife/message-center+[[https://github.com/LoxYourLife/message-center]]
  
 ++++ ++++
Zeile 19: Zeile 34:
  
 Es gibt 4 Felder die übertragen werden: Es gibt 4 Felder die übertragen werden:
 +
 +  - entryUuid (ab v.0.0.2) -> Text: Die eindeutige Id der Systemmeldung - kann benutzt werden um die Meldung zu lesen/bestätigen.
   - affectedName -> Text: Name des Geräts, sofern eins betroffen ist.   - affectedName -> Text: Name des Geräts, sofern eins betroffen ist.
   - desc -> Text: Eine ausführliche Beschreibung des Problems, nützlich für TTS ausgaben   - desc -> Text: Eine ausführliche Beschreibung des Problems, nützlich für TTS ausgaben
   - severity -> Zahl: Die Warnstufe: 1: Info, 2: Warnung, >3: Fehler   - severity -> Zahl: Die Warnstufe: 1: Info, 2: Warnung, >3: Fehler
-  - title -> Text: Ein kurzer Titel des Fehlers +  - title -> Text: Ein kurzer Titel des Fehlers 
 +  - hasConfirmAction (Ab v.0.0.2) -> Digital: gibt an ob die Meldung bestätigt werden kann/muss.
  
-===== Download =====+===== Automatisches quittieren =====
  
-→ https://github.com/LoxYourLife/message-center/releases+Ab Version 0.0.2 bietet das Plugin die Möglichkeit die Meldungen aus dem Miniserver direkt als gelesen zu markieren und oder zu bestätigen. Dazu kamen 2 neue Felder hinzu, die entryUuid und hasConfirmAction. Die entryUuid dient dazu Nachrichten als gelesen zu markieren und wenn hasConfirmAction auf 1 steht, kann die Meldung zusätzlich automatisiert bestätigt werden.
  
 +Dazu gibt es 2 Endpunkte vom Plugin die dementsprechend aufgerufen werden müssen:
  
-===== Installation =====+  * GET [[http://[loxberry-ip]/admin/express/plugins/message_center/message/mark-as-read/[enteryUuid]]] 
 +  * GET [[http://[loxberry-ip]/admin/express/plugins/message_center/message/mark-as-confirmed/[entryUuid]]]
  
-→ Es wird der [[https://wiki.loxberry.de/plugins/express_server/start|Express Server]] als Plugin benötigt.-+Die Virtuellen Ausgänge können über das beigelegte Template in Loxone implementiert und genutzt werden. Auf der Plugin Seite gibt es einen Download für das Template. Im Template selbst steht noch "POST", was falsch ist, es ist "GET"
 + 
 +===== Download ===== 
 + 
 +→ [[https://github.com/LoxYourLife/message-center/releases]] 
 + 
 +===== Installation =====
  
 +→ Es wird der [[https://wiki.loxberry.de/plugins/express_server/start|Express Server]] als Plugin benötigt.
  
 ===== Konfigurationsoptionen ===== ===== Konfigurationsoptionen =====
  
   - MQTT Topic Name: Das Topic in dem die Meldungen veröffentlicht werden sollen.   - MQTT Topic Name: Das Topic in dem die Meldungen veröffentlicht werden sollen.
-  - Abfrage Interval: Der Zeitraum in dem die Meldungen vom Miniserver geladen werden.  +  - Abfrage Intervall: Der Zeitraum in dem die Meldungen vom Miniserver geladen werden.
  
 ===== Einrichtung in der Loxone Config Software ===== ===== Einrichtung in der Loxone Config Software =====
  
-Es müssen Virtuelle Eingänge definiert werden.+Es müssen Virtuelle Eingänge definiert werden. 
   * Virtueller Texteingang: "MessageCenter_message_affectedName"   * Virtueller Texteingang: "MessageCenter_message_affectedName"
   * Virtueller Texteingang: "MessageCenter_message_desc"   * Virtueller Texteingang: "MessageCenter_message_desc"
   * Virtueller Texteingang: "MessageCenter_message_title"   * Virtueller Texteingang: "MessageCenter_message_title"
 +  * Virtueller Texteingang: "MessageCenter_message_entryUuid"
   * Virtueller Eingang: "MessageCenter_message_severity"   * Virtueller Eingang: "MessageCenter_message_severity"
 +  * Virtuelle Digitaler Eingang: "MessageCenter_message__hasConfirmAction"
  
 ===== Roadmap ===== ===== Roadmap =====
  
 Erstmal nichts ... Erstmal nichts ...
- 
  
 ===== Fragen stellen und Fehler melden ===== ===== Fragen stellen und Fehler melden =====
  
-Loxforum+[[https://www.loxforum.com/forum/projektforen/loxberry/plugins/372930-plugin-message-center|Loxforum]] 
  
 ---- struct data ---- ---- struct data ----
Zeile 62: Zeile 90:
 pluginuebersicht.logo : :plugins:message_center:icon_512.png pluginuebersicht.logo : :plugins:message_center:icon_512.png
 pluginuebersicht.status : ALPHA pluginuebersicht.status : ALPHA
-pluginuebersicht.version : 0.0.1+pluginuebersicht.version : 0.0.3
 pluginuebersicht.min_lb_version : 2.0 pluginuebersicht.min_lb_version : 2.0
-pluginuebersicht.url_release : https://github.com/LoxYourLife/message-center/archive/refs/tags/0.0.1.zip +pluginuebersicht.url_release : https://github.com/LoxYourLife/message-center/archive/refs/tags/0.0.3.zip 
-pluginuebersicht.url_prerelease : https://github.com/LoxYourLife/message-center/archive/refs/tags/0.0.1.zip+pluginuebersicht.url_prerelease : 
 pluginuebersicht.description : Das Plugin liest aus dem Miniserver die Systemmeldungen aus und spielt diese via MQTT zurück in den Miniserver um diese Meldungen auswerten zu können. pluginuebersicht.description : Das Plugin liest aus dem Miniserver die Systemmeldungen aus und spielt diese via MQTT zurück in den Miniserver um diese Meldungen auswerten zu können.
 pluginuebersicht.languages : DE, EN pluginuebersicht.languages : DE, EN