Merge branch 'main' into feat/troubleshooting

Author: tobiassiegrist

content/german/basics/debugging.md

@@ -10,22 +10,22 @@ Schritt für Schritt erklärt, wie man den Debugger starten und verwenden kann.
 
 ### Applikation mit Debugger starten
 
-Zum Starten der Applikation mit Debugger werden die beiden Run Konfigurationen `crowpi-examples [debug]` und `Remote Debug` benötigt.
+Zum Starten der Applikation mit Debugger werden die beiden Run Konfigurationen `CrowPi Debug` und `CrowPi Remote Debug` benötigt.
 Diese sind nach dem Setup bereits korrekt eingestellt und können verwendet werden. Wichtig dabei ist die Reihenfolge, mit der die
 Konfigurationen gestartet werden. Dieses Vorgehen ist:
 
-1. Start von `crowpi-examples [debug]` **ohne** Verwendung vom Debug-Knopf
+1. Start von `CrowPi Debug` **ohne** Verwendung vom Debug-Knopf
 2. Warten bis die Konsolenausgabe meldet `Listening for transport dt_socket at address: 5005 (Attach debugger)`
-3. Starten von `Remote Debug`
+3. Starten von `CrowPi Remote Debug`
 
 Nachfolgend wird der Ablauf mit entsprechenden Abbildungen ergänzt. Als Erstes wird die Applikation im Debugmodus gestartet. Dazu muss die
-Konfiguration `crowpi-examples [debug]` angewählt werden. Gestartet wird die Konfiguration mit dem **Play Button**.
+Konfiguration `CrowPi Debug` angewählt werden. Gestartet wird die Konfiguration mit dem **Play Button**.
 {{< img alt="Debugmodus wählen und starten" src="basics/intellij-select-and-start-debug.JPG" >}}
 
 Als Zweites wird nun gewartet, bis die korrekte Ausgabe im Konsolenfenster erscheint:
 {{< img alt="App wartet auf Debugger" src="basics/intellij-waiting-for-debugger.JPG" height="500px" >}}
 
-Zum Starten des Remote Debugger die entsprechende Run Konfiguration `Remote Debug` auswählen und mit einem
+Zum Starten des Remote Debugger die entsprechende Run Konfiguration `CrowPi Remote Debug` auswählen und mit einem
 Klick auf das Käfer-Icon (Debug) starten. Das Debugfenster meldet nun, ob eine Verbindung hergestellt wurde.
 {{< img alt="Remote Debug starten" src="basics/intellij-start-remote-debug.JPG" >}}
 {{< img alt="Remote Debug verbunden" src="basics/intellij-debug-connected.JPG" >}}
@@ -58,9 +58,9 @@ platzieren. So kann die Ausgangslage gut analysiert werden.
 Wie vorgängig erklärt, wird zuerst der Breakpoint platziert, die Applikation im Debugmodus gestartet und der
 Debugger angehängt. Es werden also diese 3 Schritte durchgeführt:
 
-1. Start von `crowpi-examples [debug]` **ohne** Verwendung vom Debug-Knopf
+1. Start von `CrowPi Debug` **ohne** Verwendung vom Debug-Knopf
 2. Warten bis die Konsolenausgabe meldet `Listening for transport dt_socket at address: 5005 (Attach debugger)`
-3. Starten von `Remote Debug`
+3. Starten von `CrowPi Remote Debug`
 
 Da ein Fehler im 7-Segment Beispiel gesucht werden soll, wird das entsprechende Beispielprogramm nach Programmstart angewählt. Die Applikation
 läuft sofort, bis der Debugger am Breakpoint die Ausführung der Anwendung unterbricht.

content/german/basics/running.md

@@ -10,7 +10,7 @@ in einem separaten Kapitel zu finden.
 
 ## Starten des Application Framework
 Grundsätzlich wurde ein erster Start bereits zum Test am Ende des Setups ausgeführt. Benötigt wurden folgende 3 Schritte:
-1. Anwählen der Run Config `crowpi-examples [install]`
+1. Anwählen der Run Config `CrowPi Run`
 2. Starten mit Run Button
 3. Wählen der Applikation auf der Kommandozeile (falls keine Argumente verwendet werden)
 
