Skip to main content

A Python script that sends notifications about the battery's status.

Project description

batnotifsd — Battery notifications daemon

What

This is a Python script that sends notifications about the battery's status (charger plugged in/unplugged, low/critical battery levels).

It's useful for window managers where you don't get this functionality out of the box like in a desktop environment.

Why

I wrote this because I simply could not find anything else that did the job 100% right. The internet is full of shell scripts that just tap into /sys/class/power_supply and take info from that in a while true loop with a sleep, most don't even autodetect the laptop's battery and they make you set a variable for the right battery for you, or, even worse, manually edit the shell script to put it in.

How

This Python script uses the pydbus library to get information directly from UPower through DBus, and then send it back through DBus using the org.freedesktop.Notifications bus, all in a GLib loop.

Also, it automatically detects the first battery that classifies as a laptop battery[^1].

Usage

To start the daemon, simply use:

$ batnotifsd

You probably want to add it to the autostart of your window manager, check with your WM's documentation for that.

Packages

NixOS

A derivation for this package is available inside my Nix package collection. Just follow my-nixpkgs/Usage to add the flake to your config and to add the program to your environment.systemPackages.

Right now I'm the only person actually using this program, so it's only available in the repo with my personal Nix derivations. If there's going to be any interest in it, I'll upstream a derivation into Nixpkgs.

Feel free to just take out the derivation from the pkgs/ folder and stick it in your configuration, if you know what you're doing.

PyPi

This script is available in PyPi here. To install it using pip, run:

$ pip install batnotifsd

About the flake

The Nix flake present in this repo is just the development shell I use to test this script.

More info

[^1]: If the value is set to "Battery", you will need to verify that the property power-supply has the value "true" before considering it as a laptop battery. Otherwise it will likely be the battery for a device of an unknown type.org.freedesktop.UPower.device specification in the UPower Manual

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

batnotifsd-1.0.2.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

batnotifsd-1.0.2-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file batnotifsd-1.0.2.tar.gz.

File metadata

  • Download URL: batnotifsd-1.0.2.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for batnotifsd-1.0.2.tar.gz
Algorithm Hash digest
SHA256 51f60d8683c184f45547e2b27bf4be5c380a14d747934f8d5371d9a7ec34a099
MD5 77f47b397a5482cb837bf11d687eb435
BLAKE2b-256 55b76b65c0e6e9fa04262cbb648e983bae43ce9043c93263c63db2ca40829d43

See more details on using hashes here.

File details

Details for the file batnotifsd-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: batnotifsd-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for batnotifsd-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0be2a4ef15549452b260539fa461ae380990747c1353b8bbb4c5ae1b08faa40e
MD5 9dc5e5821bfaa66bbc7b37923cec0afd
BLAKE2b-256 9dfdfb3f82e010cda40dd57a3bbb6c06221471abd6fd1cde5a31dece5ca503bc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page