pinephone-scripts

Scripts and small applications for the PinePhone
git clone https://src.jayvii.de/pub/pinephone-scripts.git
Log | Files | Refs | README | LICENSE

commit 4c17f9ea380f523d24f46ae50423f8840642c99e
parent b7976b6d7308fa536cc673f550a3c1ae75850fd3
Author: JayVii <jayvii@posteo.de>
Date:   Fri, 22 Jan 2021 16:55:27 +0100

Add Readme

Diffstat:
Asguard/README.md | 48++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 48 insertions(+), 0 deletions(-)

diff --git a/sguard/README.md b/sguard/README.md @@ -0,0 +1,48 @@ +# Suspend Guard for Phosh + +## What does it do? + +Prevent auto-suspend as long as media (audio) is playing, e.g. from your +podcast- or music-player. + +Some players (like `lollypop`) have built-in suspend-inhibit, but not all of +them have yet (e.g. `gnome-podcasts`) and some probably never will +(e.g. `firefox`). + +## How does it work? + +The `sguard.sh` script checks every X seconds (default: 60), whether sound is +playing through any pulse-audio channel. If it is, it will inhibit suspend for +the next X+1 seconds, until it checks again. + +## Are there system requirements? + +Yes, the script uses `pactl`, which is probably installed anyways and +`gnome-session-inhibit` which is part of the GNOME desktop and therefore part of +phosh. + +## Wouldn't it be better to check mpris for the current player state? + +Indeed, that would be a _cleaner_ approach, and the [script did exactly that for +a while](https://src.jayvii.de/Hobby/PinePhoneScripts/src/commit/ea05e205a1315464bb9ebda0ad86493eb844e395/sguard/sguard.sh). +However, it turns out that phosh handles MediaPlayer/mpris events in an odd way, +such that it does not report any playing state, when the screen is locked. + +Additionally, some applications do not support mpris and would therefore be +unable to trigger the suspend-inhibit. + +## Use sguard + +Just download this source directory, and run the Makefile: +``` +git pull https://src.jayvii.de/Hobby/PinePhoneScripts +cd PinePhoneScripts/sguard +make install +``` + +This will place `sguard.sh` into `~/.local/bin/sguard.sh` and place the +systemd-service file under your user's directory. You can enable & start sguard +with: +``` +systemctl --user enable sguard --now +```