Added generic save shutdown method for RetroPie

README.md

@@ -1,25 +1,110 @@
 # retroflag-picase
-RetroFlag Pi-Case Safe Shutdown
+
+**Section 1**\
+Installers for NesPi+, MegaPi, SuperPi cases and (since 2020/08/22) **NESPI4**
+Support for RetroPie, RecalBox and BATOCERA
+
+**Section 2**\
+Installer for the GPi case\
+Support for RetroPie and BATOCERA
+
+**Section 3**\
+Uninstall for all systems and all cases\
+This means uninstaller for NesPi+, MegaPi, SuperPi and GPi cases\
+for RetroPie, RecalBox and BATOCERA
+
+## Section 1. RetroFlag Pi-Case+ Safe Shutdown
+
+#### Turn switch "SAFE SHUTDOWN" on PCB to ON position.
+
+![Safe Shutdown Switch](http://retroflag.com/images/nespi_case+/safe_shutdown.jpg "Safe Shutdown Switch")
+
+#### **Multi Switch Shutdown**
+with advanced shutdown features for more natural behaviour:
+* If you press restart if emulator is currently running, then you will be kicked back to ES main menu
+* If you press restart in ES main screen, ES will be restartet (no reboot!), good for quick saving metadata or internal saves.
+* If you press power-off then Raspberry will shutdown
+
+All metadata is always saved
 
 Turn switch "SAFE SHUTDOWN" on PCB to ON.
 
 --------------------
 
-Example for RetroPie:
+#### Example for **RetroPie:**
 1. Make sure internet connected.
 2. Make sure keyboard connected.
 3. Press F4 enter terminal.
-4. In the terminal, type the one-line command below(Case sensitive):
+4. In the terminal, type the one-line command below (case sensitive):
 
-wget -O - "https://raw.githubusercontent.com/RetroFlag/retroflag-picase/master/install.sh" | sudo bash
+**`wget -O - "https://raw.githubusercontent.com/crcerror/retroflag-picase/master/install.sh" | sudo bash`**
 
 --------------------
 
-Example for RecalBox:
+#### Example for **RecalBox** and **Batocera:**
 1. Make sure internet connected.
 2. Make sure keyboard connected.
 3. Press F4 first. And then press ALT-F2 enter termial.
-4. User:root Password:recalboxroot
-5. In the terminal, type the one-line command below(Case sensitive):
+4. User: root Password: recalboxroot
+5. In the terminal, type the one-line command below (case sensitive):
+
+For Recalbox:\
+**`wget -O - "https://raw.githubusercontent.com/crcerror/retroflag-picase/master/install_recalbox.sh" | bash`**
+
+For Batocera:\
+**`wget -O - "https://raw.githubusercontent.com/crcerror/retroflag-picase/master/install_batocera.sh" | bash`**
+
+You can edit the python script and add some parameters to the script calls:
+```
+                  --restart will RESTART EmulationStation only
+                  --kodi will startup KODI Media Center
+                  --emukill to exit any running EMULATORS
+                  --espid to check if EmulationStation is currently active
+                  --emupid to check if an Emulator is running"
+
+```
+
+## Section 2. RetroFlag GPi-Case Safe Shutdown
+
+#### Turn switch "SAFE SHUTDOWN" on PCB to ON position.
+
+![](http://retroflag.com/images/gpi-case/safe_shutdown.png)
+
+#### **Multi Switch Shutdown**
+with advanced shutdown features for more natural behaviour:
+1. If you press power-off then Raspberry will shutdown and always save metadata even if you are in an ingame session
+
+All metadata is always saved
+
+
+--------------------
+
+#### Example for **RetroPie:**
+1. Make sure internet connected.
+2. Make sure keyboard connected.
+3. Press F4 enter terminal.
+4. In the terminal, type the one-line command below (case sensitive):
+
+**`wget -O - "https://raw.githubusercontent.com/crcerror/retroflag-picase/master/install_gpi.sh" | sudo bash`**
+
+--------------------
+
+#### Example for **Batocera**
+1. Make sure internet connected.
+2. Make sure keyboard or SSH connected.
+3. User: root Password: linux
+4. In the terminal, type the one-line command below (case sensitive):
+
+**`wget -O - "https://raw.githubusercontent.com/crcerror/retroflag-picase/master/install_gpi_batocera.sh" | bash`**
+
+## Section 3. Uninstallers
+
+#### Example for RetroPie
+Type in the terminal, type the one-line command below (case sensitive):
+
+**`wget -O - "https://raw.githubusercontent.com/crcerror/retroflag-picase/master/uninstall_all.sh" | sudo bash`**
+
+#### Example for RecalBox and BATOCERA
+Type in the terminal, type the one-line command below (case sensitive):
 
-wget -O - "https://raw.githubusercontent.com/RetroFlag/retroflag-picase/master/recalbox_install.sh" | bash
+**`wget -O - "https://raw.githubusercontent.com/crcerror/retroflag-picase/master/uninstall_all.sh" | bash`**

SafeShutdown.py

@@ -2,6 +2,7 @@
 from gpiozero import Button, LED
 import os 
 from signal import pause
+import subprocess
 
 powerPin = 3 
 resetPin = 2 
@@ -16,12 +17,25 @@
 #functions that handle button events
 def when_pressed():
  led.blink(.2,.2)
- os.system("sudo shutdown -h now")
+ output = int(subprocess.check_output(['/opt/RetroFlag/multi_switch.sh', '--es-pid']))
+ if output:
+     os.system("/opt/RetroFlag/multi_switch.sh --es-poweroff")
+ else:
+     os.system("sudo shutdown -h now")
+
 def when_released():
  led.on()
+
 def reboot():
- os.system("sudo reboot")
-
+ output = int(subprocess.check_output(['/opt/RetroFlag/multi_switch.sh', '--es-pid']))
+ output_rc = int(subprocess.check_output(['/opt/RetroFlag/multi_switch.sh', '--rc-pid']))
+ if output_rc:
+     os.system("/opt/RetroFlag/multi_switch.sh --closeemu")
+ elif output:
+     os.system("/opt/RetroFlag/multi_switch.sh --es-restart")
+ else:
+     os.system("sudo reboot")
+
 btn = Button(powerPin, hold_time=hold)
 rebootBtn = Button(resetPin)
 rebootBtn.when_pressed = reboot 

gpi/SafeShutdown.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python3
+from gpiozero import Button, LED
+import os 
+from signal import pause
+
+powerPin = 26 
+powerenPin = 27 
+hold = 1
+power = LED(powerenPin)
+power.on()
+
+#functions that handle button events
+def when_pressed():
+  os.system("/opt/RetroFlag/multi_switch.sh --es-poweroff")
+
+btn = Button(powerPin, hold_time=hold)
+btn.when_pressed = when_pressed
+pause()

gpi/batocera_install.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+# Retroflag Advanced Shutdown Mod by crcerror
+# This is exclusivly for BATOCERA
+# Intended to work for BATOCERA versions 5.24
+#
+# Release Power Button to shutdown your GPi case
+
+version=$(grep -o '^[^ ]*' $HOME/data.version)
+
+# Minimum version of BATOCERA is 5.24 because here batocera-es-swissknife is integrated
+# so all versions less then 5.24 will be dropped from further install
+if [[ ${version//[^[:digit:]]/} -lt 524 ]]; then
+    echo "Error!"
+    echo "Your current version of Batocera is '$version'"
+    echo "You need at least 5.24 ...."
+    exit
+fi 
+
+echo "Welcome to the Safe Shutdown installer..."
+echo "Batocera '$version' detected..."
+sleep 2
+
+echo "Activate RETROFLAG_GPI in batocera.conf"
+batocera-settings set system.power.switch RETROFLAG_GPI
+sleep 2
+echo; echo
+
+echo "Add Safe Shutdown feature for running emulator instance"
+if [[ -f /userdata/system/custom.sh ]]; then
+   echo
+   echo "custom.sh is already available ..."
+   echo "I don't change anything here!"
+   echo
+else 
+   cat > /userdata/system/custom.sh <<_EOF_
+#!/bin/bash
+# custom.sh - place to /userdata/system
+# by cyperghost 23/11/19
+#
+
+if [[ \$1 == stop ]]; then
+    batocera-es-swissknife --emukill
+fi
+_EOF_
+
+    chmod +x /userdata/system/custom.sh
+fi
+
+echo "Rebooting in 5 seconds...."
+sleep 5
+shutdown -r now

gpi/install.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+basewebsite="https://raw.githubusercontent.com/crcerror/retroflag-picase"
+sleep 2s
+#Step 1) Check if root--------------------------------------
+if [[ $EUID -ne 0 ]]; then
+   echo "Please execute script as root." 
+   exit 1
+fi
+
+#-----------------------------------------------------------
+
+#Step 3) Update repository----------------------------------
+sudo apt-get update -y
+
+sleep 2s
+#-----------------------------------------------------------
+
+#Step 4) Install gpiozero module----------------------------
+sudo apt-get install -y python3-gpiozero
+
+sleep 2s
+#-----------------------------------------------------------
+
+#Step 5) Download Python script-----------------------------
+cd /opt/
+mkdir RetroFlag
+cd RetroFlag
+script=SafeShutdown.py
+wget --no-check-certificate "$basewebsite/master/gpi/SafeShutdown.py"
+chmod +x SafeShutdown.py
+wget --no-check-certificate "$basewebsite/master/multi_switch.sh"
+chmod +x multi_switch.sh
+
+#-----------------------------------------------------------
+sleep 2s
+#Step 6) Enable Python script to run on start up------------
+cd /etc/
+RC=rc.local
+
+if grep -q "sudo python3 \/opt\/RetroFlag\/SafeShutdown.py \&" "$RC";
+	then
+		echo "File /etc/rc.local already configured. Doing nothing."
+	else
+		sed -i -e "s/^exit 0/sudo python3 \/opt\/RetroFlag\/SafeShutdown.py \&\n&/g" "$RC"
+		echo "File /etc/rc.local configured."
+fi
+#-----------------------------------------------------------
+
+#Step 7) Reboot to apply changes----------------------------
+echo "RetroFlag Pi Case installation done. Will now reboot after 3 seconds."
+sleep 3s
+sudo reboot
+#-----------------------------------------------------------
+

install.sh

@@ -8,38 +8,45 @@ if [[ $EUID -ne 0 ]]; then
 fi
 #-----------------------------------------------------------
 
-#Step 2) enable UART----------------------------------------
+#Step 2) Update repository----------------------------------
+sudo apt-get update -y
+#-----------------------------------------------------------
+
+#Step 3) disable UART from retroflag install ---------------
 cd /boot/
 File=config.txt
-if grep -q "enable_uart=1" "$File";
+if grep -q "^enable_uart=1" "$File";
 	then
-		echo "UART already enabled. Doing nothing."
+		echo "UART is already enabled. Disabeling now!"
+		echo "Commenting out line - your CPU is not throttled anymore"
+		sed -i -e "s|^enable_uart=1|#enable_uart=1|" "$File" &> /dev/null
 	else
-		echo "enable_uart=1" >> $File
-		echo "UART enabled."
+		echo "UART is disabled. CPU is working with full speed"
 fi
 #-----------------------------------------------------------
 
-#Step 3) Update repository----------------------------------
-sudo apt-get update -y
-#-----------------------------------------------------------
-
 #Step 4) Install gpiozero module----------------------------
 sudo apt-get install -y python3-gpiozero
 #-----------------------------------------------------------
 
 #Step 5) Download Python script-----------------------------
 cd /opt/
-sudo mkdir RetroFlag
+sudo mkdir -p RetroFlag
 cd /opt/RetroFlag
 script=SafeShutdown.py
 
 if [ -e $script ];
 	then
-		echo "Script SafeShutdown.py already exists. Doing nothing."
+		echo "Script SafeShutdown.py already exists. Overwriting file now!"
+		echo "Downloading ..."
 	else
-		wget "https://raw.githubusercontent.com/RetroFlag/retroflag-picase/master/SafeShutdown.py"
+		echo "Script will be installed now! Downloading ..."
 fi
+
+wget -N -q --show-progress "https://raw.githubusercontent.com/crcerror/retroflag-picase/master/SafeShutdown.py"
+wget -N -q --show-progress "https://raw.githubusercontent.com/crcerror/retroflag-picase/master/multi_switch.sh"
+chmod +x multi_switch.sh
+
 #-----------------------------------------------------------
 
 #Step 6) Enable Python script to run on start up------------
@@ -55,17 +62,19 @@ if grep -q "sudo python3 \/opt\/RetroFlag\/SafeShutdown.py \&" "$RC";
 fi
 #-----------------------------------------------------------
 
-#Step 7) Reboot to apply changes----------------------------
+#Step 7) enable overlay file for powercut ---------------
+cd /boot/
+File=config.txt
+if ! grep -q "^dtoverlay=gpio-poweroff,gpiopin=4,active_low=1,input=1" $File; then
+    echo "Enable overlay file"
+    echo "# Overlay setup for proper powercut, needed for Retroflag cases" >> "$File"
+    echo "dtoverlay=gpio-poweroff,gpiopin=4,active_low=1,input=1" >> "$File"
+fi
+
+#-----------------------------------------------------------
+
+#Step 8) Reboot to apply changes----------------------------
 echo "RetroFlag Pi Case installation done. Will now reboot after 3 seconds."
 sleep 3
 sudo reboot
 #-----------------------------------------------------------
-
-
-
-
-
-
-
-
-

install_batocera.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+echo "Downloading install script .... for BATOCERA"
+sleep 2
+wget -q -O - https://raw.githubusercontent.com/crcerror/retroflag-picase/master/other_os/batocera_install.sh | bash

install_gpi.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+echo "Downloading install script ...."
+sleep 2
+wget -q -O - https://raw.githubusercontent.com/crcerror/retroflag-picase/master/gpi/install.sh | bash

install_gpi_batocera.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+echo "Downloading install script .... for BATOCERA"
+sleep 2
+wget -q -O - https://raw.githubusercontent.com/crcerror/retroflag-picase/master/gpi/batocera_install.sh | bash

install_recalbox.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+echo "Downloading install script .... for RECALBOX"
+sleep 2
+wget -q -O - https://raw.githubusercontent.com/crcerror/retroflag-picase/master/other_os/recalbox_install.sh | bash