@@ -36,12 +36,11 @@ Bei jedem Start werden also sogar die Unit tests ausgeführt. So kann eine optim
 
 ## Start mit Argument
 Der Start mit einem Argument soll es ermöglichen direkt eine der Applikationen auszuwählen, ohne die Nummer in der Kommandozeile eintippen 
-zu müssen. Dazu muss die `Run Konfiguration` angepasst werden. Dies funktioniert sowohl für `crowpi-examples [install]` als auch für 
-`crowpi-examples [debug]` genau gleich. 
+zu müssen. Dazu muss die `Run Konfiguration` angepasst werden. Dies funktioniert sowohl für `CrowPi Run` als auch für `CrowPi Debug` genau gleich. 
 - Das Kontextmenü bei der Run Konfiguration `Edit Configurations ...` öffnen.
 - Nun bei der gewünschten Konfiguration den Tab `Runner` öffnen und mit dem `+` ein neues Argument hinzufügen. Gewählt werden muss das `crowpi.
 laucher.args` und als Wert wird der exakte Name einer Applikation wie zum Beispiel `BuzzerApp` eingetragen.
 - Normales Starten der Applikation mit dem Play Button
-{{< img alt="Start mit Argument" src="basics/intellij-runconfig-args.JPG" height="500px" >}}
+{{< img alt="Start mit Argument" src="basics/intellij-runconfig-args.png" height="500px" >}}
 
 Jetzt startet der übliche Ablauf. Anstelle der Auswahl einer ExampleApp wird jedoch direkt die angegebene Applikation gestartet, also in diesem Fall die BuzzerApp.

content/german/components/button-matrix.md

@@ -93,7 +93,8 @@ mit `continue` der nächste Spielzug forciert. War hingegen alles richtig, so ka
 nächsten Spielers beginnt.
 
 Wenn irgendwann nur noch ein aktiver Spieler verbleibt, so wird eine Gewinnmeldung ausgegeben und die totale Punktzahl, welche der Anzahl
-an wiederholten Elementen entspricht.
+an wiederholten Elementen entspricht. Bevor die Applikation endet, wird noch der Poller gestoppt um die Button Matrix nicht länger
+abzufragen und somit Ressourcen freizugeben.
 
 {{< code file="src/main/java/com/pi4j/crowpi/applications/ButtonMatrixApp.java" language="java" >}}
 

content/german/components/led-matrix.md

@@ -103,6 +103,8 @@ Zeichen auf der Anzeige mit Scroll-Effekt dargestellt werden. Intern wird hierf
 genutzt. Um die `print` Methode zusammen mit Symbolen zu nutzen, können beliebig viele Symbole mit dem Muster `{NAME}`
 eingebunden werden, sprich `{HEART}` wird durch das eigentliche `HEART` Zeichen von `LedMatrixComponent.Symbol` ersetzt.
 
+Bevor die Applikation endet, wird die LED Matrix ordnungsgemäss mit `setEnabled` deaktiviert.
+
 {{< code file="src/main/java/com/pi4j/crowpi/applications/LedMatrixApp.java" language="java" >}}
 
 ## Weitere Möglichkeiten

content/german/components/seven-segment.md

@@ -71,9 +71,9 @@ jeweils von links nach rechts bewegt. Hierfür wird eine verschachtelte `for`-Sc
 insgesamt fünfmal wiederholt wird, während die innere Schleife über alle möglichen Animationszustände iteriert und diese nacheinander mit
 einer Verzögerung von 50 Millisekunden ausgibt.
 
-Nachdem diese Ladeanimation abgespielt wurde, geht die Applikation in eine Endlosschleife und stellt jeweils die aktuelle Uhrzeit dar. Die
-API-Methode `print(LocalTime time)` übernimmt hierbei den Grossteil der Arbeit und blinkt sogar automatisch wenn die Sekundenzahl zurzeit
-ungerade ist. Durch das Abbrechen vom Maven-Prozess lässt sich diese Applikation anschliessend wieder beenden.
+Nachdem diese Ladeanimation abgespielt wurde, geht die Applikation in eine Schleife für 15 Sekunden und stellt jeweils die aktuelle Uhrzeit
+dar. Die API-Methode `print(LocalTime time)` übernimmt hierbei den Grossteil der Arbeit und blinkt sogar automatisch wenn die Sekundenzahl
+zurzeit ungerade ist. Nach 15 Sekunden schaltet sich die Anzeige aus und die Applikation endet.
 
 {{< code file="src/main/java/com/pi4j/crowpi/applications/SevenSegmentApp.java" language="java" >}}
 

