diff --git a/README.md b/README.md index 7ee988a..11ad567 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # tgbbz-dillingen-magic-mirror + Eine Sammlung an Python und Arduino-Skripten zur Umsetzung eines "MagicMirrors", die im Rahmen eines Berufsschulprojektes am TGBBZ Dillingen/Saar entstanden sind + +``` +- raspi/ + raspi/Notification.py + Behandelt E-Mail-Benachrichtigungen und fungiert als SMTP-Client + raspi/Dashboard.py + Stellt das eigentliche Dashboard des MagicMirrors zur Verfügung, basiert im wesentlichen + auf dem Web Application Framework Flask und der Template Engine Jinja + raspi/ReadUSB.py + Liest über die entsprechende Grätedatei (z.B. /dev/ACM0) den USB-Input des Arduinos aus und reicht die Informationen + an Dashboard.py zur Anzeige bzw. an Notification.py zur Benachrichtigung weiter + +- arduino + arduino/ReadData.ino + Liest Sensordaten von angeschlossenen Senoren aus, bringt sie in ein einheitliches Format (JSON) und überträgt sie per USB an den + angeschlossenen Raspberry Pi + +