Fixed Spelling

DocForWiki.md

@@ -1,38 +0,0 @@
-# Überblick
-Diese Codebase wured 08/09 2024 von Tim Schilling entwickelt um ein alltes gerät im Lechfeldmuseum der Stadt Königsbrunn zu ersetzten. Das Script ist für die Verwendung auf einen Raspberry Pi gedacht.
-Dieses Script verwendet für das Spielen von Videos VLC bzw die Commandline variante '''cvlc''', das Scipt weches für das Automatische Abspeielen der Videos sowie der wechsel zwischen den zwei Videos ist in Pyhton geschrieben.
-
-## Abhängigkeiten
-- vlc -> Video Lan Client, anwendung zum Abspielen von Videos
-- python3-rpi.gpio -> Python Bibliothek welche für die Verwendung der GPIO gebraucht wird.
-
-## Skripte
-Zusätzlich wurden für die Leichte Installation des Systems sowie für die Kontrolle im betrieb einige Shellskipts angelegt welche folgende Aufgaben haben:
-
-- setup.sh -> Setup Script welches mehrere aufgaben erfüllt, dies führt (in Reienfolge der Ausführtung)
-    1. Fragt den Nutzer ob für diesen der Autostart dienst Verwendet werden soll.
-    2. Fragt den Nutzer ob die GPIO Shutdown funktion des Raspberry Pi verwendet werden soll.
-    3. Führt ein Systemupdate über den APT aus
-    4. Installiert die Abhängigkeiten
-    5. Herunterladen der Aktuellen Scripte aus dem GitHub Repo
-    6. Herunterladen der Videos aus dem GitHub Repo (**ACHTUNG: Wenn sich die Datein im Repo Geänder haben müssen die Datein im Skript entsprechend Angepasst werden.**)
-    7. Festlegen von SystemD dienst Datein Inhalt
-    8. Erstellen der System D Service Datein und Einschalten dieser je nach vorheriger Nutzerauswahl
-    9. Einfügen der zeile in /boot/config.txt für GPIO Shutdown
-
-- video.py -> Script welches die Videos Abspielt
-- start.sh -> Skript zum starten der Wiedergabe, schaltet gleichzeitig den Autostart der Anwendung über einen SystemD dienst **EIN**
-- stop.sh -> Skript zum stoppen der Wiedergabe, schaltet gleichzeitig den Autostart der Anwendung über einen SystemD dienst **AUS**
-- reload.sh -> Skript zum Neustarten der Wiedergabe, stop diese über System D und startet diese wieder
-
-## Dateistrucktur
-```
-- PiVideo/
-    |- videos/
-    |   |- loop.mp4
-    |   |- trigger.mp4
-    |- video.py
-    |- start.sh
-    |- stop.sh
-    |- reload.sh
-```

README.md

@@ -1,29 +1,39 @@
-# PiVideo
+# Überblick
 
-## TO-DO
+Diese Codebase wurde 08/09 2024 von Tim Schilling entwickelt um ein altes gerät im Lechfeld Museum der Stadt Königsbrunn zu ersetzten. Das Skript ist für die Verwendung auf einen Raspberry Pi 4 gedacht unter verwendung von PiOS version 12 (Bookworm).
--~~ Add GPIO Shutdown and Start option to Script [see](https://raspberrypi.stackexchange.com/questions/117013/raspberry-pi-4-b-gpio-boot-and-shutdown-buttons) ~~
+Dieses Skript verwendet für das Spielen von Videos VLC bzw. die Kommandozeilen variante ```cvlc```. Im Normalzustnad wir ein demobild (siehe ./videos/thumb.jpg) angezeigt, bei betätigung einses GPIO Knopfes wird ein Kurzfilm (ca. 15 minuten) abgespielt. Dannach wird wieder das bild angezeigt.  Der Knopf schließt ```GPIO 17``` (PIN 11) auf ```GND``` (PIN 9) kurz.
-- Remove old files when reinstalling
 
-## Overview
+Das Skript wird Automatische bei jedem Reboot über einen SystemD dienst gestartet, soffern dies nicht vorher abgeschalten wurde.
-This is a collection of scripts which run a video in a loop until a Button connected to GPIO is Pressed.
-Then another video is played once.
 
-## Installation
+![Pinout des Raspberry Pis](./dokumentation/gpio-pinout-diagram.png)
-For installation download and run setup.sh. This will install the nesecary dependencys, create the needed folder structure and download the Script.
-It will also create a SystemD service to automaticly start the program when the Pi is booted.
 
-**CAUTION: IF THE VIDEO FILES IN THE REPO HAVE CHANGED PLEASE CHECK THE SCRIPT IF THEY ARE CORRECT!**
+## Abhängigkeiten
 
-```bash
+- vlc -> Video Lan Client, anwendung zum Abspielen von Videos
-wget -L "https://raw.githubusercontent.com/miT-nib-hcI/PiVideo/main/setup.sh" &&
+- python3-rpi.gpio -> Python Bibliothek welche für die Verwendung der GPIO gebraucht wird.
-chmod 755 setup.sh &&
+- fbi -> Frame Buffer Imageviewer, anwendung für das einzeigen von Bildern über den Framebuffer
-./setup.sh
-```
 
-## Configuration
+## Skripte
-Since it is a realativly simple Python script you can modify as needed.
+
-The videos which are played are in the videos folder, as the nameing of the files suggests the loop.mp4 is played on loop and the trigger.mp4 is played once when the GPIO button has been pressed.
+Es wurden mehrer Skripte für das Aufsetzen und die Bedienung geschreiben, weiteres wird hier beschrieben.
-You can replace the files as needed with your own files. The files included right now are just for demonstration.
+
+- setup.sh -> Setup Script welches mehrere aufgaben erfüllt, dies führt (in Reienfolge der Ausführtung)
+    1. Fragt den Nutzer ob für diesen der Autostart dienst Verwendet werden soll.
+    2. Fragt den Nutzer ob die GPIO Shutdown funktion des Raspberry Pi verwendet werden soll.
+    3. Führt ein Systemupdate über den APT aus
+    4. Installiert die Abhängigkeiten
+    5. Herunterladen der Aktuellen Scripte aus dem GitHub Repo
+    6. Herunterladen der Videos aus dem GitHub Repo (**ACHTUNG: Wenn sich die Datein im Repo Geänder haben müssen die Datein im Skript entsprechend Angepasst werden.**)
+    7. Festlegen von SystemD dienst Datein Inhalt
+    8. Erstellen der System D Service Datein und Einschalten dieser je nach vorheriger Nutzerauswahl
+    9. Einfügen der zeile in /boot/config.txt für GPIO Shutdown
+
+- video.py -> Script welches die Videos Abspielt
+- start.sh -> Skript zum starten der Wiedergabe, schaltet gleichzeitig den Autostart der Anwendung über einen SystemD dienst **EIN**
+- stop.sh -> Skript zum stoppen der Wiedergabe, schaltet gleichzeitig den Autostart der Anwendung über einen SystemD dienst **AUS**
+- reload.sh -> Skript zum Neustarten der Wiedergabe, stop diese über System D und startet diese wieder
+
+## Dateistrucktur
 
 ```
 - PiVideo/
@@ -35,5 +45,3 @@ You can replace the files as needed with your own files. The files included righ
     |- stop.sh
     |- reload.sh
 ```
-
-The button to trigger the video switch is by default conected to GPIO 17 and GND, you can change this in the Scipt itself if needed.