ensuring ES gracefully finish and save metadata in every system shutdown

cyperghost

@meleu Can you link this posting in your first posting please?
@caver01 This will solve the software shutdown issue with the mausberry, without modifications on meleu's script and editing /opt/retropie/supplementary/emulationstation/emulationstation.sh and reboots can also be performed now ;) This is a generic solution and works in every state!

How to perform a software shutdown with the Mausberry and the diode/transistor hack?

NOTE: This does only work on momentary switches!

1. Prerequisites
You need to solder a diode (1N400x type 1N4001 or 1N4002) or a transistor (NPN-Type, 2N3904, BC547 or BC337) to the Mausberry on/off switch.
For the diode: Connect it between a GPIO and the mausberry button ground.
The transistors needs to soldered between ground and positive to the switch and the base line is connected to the GPIO (maybe you need a resistor to control current flow)

Therefore I strongly recommand the DIODE hack!

Don't be afraid the Raspberry is in both ways protected against current backdraws! Use the diode or the right direction as shown in the box above....

  GPIO                               MAUSBERRY
from Pie          DIODE            switch ground
   O---------------->|----------------O
                  1N4002

More to read here

2. Software part

Create gpio-shutoff with sudo nano /lib/systemd/system-shutdown/gpio-shutoff
Enter code from box below
Make the script executable with sudo chmod +x /lib/systemd/system-shutdown/gpio-shutoff

GPIO16 (or PIN 36 ) is just an example here and is my real setup

#!/bin/sh
# Perform Software Shutdown with Mausberry switch
# cyperghost for retropie.org.uk

# This is the GPIO pinconnected to the diode or transistor
GPIOpinDIODE=16

if [ "$1" = "poweroff" ]; then

    echo $GPIOpinDIODE > /sys/class/gpio/export
    echo out > /sys/class/gpio/gpio$GPIOpinDIODE/direction
    echo 1 > /sys/class/gpio/gpio$GPIOpinDIODE/value
    sleep 0.5
    echo 0 > /sys/class/gpio/gpio$GPIOpinDIODE/value
    sleep 0.5

fi

3. Why are you doing this?
The Mausberry gots a little design issue. If you performing a software shutdown (maybe via ES > Shutdown system or via SSH sudo poweroff) the PI will shut down but the Mausberry will stay active (LED is on). Furthermore it won't respond to a power button press anymore - it's stuck! So you have to switch it off completly by removing your wall plug or by resetting the Mausberry.

The diode or transistor just simulates a button press and the Mausberry will properly shutdown ;)

caver01

@cyperghost This looks like a solution that would survive RetroPie updates and is very similar to how I am triggering the transistor on my system. Question, do you know if these gets called during a reboot too, or just during a shutdown/poweroff?

Also, now that I have a Nespi case, I will be using its built-in switch for power (hardware modded of course). The Mausberry circuit can apparently be used with either a true ON/OFF switch, or with a momentary switch. Up until now, I have used a momentary, and our transistor/mosfet/diode trick has been a requirement to "poke" the circuit during a software shutdown. I wonder how this behavior will change with the Nespi switch? I will have to do some tests to see if a regular on/off switch is immune to the stuck power issue.

I will be using my reset switch to trigger exiting like @lostless.

cyperghost

@caver01 said in ensuring ES gracefully finish and save metadata in every system shutdown:

I wonder how this behavior will change with the Nespi switch?

Sorry, the NESPi Power Switch is a non momentary switch - I removed this with a momentary in my build. If you have a latching (= non momentary) switch then a software shutdown does not work in general!

these gets called during a reboot too, or just during a shutdown/poweroff?

if [ "$1" = "poweroff" ]; then

The GPIO action is called only on shutdown caused by the if clause in the bash script
The systemd process triggers all scripts stored in the folders /lib/systemd.../ and calls the current shutdown level via command call and furthermore systemd waits that all scripts get regular closed. So if you reboot the command call $1 would be reboot, a shutdown is called poweroff

So you can extend the script by a reboot case and let a LED blink for example.

As I already mentioned .... This is a general solution

caver01

@cyperghost That's fantastic! So, you found the definitive answer to the shutdown vs. reboot problem. Way to go!

cyperghost