content/german/setup/intellij.md

@@ -58,46 +58,55 @@ fehlt nur noch die Startkonfiguration des Projekts welche in der nächsten Sekti
 ---
 
 ### 3. Einstellung der Run Konfiguration
-Das Projekt CrowPi der FHNW benutzt 3 Run Konfigurationen. In diesen ist definiert welche Teile des Codes auf welche Art und Weise 
-ausgeführt werden. Es besteht jedoch kein Grund zur Sorge, denn der grösste Teil davon ist bereits vordefiniert und es ist nur noch die IP-Adresse des Raspberry Pi einzutragen. 
-Verwendet werden die Konfigurationen: 
-- crowpi-examples [install]
-- crowpi-examples [debug]
-- Remote Debug 
-
-Dabei kopiert `crowpi-examples [install]` den aktuellen Code auf den Raspberry Pi. Dies funktioniert über eine Kombination aus `SSH/SCP`.
-Anschliessend wird der kopierte Code auf dem Raspberry Pi gestartet. `crowpi-examples [debug]` macht im Prinzip nichts anderes. Jedoch 
-werden andere Optionen bei der Verbindung ausgewählt und vor der eigentlichen Ausführung der Applikation wird auf eine Verbindung von einem Debugger gewartet. `Remote Debug` 
-stellt genau diesen Debugger zur Verfügung. Dieser verbindet sich mit dem Raspberry Pi und die Fehlersuche kann beginnen. Näheres wie 
-dies findet man hier: [Starten und Debuggen auf dem CrowPi](TODO)
+Das Projekt CrowPi der FHNW benutzt vier Run Konfigurationen. In diesen ist definiert welche Teile des Codes auf welche Art und Weise 
+ausgeführt werden. Es besteht jedoch kein Grund zur Sorge, denn der grösste Teil davon ist bereits vordefiniert und es ist nur noch die
+IP-Adresse des Raspberry Pi einzutragen. Verwendet werden die Konfigurationen: 
+- `CrowPi Run`
+- `CrowPi Run (Demo Mode)`
+- `CrowPi Debug`
+- `CrowPi Remote Debug`
+
+Dabei kopiert `CrowPi Run` den aktuellen Code auf den Raspberry Pi. Dies funktioniert über eine Kombination aus `SSH/SCP`. Anschliessend
+wird der kopierte Code auf dem Raspberry Pi gestartet. `CrowPi Debug` macht im Prinzip nichts anderes. Jedoch werden andere Optionen bei
+der Verbindung ausgewählt und vor der eigentlichen Ausführung der Applikation wird auf eine Verbindung von einem Debugger gewartet.
+`CrowPi Remote Debug` stellt genau diesen Debugger zur Verfügung. Dieser verbindet sich mit dem Raspberry Pi und die Fehlersuche kann beginnen.
+Näheres wie dies findet man hier: [Starten und Debuggen auf dem CrowPi]({{< ref "basics/debugging" >}})
+
+Zusätzlich existiert auch noch eine Konfiguration `CrowPi Run (Demo Mode)`, welche genau gleich wie `CrowPi Run` funktioniert und zusätzlich
+den Parameter `--demo` übergibt. Dies bewirkt, dass der Launcher sich nach Ausführung einer Applikation nicht mehr selber beendet sondern
+mehrere Beispiele nacheinander ausgeführt werden können. Wie der Name schon sagt, ist dies besonders für Demozwecke praktisch.
 
 Damit dies alles reibungslos funktioniert muss nun aber zunächst wie erwähnt die IP-Adresse des Raspberry Pi eingestellt werden. Dazu 
 hier klicken und `Edit Configurations` wählen. Die IP-Adresse des Raspberry Pi wird, wie zuvor erklärt, auf dem Hintergrundbild des 
 CrowPi angezeigt.
 {{< img alt="Konfigurationsmenu auswählen" src="setup/intellij-select-configuration.JPG" height="500px" >}}
 
