====== Message Center ======

++++ 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:

  * Initiale Version

[[https://github.com/LoxYourLife/message-center]]

++++

----

===== Funktion des Plugins =====

Das Plugin ist recht einfach und liest lediglich Loxone Systemmeldungen aus und spielt sie dem Miniserver wieder zu um damit dann Auswertungen und Schaltungen zu realisieren. Die Idee kam von Markus (Allroundbastler) - dass er gerne einen Schaltschrank in einer Farbe leuchten lassen will, wenn eine entsprechende Meldung vorliegt.

Im Miniserver selbst kann man das nicht abgreifen, daher muss aktuell der Umweg über das Plugin gegangen 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.
  - desc -> Text: Eine ausführliche Beschreibung des Problems, nützlich für TTS ausgaben
  - severity -> Zahl: Die Warnstufe: 1: Info, 2: Warnung, >3: Fehler
  - title -> Text: Ein kurzer Titel des Fehlers
  - hasConfirmAction (Ab v.0.0.2) -> Digital: gibt an ob die Meldung bestätigt werden kann/muss.

===== Automatisches quittieren =====

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:

  * 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]]]

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 =====

  - MQTT Topic Name: Das Topic in dem die Meldungen veröffentlicht werden sollen.
  - Abfrage Intervall: Der Zeitraum in dem die Meldungen vom Miniserver geladen werden.

===== Einrichtung in der Loxone Config Software =====

Es müssen 6 Virtuelle Eingänge definiert werden.

  * Virtueller Texteingang: "MessageCenter_message_affectedName"
  * Virtueller Texteingang: "MessageCenter_message_desc"
  * Virtueller Texteingang: "MessageCenter_message_title"
  * Virtueller Texteingang: "MessageCenter_message_entryUuid"
  * Virtueller Eingang: "MessageCenter_message_severity"
  * Virtuelle Digitaler Eingang: "MessageCenter_message__hasConfirmAction"

===== Roadmap =====

Erstmal nichts ...

===== Fragen stellen und Fehler melden =====

[[https://www.loxforum.com/forum/projektforen/loxberry/plugins/372930-plugin-message-center|Loxforum]]