@caver01 Yes, that's the solution for this problem so far. But don't thank me (directly), it were the people from PIMORONI and theirclean SHIM shutdown daemon here that give me hints how this work. The solution is nested into the setup script ;)

meleu

@cyperghost said in ensuring ES gracefully finish and save metadata in every system shutdown:

Can you link this posting in your first posting please?

Done!

Thanks for sharing. ;)

Semper 5

this script had been working great until about 2 days ago. I noticed it stopped saving my favorites.

i add a game to favorites, power down, then on, and no changes to my list.

I completely wiped the whole card and I'm back to the same nonsense:

metadata save results:
MENU shutdown - will save
MENU reboot system - will save
MENU restart ES - will save

soft shutdown button on NESpi - will NOT save

could somebody help, or explain please?

G30FF

I just modded my NESPi case with the safe shutdown hack by Yahmez (https://retropie.org.uk/forum/topic/12424/retroflag-nespi-case-soft-power-reset-hack). I used the version of his script that turns the Reset button into a "quit emulator" button. I also set up this script exactly as described in the OP, same paths, same files, everything. But ES metadata is not being saved on shutdown or reboot.

The killes script is working fine. If I run killes directly, everything behaves as it should. The problem is something to do with the killes.service systemd unit. Systemctl status reports that the service is loaded, and the Active status is "active (exited)". The killes.service file is exactly as it appears in the OP, and is in the same location. I don't think it has anything to do with the NESPi script mentioned above, as it doesn't save the metadata if I call "sudo shutdown now" from SSH or the terminal either. Any help would be greatly appreciated.

meleu

@semper-5 @G30FF hey guys. I'll try to take a look at it soon. Thanks for the reports.

cyperghost

@meleu Is the line touch /tmp/es-shutdown && chown pi:pi /tmp/es-shutdown still relevant?

meleu

@cyperghost forgive my memory, but where are we using that line?

cyperghost

@meleu https://retropie.org.uk/forum/topic/11750/mausberry-shutdown-script-doesn-t-save-metadata

It was the base code developed in this thread.
But I really don't know if you need this in your script.

It is a fact that if you kill the binary the emulationstation.sh is still active and it waits for a file es-shutdown, es-sysrestart.... whatever ... to do action and to finish ES properly. But I really don't know if it's needed here and if it's the culprit.
I don't think so... I really doubt it.

Maybe the two guys are using an older version of the killes script?
And then updated the runcommand.sh?

Semper 5

@cyperghost I would like to add that, like G30FF mentioned, this is exactly where I got the script from and how I went about putting it into my system with the NESpi. Maybe that's a clue to what you were mentioning we might be running the same old script? Anyways just a thought.

stoo

Does ES only save metadata on shutdown?

Wouldn't it make sense to just flush metadata to storage every X minutes if there are changes? At least then you only lose very recent changes if ES goes down "unclean".

Fitz2380

I too am having the issue of saving Metadata. In particular the favorites and last game played. I have defined a 'system' called Power which appears on my ribbon menu and when I select it, I can do a restart or powerdown. They perform either a shutdown or a shutdown -r command. I implemented the service as defined above and can see that the killes service get started, but neither of my shutdown commands results in the meta data being saved.

Yahmez

For what it's worth, I just made a fresh retropie install for another modded nespi. Installed the scripts for safe shutdown exactly as outlined in the PDF and then installed @meleu killes script as explained in the OP. Everything works fine, metadata is saving.

meleu

@yahmez phew!
phew

Yahmez

@meleu God, I miss that guy.

dankcushions

@stoo said in ensuring ES gracefully finish and save metadata in every system shutdown:

Does ES only save metadata on shutdown?

Wouldn't it make sense to just flush metadata to storage every X minutes if there are changes? At least then you only lose very recent changes if ES goes down "unclean".

most stuff in retropie only saves on exit - game saves will only save to disk on exit of a game. retroarch settings only save on exit of retroarch, etc.

when you're dealing with SD card storage, you generally don't want to do multiple writes; it will kill your card quicker, especially with something as intense as an ES xml write.

stet

I just wanted to put in my thanks for putting this together. I use a RemotePi board to power down my RetroPie setup and this solved the problem of ES not saving the favorites list. :)