-Nun öffnet sich der Dialog zum Einstellen der Konfigurationen. EIn kleiner Hinweis: Überall wo die IP-Adresse des Raspberry Pi hingehört 
+Nun öffnet sich der Dialog zum Einstellen der Konfigurationen. Ein kleiner Hinweis: Überall wo die IP-Adresse des Raspberry Pi hingehört 
 steht bereits als Platzhalter `Add CrowPi IP here`. 
-{{< img alt="Die drei Konfigurationen" src="setup/intellj-three-configs.JPG" height="500px" >}}
+{{< img alt="Die vier Konfigurationen" src="setup/intellij-run-configs.png" height="500px" >}}
 
-Als Erstes wird `crowpi-examples [debug]` konfiguriert. Dazu wie auf dem Bild den Tab `Runner` öffnen und dann auf `Add CrowPi IP here` 
+Als Erstes wird `CrowPi Run` konfiguriert. Dazu wie auf dem Bild den Tab `Runner` öffnen und dann auf `Add CrowPi IP here` 
 doppelklicken. Danach öffnet sich das Dialogfenster für das Eintippen der IP-Adresse. Kurz mit `OK` bestätigen und mit `Apply` speichern. 
-{{< img alt="Einstellungen Debug" src="setup/intellij-setup-debugconfig.JPG" height="500px" >}}
+{{< img alt="Einstellungen für CrowPi Run" src="setup/intellij-setup-runconfig.png" height="500px" >}}
 
-Als Zweites folgt die `crowpi-examples [install]` Konfiguration. Diese funktioniert genau gleich wie eben die `crowpi-examples [debug]` 
+Als Zweites folgt die `CrowPi Debug` Konfiguration. Diese funktioniert genau gleich wie eben die `CrowPi Run` 
 Konfiguration. Genau die gleiche Einstellung ist nötig. Wiederum mit `Apply` speichern.
-{{< img alt="Einstellungen Install" src="setup/intellij-setup-runconfig.JPG" height="500px" >}}
+{{< img alt="Einstellungen für CrowPi Debug" src="setup/intellij-setup-debugconfig.png" height="500px" >}}
 
-Nun folgt auch schon die letzte Konfiguration `Remote Debug`. Hier stellt sich das Menü etwas anders dar. Jedoch ist es noch einfacher 
+Als Drittes kann optional auch `CrowPi Run (Demo Mode)` konfiguriert werden. Dies funktioniert ebenfalls gleich wie `CrowPi Run`, da auch
+hier die gleiche Einstellung nötig ist. Die andere Option mit `--demo` darf hier nicht angefasst werden. Wiederum mit `Apply` speichern.
+{{< img alt="Einstellungen für CrowPi Run (Demo Mode)" src="setup/intellij-setup-democonfig.png" height="500px" >}}
+
+Nun folgt auch schon die letzte Konfiguration `CrowPi Remote Debug`. Hier stellt sich das Menü etwas anders dar. Jedoch ist es noch einfacher 
 zu bedienen als die vorherigen. Kurz im Feld `Host` die IP-Adresse des Raspberry Pi eintragen. Mit `OK` beenden wird die Einstellung 
 beendet.
-{{< img alt="Einstellungen Remote Debug" src="setup/intellij-remotedebug-config.JPG" height="500px" >}}
+{{< img alt="Einstellungen für CrowPi Remote Debug" src="setup/intellij-setup-remotedebug.png" height="500px" >}}
 
 ---
 
 ### 4. Erster Testlauf
 Schon ist es geschafft. Alles ist eingerichtet, um ein erstes Mal das CrowPi Projekt direkt aus der Entwicklungsumgebung zu starten. 
-Dazu die Run Konfiguration `crowpi-examples [install]` auswählen. Danach durch Drücken von dem grünen Play Button die Applikation starten.
+Dazu die Run Konfiguration `CrowPi Run` auswählen. Danach durch Drücken von dem grünen Play Button die Applikation starten.
 {{< img alt="Start der Applikation" src="setup/intellij-start-firstapplication.JPG" height="500px" >}}
 
 Es öffnet sich sofort das `Run Fenster` von IntelliJ. Es dauert einen Moment und einiges an Text wird auf der Kommandozeile ausgegeben.