Skip to content

jalibu/MMM-NINA

Repository files navigation

MMM-NINA

version Known Vulnerabilities

Eine simple Client Implementierung der NINA Warn App API für die MagicMirror² Plattform.
Klicke hier für den Forum Thread.

Feedback und Mithilfe willkommen.

Support

Wenn du meine Arbeit schätzt, dann freue ich mich über einen bescheidenen Beitrag zu meinem nächsten Feierabend-Bier.

Features

  • Das Modul ruft periodisch die NINA API auf und ermittelt Warnmeldungen für deinen Kreis. Screenshot1
  • Es können Alarme mehrerer Städte/Gemeinden gleichzeitig abgerufen werden.
  • Identische Warnungen können zusammengefasst werden. Screenshot2
  • 2 unterschiedliche Themes

Installation

  1. Navigiere in das MagicMirror/modules Verzeichnis und führe folgendes Kommando aus, um das Projekt auf deine Festplatte zu klonen:

    git clone https://github.com/jalibu/MMM-NINA
  2. Ermittle den amtlichen Gemeindeschlüssel deines Ortes aus dieser Liste.

  3. Binde das Modul abschließend in die MagicMirror-Konfiguration MagicMirror/config/config.js ein (Beispiel Konfiguration).

     {
         module: "MMM-NINA",
         position: "top_right",
         config: {
             ags: ["110000000000"], // Liste der Gemeinden, die abgefragt werden sollen
             downgradeLhpSeverity: false,
             downgradeCancelSeverity: true,
             hideCancelledWarnings: false,
             excludeProviders: [], // Mögliche Werte ["MOWAS", "DWD", "BIWAPP", "LHP"]
             maxAgeInHours: 6,
             maxWidth: "200px",
             mergeAlertsById: true,
             mergeAlertsByTitle: true,
             orderBySeverity: true,
             showIcon: true,
             showDate: true,
             showCity: true,
             showNoWarning: true,
             theme: "top", // Erlaubte Werte: top, top-floating, side
             updateIntervalInSeconds: 120,
    
         }
     }

Optionen

Feld Beschreibung Default
ags (Liste von Strings) Amtliche(r) Gemeindeschlüssel (AGS)
Wichtig: Werte unbedingt als String mit führenden Nullen angeben!
["110000000000"] (Berlin)
downgradeLhpSeverity (Boolean) Reduziert die Severity von Meldungen des Länderübergreifenden Hochwasser Portals (LHP) auf "Minor" false
downgradeCancelSeverity (Boolean) Aufgehobene Warnungen sollen grün dargestellt werden und nicht in ihrer ursprünglichen Severity. true
excludeProviders (Liste von Strings) Liste von Providern, dessen Meldungen nicht angezeigt werden sollen. Provider sind: "MOWAS", "DWD", "BIWAPP", "LHP" [] (kein Filter)
hideCancelledWarnings (Boolean) Verstecke aufgehobene Warnungen false
maxAgeInHours (Integer) Maximales Alter der Warnmeldungen in Stunden, bevor sie ausgefiltert werden 6
maxWidth (String) CSS Style für maximale Breite des Moduls, z.B. 220px. Weg lassen, zum Deaktivieren. undefined (deaktiviert)
mergeAlerts Veraltet. Bitte stattdessen mergeAlertsById verwenden. -
mergeAlertsById (Boolean) Sofern Alerts für mehrere Gemeinden abgefragt werden, wird versucht gleiche Meldungen zusammenzufassen true
mergeAlertsByTitle (Boolean) Sofern Alerts mit gleichem Titel vorliegen, wird versucht die Meldungen zusammenzufassen true
orderBySeverity (Boolean) Sollen Warnmeldungen absteigend nach ihrem Schweregrad angezeigt werden? true
showCity (Boolean) Soll der Name der Gemeinde angezeigt werden? true
showDate (Boolean) Soll das Datum der Meldung angezeigt werden? true
showIcon (Boolean) Soll ein Warn-Symbol vor den Warnungen angezeigt werden? true
showNoWarning (Boolean) Lässt eine Meldung "Keine Warnungen" erscheinen, falls keine Ereignisse vorliegen. false
updateIntervalInSeconds (Integer) Abstand in Sekunden, in dem Warnmeldungen vom NINA Server abgerufen werden 120 (2 Minuten)
theme (String) Welches Theme soll angewendet werden?
Verfügbare Themes: top, top-floating und side
side

Contribution and Development

This module is written in TypeScript and compiled with Rollup. The source files are located in the /src folder. Compile target files with npm run build.

Contribution for this module is welcome!