🔋 Batmon

Dead-simple, somewhat configurable battery monitor for Linux. Batmon monitors the battery path in real time and adjusts your power profiles accordingly to optimize battery life for e.g. laptops.

Features

• Real-time monitoring of battery status
• Dynamic adjustment of power profiles
• Simple configuration though JSON configuration file
  • Optional command execution on state changes

Installation

Prerequisites

• Upower
• powerprofilesctl
• Nix or Go

Nix

You are strongly encouraged to get Batmon through Nix, using the flake located in this repository. You may install it manually on non-NixOS systems using nix profile install.

nix profile install github:NotAShelf/batmon

Or on NixOS systems using the package exposed for your system.

{inputs, pkgs, ...}: {
  environment.systemPackages = [
    inputs.batmon.packages.${pkgs.stdenv.system}.default
  ];
}

Alternatively, using the NixOS module to install Batmon and configure a systemd service for you.

{inputs, pkgs, ...}: {
  imports = [inputs.batmon.nixosModules.default];
  services.batmon.enable = true;
}

Manually

go install . # this will install Batmon in your $GOPATH

Start Batmon through your terminal, or as a systemd service.

Configuration

By default, Batmon will load the configuration from config.json located in the current directory. You can specify a different configuration file using the --config flag:

batmon -c /path/to/config.json

The configuration file should contain a list of batteries to monitor, along with any custom commands or extra commands to execute. Here's an example of a configuration file:

{
  "batPaths": [
    {
      "path": "/sys/class/power_supply/BAT0",
      "command": "powerprofilesctl set performance",
      "extraCommand": "echo 'Battery is charging' | wall"
    }
  ]
}

• You can leave command empty to use the default behaviour - which will switch active powerprofile using powerprofiles set performance | balanced

• extraCommand, if provided, will be executed in addition to the command value.