From 1670d0788fe797e1dcd9cf821be4f86913d96ce7 Mon Sep 17 00:00:00 2001 From: Squibid Date: Tue, 23 Sep 2025 23:02:46 -0400 Subject: [PATCH] feat: add a readme --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..af4d79e --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Event Handler +My custom event handler for battery related things. Here's a brief rundown of +all the features: + +When the percentage gets below a specified percentage it will blink the +specified led at any rate defined by the config file. + +If the system is plugged in and a wayland session is running then the event +handler will place an idle inhibitor on the session to keep the computer from +going to sleep. The inhibitor is removed when the system is unplugged. + +## Default Config +```toml +[battery] +status_path = "/sys/class/power_supply/BAT1" +power_source = "/sys/class/power_supply/ACAD/online" + +[led] +brightness_path = "/sys/class/leds/input0::capslock/brightness" + +[led.blink] +trigger_level = 15 +timing_formula = "1.7 + 18.5 * exp(-0.29 * p)" # p is the percentage of the battery + +[acpi_daemon] +socket_path = "/run/acpid.socket" +```