This repository has been archived on 2025-03-19. You can view files and clone it, but cannot push or open issues or pull requests.
batalert/README.md
2021-02-12 10:12:51 +01:00

1.5 KiB

batalert

Send D-Bus notifications when the (Linux) host's battery runs low.

License

Prerequisites

  • Install libnotify
  • Install a Notification Server to render desktop notifications
    • Use mako on Wayland/Sway setups

Usage

You can run batalert with default setting to send the first notification when the battery falls below 15% and repeat the notification every 3%. Notifications timeout after 15 seconds. batalert resets when you plug-in your charger.

Customization

  • Check the help text:
    batalert -h
    
  • Show a notification when the battery falls below 20%, repeat notification every 4% on 16%, 12%, 8% ... :
    batalert --alert 20 --notification-step 4
    
  • Timeout notifications after a minute:
    batalert --timeout 60
    
  • Use a custom icon:
    batalert --icon /usr/share/icons/<your-icon>.png
    
  • Monitor a particular battery, e.g., BAT2:
    batalert --uevent /sys/class/power_supply/BAT2/uevent
    
  • Monitor multiple batteries (repeat the --uevent option):
    batalert --uevent /sys/class/power_supply/BAT0/uevent --uevent /path/to/bat1 -u /path/to/bat2
    

Building

Build the app via Cargo:

cargo build --release