HowTo: MagicMirror – 3rd-Party-Module installieren

Wie im Artikel MagicMirror – Installation der benötigten Software bereits angedeutet lässt sich die Grundfunktionalität der MagicMirror-Software durch diverse Plugins erweitern. Wo Ihr diese Plugins findet und wie Ihr sie dann installiert ist im folgenden Artikel beschrieben.


Sicherheitshinweise

Ich weiß die folgenden Hinweise sind immer irgendwie lästig und wirken unnötig. Aber leider haben schon viele Menschen die es "besser" wussten aus Leichtsinnigkeit Augen, Finger oder anderes verloren bzw. sich verletzt. Im Vergleich dazu ist ein Datenverlust fast nicht der Rede Wert, aber auch diese können echt ärgerlich sein. Deswegen nehmt Euch bitte fünf Minuten Zeit um die Sicherheitshinweise zu lesen. Denn auch das coolste Projekt ist keine Verletzung oder anderen Ärger wert.
https://www.nerdiy.de/sicherheitshinweise/


Voraussetzungen

Hilfreiche Artikel:
Bevor ihr mit der Installation startet solltet ihr den RaspberryPi soweit vorbereitet haben, dass dieser über das Netzwerk erreichbar und per SSH Steuerbar ist. Außerdem sollte die MagicMirror-Software eingerichtet sein.

Die folgenden Artikel beschreiben was zu tun ist um den RaspberryPi soweit vorzubereiten:
RaspberryPi – Einrichten für Nerdiys!
RaspberryPi – Die Erste Konfiguration!
RaspberryPi – Den RaspberryPi über SSH steuern

MagicMirror – Installation der benötigten Software

Benötigtes Material:
-keins-

Benötigtes Material:

In der folgenden Liste findet Ihr alle Teile die Ihr zur Umsetzung dieses Artikels benötigt.


Finden des gewünschten Moduls

In dem sehr informativen Github https://github.com/MichMich/MagicMirror/ gibt es unter anderem eine Liste aller verfügbaren 3rd-Party-Module: https://github.com/MichMich/MagicMirror/wiki/3rd-party-modules

Dort sind alle Module inklusive einer kurzen Beschreibung aufgelistet.

Für diesen Artikel wird als Beispiel das Modul „MMM-NetworkConnection“ installiert.
Ihr findet es in der oben angegebenen Liste oder unter dem Link: https://github.com/slametps/MMM-NetworkConnection
Die Installation der Module ist dabei fast immer sehr identisch.

Das Modul „MMM-NetworkConnection“ zeigt auf eurem MagicMirror aktuelle Werte zur Qualität Eurer Internetverbindung an.


Per SSH auf dem RaspberryPi einloggen

Um zu beginnen müsst Ihr Euch als erstes mit Putty per SSH auf dem RasPi einloggen. Wie das geht ist im Artikel RaspberryPi - Den RaspberryPi über SSH steuern beschrieben.

Nach der Eingabe Eures Benutzernamen und Passworts könnt Ihr die ersten Befehle eingeben.

Installation des Moduls

In den meisten Fällen ist auf der GitHub-Seite des jeweiligen Moduls bereits eine kleine Schritt-für-Schritt Anleitung angegeben.
Das Verfahren ist dabei fast immer sehr ähnlich.

1. Kopieren der Moduldateien aus dem GitHub auf euren RaspberryPi

Wechselt dazu zunächst in das Modul-Verzeichnis Eurere MagicMirror Installation.
Standardmäßig könnt Ihr mit folgendem Befehl dahin wechseln:

cd ~/MagicMirror/modules

Nun müsst ihr die GitHub-Datein des gewünschten Moduls in Euren Module Ordner kopieren.
Dies geht mit folgendem Befehl:

git clone https://github.com/slametps/MMM-NetworkConnection.git

Wobei der Link „https://github.com/slametps/MMM-NetworkConnection.git“ dem Link zu dem gewünschten Modul entspricht. Beachtet dabei aber, dass dem Link noch ein „.git“ angehängt werden muss.

Nach der Eingabe des Befehls werden die Plugin-Dateien auf Euren RaspberryPi kopiert.

2. Installieren eventuell benötigter Softwarekomponenten

In vielen Fällen benötigen die MagicMirror-Module andere Softwarekomponenten um korrekt funktionieren zu können. Diese müssen deshalb zuvor installiert werden.
Das praktische dabei ist, dass fast jedes Modul dazu ein Installationsskript mitliefert.
Zur Installation müsst Ihr lediglich in das Modulverzeichnis wechseln und dann die Installation starten.
Wechselt dazu mit

cd ~/MagicMirror/modules/MMM-NetworkConnection

in das Modulverzeichnis und startet die Installation mit dem Befehl

