From 58f990257a977fadb7aa1cbe9a171b5496f5d699 Mon Sep 17 00:00:00 2001 From: Max Krieger Date: Thu, 19 Oct 2023 15:34:24 +0200 Subject: [PATCH] Readme angepasst --- README.md | 122 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 78 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index e1d5fdf..758d6ea 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,7 @@ # Wachalarm-Kiosk -Hier finden Sie ein einfach zu nutzendes SD-Karten-Image für einen **Raspberry Pi**, mit dem der Wachalarm (oder eine andere Webseite) direkt im Vollbild z.B. auf einem Monitor anzeigt werden kann. +Hier finden Sie ein einfach zu nutzendes SD-Karten-Image für einen **Raspberry Pi**, mit dem GroupAlarm (oder eine andere Webseite) direkt im Vollbild z.B. auf einem Monitor anzeigt werden kann. -## Beispielfoto - -![Wachalarm FF Elsterwerda](https://user-images.githubusercontent.com/19272095/89555705-ae166100-d810-11ea-99d6-089c08687a14.png) ## Funktionen @@ -22,13 +19,13 @@ Hier finden Sie ein einfach zu nutzendes SD-Karten-Image für einen **Raspberry > > Benötigt wird ein Raspberry Pi ([kompatible Hardware](#hardware)). -1. Laden Sie das [aktuelle Image](https://github.com/Robert-112/Wachalarm-Kiosk/releases) aus dem Release-Bereich herunter. -2. Entpacken Sie die komprimierte Datei auf Ihrem Computer (z.B. dem Programm [7Zip](https://7-zip.de/index.html)). -3. Schreiben Sie das Image mit Hilfe eines SD-Karten-Lesegeräts auf eine SD-Karte. Hierzu kann unter Windows die Anwendung [Win32 Disk Imager](https://sourceforge.net/projects/win32diskimager/) genutzt werden. -4. Legen Sie die anzuzeigende [Webseite und die weitere Optionen fest](#konfigurations-datei). -5. *Optional*: Legen Sie fest, ob der Raspberry Pi sich automatisch mit einem [WLAN verbinden](#wlan-setup) soll. -6. *Optional*: Setzen Sie eine [feste IP-Adresse](#ip-adresse) für das System. -7. Setzen Sie die SD-Karte in den Raspberry Pi. Verbinden Sie Ihn mit dem Monitor und dem Internet (Netzwerkkabel oder WLAN). Starten Sie das Gerät. +1. Lade das [aktuelle Image](https://git.heko-technik.de/mkrieger/wachalarm/releases) aus dem Release-Bereich herunter. +2. Entpacke die komprimierte Datei auf dem Computer (z.B. dem Programm [7Zip](https://7-zip.de/index.html)). +3. Schreibe das Image mit Hilfe eines SD-Karten-Lesegeräts auf eine SD-Karte. Hierzu kann unter Windows die Anwendung [Win32 Disk Imager](https://sourceforge.net/projects/win32diskimager/) genutzt werden. +4. Lege die anzuzeigende [Webseite und die weitere Optionen fest](#konfigurations-datei). +5. *Optional*: Lege fest, ob der Raspberry Pi sich automatisch mit einem [WLAN verbinden](#wlan-setup) soll. +6. *Optional*: Setze eine [feste IP-Adresse](#ip-adresse) für das System. +7. Setze die SD-Karte in den Raspberry Pi. Verbinde Ihn mit dem Monitor und dem Internet (Netzwerkkabel oder WLAN). Starte das Gerät. --- @@ -40,17 +37,17 @@ Die wichtigsten Einstellungen lassen sich ohne vorkenntnisse (von z.B. Linux) di Benötigt wird ein SD-Karten-Lesegerät und ein Text-Editor. -1. Schließen Sie die zuvor mit dem Image beschriebene SD-Karte an ihren PC an (z.B. per USB-Adapter). -2. Im Datei-Explorer sollte jetzt ein neues Laufwerk erscheinen. In der Partition "Boot" der SD-Karte findet sich die Datei *[wachalarm_einstellungen.txt](https://github.com/Robert-112/Wachalarm-Kiosk/blob/custom/home/wachalarm_einstellungen.txt)*. +1. Schließe die zuvor mit dem Image beschriebene SD-Karte an ihren PC an (z.B. per USB-Adapter). +2. Im Datei-Explorer sollte jetzt ein neues Laufwerk erscheinen. In der Partition "Boot" der SD-Karte findet sich die Datei *[wachalarm_einstellungen.txt](https://git.heko-technik.de/mkrieger/wachalarm/blob/custom/home/wachalarm_einstellungen.txt)*. 3. folgende Einstellungen können gesetzt werden: #### Webseite beim Start -Legt fest, welche Webseite beim Start geöffnet werden soll. Wollen Sie den Wachalarm für die Feuerwehr Cottbus anzeigen wäre dies z.B. die Adresse https://wachalarm.leitstelle-lausitz.de/waip/520101 +Legt fest, welche Webseite beim Start geöffnet werden soll. Für Groupalarm wäre dies z.B. die Adresse https://app.groupalarm.com/de/monitor/12345?view_token=meingeheimertoken&theme=dark-theme ``` -startup_url=https://wachalarm.leitstelle-lausitz.de/waip/520101 +startup_url=https://app.groupalarm.com/de/monitor/12345 ``` #### Standby - Funktion ein-/ausschalten @@ -72,20 +69,24 @@ Legt fest, was für ein Monitor verwendet wird. Je nach Typ (PC-Monitor oder Fer Es gibt folgende Optionen: - t = Typ "TV", nutzt [CEC-Befehle](https://de.wikipedia.org/wiki/Consumer_Electronics_Control) um den Fernseher ein- oder auszuschalten -- m = Typ "Monitor", nutzt den Befehlssatz `vcgencmd display_power` um einen PC-Monitor ein- oder auszuschalten +- m = Typ "Monitor", nutzt den Befehlssatz `xrandr --output HDMI-*` um einen PC-Monitor ein- oder auszuschalten ``` screen_type=t ``` +> Achtung! +> +> Wird ein PC-Monitor verwendet, kann es zu Problemen bei der Sound-Ausgabe kommen. Lösungsansätze finden Sie im Abschnitt ["Bekannte Fehler"](#kein-ton-über-hdmi-raspberry-pi-4) + #### Standby - Websocket-URL *(gilt nur wenn die Standby-Funktion aktiviert wurde)* -Dieser Wert sollte normalerweise nicht geändert werden. Es handelt sich um die URL des Wachalarm-Servers, über welche die Websocket-Befehle empfangen und verarbeitet werden. Nur mit dieser URL kann das Standby-Signal korrekt ausgewertet werden. +Dieser Wert sollte normalerweise nicht geändert werden. Es handelt sich um die URL des Wachalarm-Servers, über welche Websocket-Befehle empfangen und verarbeitet werden. Nur mit dieser URL kann das Standby-Signal korrekt ausgewertet werden. ``` -standby_waipurl=https://wachalarm.leitstelle-lausitz.de/waip +standby_waipurl=https://wachalarm.heko-technik.de/waip ``` > **Achtung!** @@ -95,16 +96,12 @@ standby_waipurl=https://wachalarm.leitstelle-lausitz.de/waip #### Standby - Wachennummer *(gilt nur wenn die Standby-Funktion aktiviert wurde)* -Nummer der Wache, für die bei Alarmen der Monitor angeschaltet werden soll, z.B. 520101 für CB FW Cottbus +Nummer der Wache, für die bei Alarmen der Monitor angeschaltet werden soll, z.B. 52511 für FW GK LE Geilenkirchen ``` -standby_wachennr=520101 +standby_wachennr=52511 ``` -> **Achtung!** -> -> Hier sollte im Normalfall immer die gleiche Nummer des aufgerufenen Alarmmonitors hinterlegt werden (siehe Parameter `startup_url`). - #### System-Statusmeldungen aktivieren Hiermit kann ein automatisches Senden von Status-Meldungen aktiviert werden. @@ -124,7 +121,7 @@ report_enable=1 URL an welche Status-Meldungen durch das System gesendet werden. ``` -report_url=https://wachalarm.leitstelle-lausitz.de/client_statusmessage +report_url=https://wachalarm.heko-technik.de/client_statusmessage ``` #### automatische Neustarts @@ -147,11 +144,11 @@ restart_type=w WLAN-Verbindungen lassen Sich beim Raspberry über eine spezielle Datei vorgeben, ohne weitere Einstellungen am System zu tätigen. Gehen Sie wie folgt vor, um WLAN zu aktivieren: -1. Schließen Sie die zuvor mit dem Image beschriebene SD-Karte an ihren PC an (z.B. per USB-Adapter). -2. Im Datei-Explorer sollte jetzt ein neues Laufwerk erscheinen. In der Partition "Boot" der SD-Karte erstellen Sie eine Datei mit dem Namen `wpa_supplicant.conf`. -3. Eine fertige Vorlage findet sich hier: [wpa_supplicant.conf](https://github.com/Robert-112/Wachalarm-Kiosk/blob/custom/optional_boot_config/wpa_supplicant.conf) -4. Ersetzen Sie `Name-des-WLANs` und `ganz-geheimes-kennwort` mit Ihren eigenen WLAN-Einstellungen. -5. Speichern Sie die Datei auf der SD-Karte und setzen Sie diese wieder in den Raspberry Pi ein. Nach Abschluss des Startvorgangs sollte sich das Gerät eigenständig mit dem WLAN verbinden. +1. Schließe die zuvor mit dem Image beschriebene SD-Karte an ihren PC an (z.B. per USB-Adapter). +2. Im Datei-Explorer sollte jetzt ein neues Laufwerk erscheinen. In der Partition "Boot" der SD-Karte eine Datei mit dem Namen `wpa_supplicant.conf` erstellen. +3. Eine fertige Vorlage findet sich hier: [wpa_supplicant.conf](https://git.heko-technik.de/mkrieger/wachalarm/blob/custom/optional_boot_config/wpa_supplicant.conf) +4. Ersetze `Name-des-WLANs` und `ganz-geheimes-kennwort` mit den eigenen WLAN-Einstellungen. +5. Speicher die Datei auf der SD-Karte und setze diese wieder in den Raspberry Pi ein. Nach Abschluss des Startvorgangs sollte sich das Gerät eigenständig mit dem WLAN verbinden. #### Beispiel wpa_supplicant.conf für WLAN _mit Kennwort_ ``` @@ -190,7 +187,7 @@ Mittels der Datei `cmdline.txt` kann direkt eine feste IP-Adresse für den Raspb Damit wird die IP-Adresse für die Schnittstelle `eth0` auf 192.168.2.20 festlegt. Einstellungen für das Gateway (`192.168.2.1`), das Subnetz (`255.255.255.0`), den Hostnamen (`wachalarm`) und den DNS-Server (`192.168.2.1`) werden ebenfalls definiert. -Bereits angepasste `cmdline.txt`-Dateien finden Sie hier: [optional_boot_config](https://github.com/Robert-112/Wachalarm-Kiosk/blob/custom/optional_boot_config) +Bereits angepasste `cmdline.txt`-Dateien findet man hier: [optional_boot_config](https://git.heko-technik.de/mkrieger/wachalarm/tree/custom/optional_boot_config) --- @@ -198,33 +195,70 @@ Bereits angepasste `cmdline.txt`-Dateien finden Sie hier: [optional_boot_config] Dieses Image sollte mit allen bekannten [Raspberry Pi's](https://www.raspberrypi.org/products/) funktionieren. Die Versionen 3 und 4 werden empfohlen, da die älteren Varianten zu wenig Leistung bieten. Raspberry 3 und 4 haben zudem ein eingebautes WLAN-Modul. -Stellen Sie sicher, dass Sie eine [kompatible SD-Karte](http://elinux.org/RPi_SD_cards) verwenden (mind. 4 GB). `Class 10`-Karten sollten in jedem Fall funktionieren. +Stelle sicher, dass Sie eine [kompatible SD-Karte](http://elinux.org/RPi_SD_cards) verwenden (mind. 4 GB). `Class 10`-Karten sollten in jedem Fall funktionieren. Ein Raspberry Pi benötigt ein [2.5 A USB-Netzteil](https://www.raspberrypi.org/documentation/hardware/raspberrypi/power/README.md). --- +## Tastenkombinationen + +Wenn eine Tastatur (z.B. per USB) angeschlossen ist, stehen folgende Tastenkombination zur Verfügung: +- `STRG` + `i` -> schaltet den Monitor ein (I) +- `STRG` + `o` -> schaltet den Monitor aus (O) +- `STRG` + `ALT` + `r` -> startet den Raspberry Pi neu (`reboot`) +- `STRG` + `ALT` + `F1` -> wechselt zum Webbrowser (Standardansicht ohne Login) +- `STRG` + `ALT` + `F2` -> wechselt zum Konfigutaions-Programm des Raspberry pi (Login notwendig, startet `sudo raspi-config`) +- `STRG` + `ALT` + `F3` -> wechselt zur Konsole (Login notwendig, Eingabekonsole für Wartung) + +--- + ## Bekannte Fehler ### kein Ton über HDMI (Raspberry Pi 4) -- stellen Sie sicher das sie das HDMI-Kabel am HDMI-Port 0 des Raspberrys angeschlossen haben (direkt neben dem USB-C-Stromanschluss) -- prüfen Sie ob der Monitor / Fernseher über den angeschlossenen HDMI-Port auch wirklich einen Ton ausgegeben kann -- prüfen Sie mittels `sudo raspi-config` ob HDMI als Audio-Ausgabequelle eingestellt wurde +- stelle sicher, dass das HDMI-Kabel am HDMI-Port 0 des Raspberrys angeschlossen ist (direkt neben dem USB-C-Stromanschluss) +- prüfe ob der Monitor / Fernseher über den angeschlossenen HDMI-Port auch wirklich einen Ton ausgegeben kann +- wechsel mit der [Tastenkombination](#tastenkombinationen) `STRG` + `ALT` + `F3` (Login notwendig) in die Wartungskonsole und prüfe mit dem Befehl `speaker-test` ob ein Test-Ton ausgegeben wird + +#### Lösungsvariante 1 - Audio-Quelle bei HDMI-Fernseher festlegen +- wechsel mit der [Tastenkombination](#tastenkombinationen) `STRG` + `ALT` + `F2` (Login notwendig) in die Konfigurationsoberfläche des Raspberrys und prüfe ob HDMI-0 als Audio-Ausgabequelle eingestellt wurde +- verlasse die Konfigurationsoberfläche und starte den Raspberry neu (`sudo reboot`) + +#### Lösungsvariante 2 - Audio-Quelle bei PC-Monitor mit integrierten Lautsprechern +- wechsel mit der [Tastenkombination](#tastenkombinationen) `STRG` + `ALT` + `F3` (Login notwendig) in die Wartungskonsole +- führe den Befehl `sudo nano /boot/config.txt` aus umd die Konfigurationsdatei des Raspberrys zu bearbeiten +- aktiviere den Parameter `dtparam=audio=on` indem das `#` davor entfernt wird +- deaktiviere den Parameter `dtoverlay=vc4-kms-v3d` indem ein `#` davor gesetzt wird +- speicher die Datei (`STRG` + `x` und mit `ja` bestätigen) und starte den Raspberry neu (`sudo reboot`) +- öffnen nach dem Neustart erneut die Wartungskonsole (`STRG` + `ALT` + `F3`) und prüfe mit dem Befehl `speaker-test` ob ein Test-Ton ausgegeben wird +- prüfe alternativ noch, welche Audio-Quelle in den Systemeinstellungen gesetzt wurde (siehe [Lösungsvariante 1](#lösungsvariante-1---audio-quelle-bei-hdmi-fernseher-festlegen)) ### ich benötige ein anderes Kennwort -- öffnen Sie die Eingabekonsole am Raspberry Pi -- `sudo raspi-config` -- Navigieren Sie zu `Change User Password` -- geben Sie ein neues Passwort ein und bestätigen Sie es +- wechsel mit der [Tastenkombination](#tastenkombinationen) `STRG` + `ALT` + `F2` (Login notwendig) in die Konfigurationsoberfläche des Raspberrys +- Navigieren zu `Change User Password` +- gebe ein neues Passwort ein und bestätige es - das eingegebene Kennwort gilt für den Benutzer `pi` -### Monitor / Fernseher aus Standby erwecken +### Monitor geht nicht in Standby +- stelle sicher, dass das HDMI-Kabel am HDMI-Port 0 des Raspberrys angeschlossen ist (direkt neben dem USB-C-Stromanschluss) +- prüfe ob in den [Standby-Einstellungen zur Art des Monitors](#standby---art-des-monitors-festlegen) der richtige Monitor-Typ hinterlegt wurde (`m` für PC-Monitor, `t` für TV-Gerät) + - mit den [Tastenkombination](#tastenkombinationen) `STRG` + `I` bzw. `STRG` + `O` kann geprüft werden, ob die Standby-Funktion generell funktioniert +- prüfe ob in den [Standby-Einstellungen zur Wachennummer](#standby---wachennummer) die richtige Wachennummer hinterlegt wurde -- Wenn die Standby-Funktion aktiviert wurde, schaltet sich der angeschlossene Monitor oder Fernseher aus, solange kein Alarm angezeigt wird -- Mit einer Tastutur kann der Monitor durch folgende Tastenkombinationen ein- und ausgeschaltet werden: - - `STRG` + `i` -> schaltet den Monitor ein - - `STRG` + `o` -> schaltet den Monitor aus +### Monitor / Fernseher aus Standby erwecken +- wenn die Standby-Funktion aktiviert wurde, schaltet sich der angeschlossene Monitor oder Fernseher aus, solange kein Alarm angezeigt wird +- mit der beschriebenen [Tastenkombination](#tastenkombinationen) `STRG` + `i` können Sie den Monitor wieder einschalten + +--- ## Sonstiges +### Image-Erstellung +Mit dem Skript `image-setup.sh` kann eigenständig ein aktuelles Image für den Raspberry Pi erstellt werden. Benötigt wird ein PC mit aktuellem Linux (z.B. Ubuntu, oder zweiter Raspberry Pi). + +Das Skript selbst liefert alle notwendigen Informationen. + +Der Linux-PC auf dem das Skript ausgeführt wird (`chmod +x image-setup.sh` und dann `./image-setup.sh`) und der Raspberry Pi welcher konfiguriert werden soll, müssen sich im Netzwerk erreichen können. + +### Fork Dieses Projekt ist ein Fork von [chilipie-kiosk](https://github.com/jareware/chilipie-kiosk). Dort finden sich weitere Informationen und Antworten zu vielen Detailfragen.