commit 4ece040cbf210783eceaa3baab84c32d36be1d40
parent aae2679e7485e558b4271760e11f75176bb3e644
Author: Andrea Feletto <andrea@andreafeletto.com>
Date: Thu, 20 Jan 2022 13:59:25 +0100
add build and usage instructions, add status script
Diffstat:
| M | README.md | | | 30 | ++++++++++++++++++++++++++++-- |
| A | contrib/status | | | 128 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 156 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1,11 +1,37 @@
# levee
-levee is a statusbar for the [river](https://github.com/ifreund/river/) wayland
-compositor, written in [zig](https://ziglang.org/) without any toolkit.
+levee is a statusbar for the [river](https://github.com/riverwm/river/) wayland
+compositor, written in [zig](https://ziglang.org/) without any UI toolkit.
It is still in early development.
+## Build
+
+```
+git clone --recurse-submodules https://git.sr.ht/~andreafeletto/levee
+cd levee
+zig build -Drelease-safe --prefix ~/.local install
+```
+
+## Usage
+
+Levee renders the last line received through `stdin` at the right of the
+statusbar.
+A sample script is provided in the `contrib` folder which prints brightness,
+volume and battery level.
+
+```
+./contrib/status | levee
+```
+
+The script refreshes automatically every 10 seconds, but can be refreshed
+immediately by running:
+
+```
+./contrib/status --refresh
+```
+
## Dependencies
* [zig](https://ziglang.org/) 0.9.0
diff --git a/contrib/status b/contrib/status
@@ -0,0 +1,128 @@
+#!/bin/sh
+
+PrgName=${0##*/}
+
+PrgDir="$HOME/.local/share/$PrgName"
+mkdir -p "$PrgDir"
+PidPath="$PrgDir/$PrgName.pid"
+
+Usage() {
+ while read -r Line; do
+ printf '%b\n' "$Line"
+ done <<-EOF
+ \rUsage: $PrgName OPTION
+ \rStatusbar widgets for levee.
+
+ \rOptions:
+ \r -h, --help, -? display this help and exit
+ \r -r, --refresh refresh
+ \r -s, --stop stop daemon if one exists
+ EOF
+}
+
+Die() {
+ printf 'error: %s\n' "$1" 1>&2
+ exit 1
+}
+
+Battery() {
+ CapacityPath='/sys/class/power_supply/BAT1/capacity'
+ StatusPath='/sys/class/power_supply/BAT1/status'
+ if [ -r "$CapacityPath" ] && [ -r "$StatusPath" ]; then
+ read -r Status <"$StatusPath"
+ case $Status in
+ Discharging)
+ Icon="🔋"
+ ;;
+ Charging)
+ Icon="🔌"
+ ;;
+ Full)
+ Icon="⚡"
+ ;;
+ Unknown)
+ Icon="❓"
+ ;;
+ esac
+ read -r Capacity <"$CapacityPath"
+ printf '%s %4s%%\n' "$Icon" "$Capacity"
+ else
+ Die 'unable to access power supply files'
+ fi
+}
+
+Volume() {
+ if ! command -v pulsemixer >/dev/null; then
+ Die 'missing dependency: pulsemixer'
+ fi
+
+ if [ "$(pulsemixer --get-mute)" -eq 1 ]; then
+ printf ' 🔇 \n'
+ else
+ Value=$(pulsemixer --get-volume)
+ printf '🔊 %4s%%\n' "${Value%% *}"
+ fi
+}
+
+Backlight() {
+ Brightness=$(brightnessctl get)
+ MaxBrightness=$(brightnessctl max)
+ Value=$((100 * Brightness / MaxBrightness))
+ printf '💡 %4d%%\n' "${Value%%.*}"
+}
+
+Refresh() {
+ printf '%s' "$$" >"$PidPath"
+ printf '%s | %s | %s\n' "$(Backlight)" "$(Volume)" "$(Battery)"
+}
+
+GetDaemonPid() {
+ if [ -r "$PidPath" ]; then
+ read -r Pid <"$PidPath"
+ printf '%s' "$Pid"
+ fi
+}
+
+SendRefresh() {
+ Pid=$(GetDaemonPid)
+ if [ -n "$Pid" ]; then
+ kill -USR1 "$Pid"
+ else
+ Die 'no daemon to refresh'
+ fi
+}
+
+StopDaemon() {
+ Pid=$(GetDaemonPid)
+ if [ -n "$Pid" ] && kill -0 "$Pid" ; then
+ kill -15 "$Pid"
+ else
+ Die 'no daemon to kill'
+ fi
+}
+
+if [ $# -gt 1 ]; then
+ Usage
+ exit 1
+fi
+
+case $1 in
+--help | -h | -\?)
+ Usage
+ exit 0 ;;
+--refresh | -r)
+ SendRefresh
+ exit 0 ;;
+--stop | -s)
+ StopDaemon
+ exit 0 ;;
+esac
+
+trap ':' USR1
+trap 'rm $PidPath; exit 0' INT TERM
+
+while true; do
+ Refresh
+ sleep 10 &
+ wait $!
+done