npm install

3. Bearbeiten der MagicMirror-Konfigurationsdatei

Bisher habt Ihr die benötigten Dateien und Softwarekomponenten installiert. Nun müsst Ihr der MagicMirror Software nur noch „bescheid geben“, dass dort ein Modul schlummert, dass beim nächsten Start des MagicMirrors geladen werden soll. Außerdem könnt Ihr dann noch ein paar Einstellungen zum Modul angeben.

Um der MagicMirror-Software diese ganzen Einstellungen mitzuteilen müsst Ihr die Konfigurationsdatei zunächst öffnen. Dies geht mit folgendem Befehl

sudo nano ~/MagicMirror/config/config.js
{
    module: 'MMM-NetworkConnection',
    position: 'top_right',
    config: {
    }
}

An dieser Stelle könnt ihr euer Modul auch noch „feiner“ einstellen. Es gibt oft viele zusätzliche Konfigurationsmöglichkeiten. Für dieses Modul gibt es zum Beispiel noch folgende Konfigurationsmöglichkeiten

(Zitat aus dem GitHub)

Config Options

Option Default Description
updateInterval 600000 ms (10 minutes) how often should the devices states refreshed
maxTime 5000 milliseconds how long to do speedtest
initialLoadDelay 2500 milliseconds how long to delay to load the module
decimal 1 how many decimals for the round
displayTextStatus true display connection text status or not
animationSpeed 2500 milliseconds speed of the update animation

Würdet Ihr zum Beispiel das updateInterval – also den Zeitinterval nach dem die Anzeige des Moduls aktualisiert wird – verändern wollen so würde der komplette Konfigurationsteil des Moduls wie folgt lauten:

{
    module: 'MMM-NetworkConnection',
    position: 'top_right',
    config: {
            updateInterval: "300000"
    }
}

Dabei steht die „300000“ für die Zeit nach der das Modul aktualisiert wird.
Die anderen Einstellungen werden auf die gleiche Weise hinzugefügt.
Falls ihr die Einstellungen in der Konfigurationsdatei nicht explizit festlegt verwendet das Modul die Standardeinstellungen.

Zum einfügen der Konfiguration navigiert Ihr mit den Pfeiltasten bis zum Ende der Konfigurationsdatei.
Dort ist es wichtig, dass Ihr die Konfiguration des Moduls zwischen schließender geschweifter und schließender eckiger Klammer einfügt. Die Konfigurations-„Blöcke“ sind immer in geschweiften Klammern zusammengefasst. sollte Euer MagicMirror nach einer Änderung mal nicht starten liegt dies höchstwahrscheinlich an vergessenen oder falsch positionierten Klammern.
Nach einem Absatz…
…könnt Ihr dort also den Konfigurationsteil des neu installierten Moduls einfügen.
Es ist dann sehr hilfreich, wenn Ihr diesen auch wieder auf die Höhe der anderen Modulkonfigurationen einrückt. Das vereinfacht die Lesbarkeit und ggf. auch die Fehlersuche. 🙂
Danach könnt Ihr die Konfigurationsdatei mit „STRG-X“ speichern…
…und mit einem Druck auf „Enter“ schließen.

4. Übernahme der Einstellungen

Zur Übernahme der Einstellungen müsst Ihr nichts weiter tun, außer die Konfigurationsdatei speichern und schließen. Die Änderungen werden dann automatisch erkannt und insofern keine Fehler in der Konfigurationsdatei sind übernommen.
Sollte das neue Modul nicht automatisch geladen werden so könnt Ihr den MagicMirror auch manuell neu starten. Dies ist am Ende des folgendem Artikels beschrieben:
MagicMirror – Autostart einrichten


Weitere Informationen

https://github.com/MichMich/MagicMirror
https://github.com/MichMich/MagicMirror/wiki/3rd-party-modules
https://github.com/slametps/MMM-NetworkConnection
https://forum.magicmirror.builders/topic/4231/how-to-add-modules-for-absolute-beginners


Ich hoffe bei euch hat alles wie beschrieben funktioniert. Falls nicht oder ihr Fragen oder Anregungen habt lasst es mich in den Kommentaren bitte wissen. Ich trage dies dann ggf. in den Artikel nach.
Auch Ideen für neue Projekte sind immer gerne willkommen. 🙂

Fab

P.S. Viele dieser Projekte - besonders die Hardwareprojekte - kosten viel Zeit und Geld. Natürlich mache ich das weil ich Spaß daran habe, aber wenn Du es cool findest, dass ich die Infos dazu mit Euch teile, würde ich mich über eine kleine Spende an die Kaffeekasse freuen. 🙂

Buy Me a Coffee at ko-fi.com

Kommentar hinterlassen

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.