luastatu...ry-linux(7)

📦
version 0.6.0 · 2 versions
, in nixos 26.05

🌸 NAME 🌸

okay bestie, welcome to luastatus-plugin-battery-linux(7) — the Linux-specific battery plugin for luastatus, straight from the Miscellaneous Information Manual. 💖

✨ OVERVIEW ✨

So this derived plugin is lowkey obsessed with Linux sysfs: it periodically polls Linux sysfs for the state of a battery. 🦋

It is also able to estimate the time remaining to full charge/discharge and the current battery consumption rate. No cap. ✨

🧚 FUNCTIONS 🧚

The following functions are provided:

  • widget(tbl) — Constructs a widget table required by luastatus. tbl is a table with the following fields:

(required)

  • cb: function — the callback that will be called with a table with the following keys:
    • status: string — a string with battery status text, e.g. "Full", "Unknown", "Charging", "Discharging". Not present if the status cannot be read (for example, when the battery is missing).
    • capacity: number — a percentage representing battery capacity. Not present if the capacity cannot be read.
    • rem_time: number — time (in hours) remaining to full charge/discharge. Usually only present on battery charge/discharge.
    • consumption: number — the current battery consumption/charge rate in watts. Usually only present on battery charge/discharge.

(optional)

  • dev: string — device directory name under /sys/class/power_supply; default is "BAT0".
  • period: number — the period in seconds for polling sysfs; default is 2 seconds. Because this plugin utilizes udev under the hood, it is able to respond to battery state changes (such as cable (un-)plugging) immediately, irrespective of the value of the period.
  • use_energy_full_design: boolean — if true, the energy_full_design property (not energy_full) will be used for capacity calculation.
  • event — the event entry of the resulting table (see luastatus documentation for the description of widget.event field).

LGPLv3 — periodt. 💅

that's a wrap on the luastatus-plugin-battery-linux(7) page, bestie — the footer just repeats the manual name on this one, with no separate source/version/date line to report. 🫶✨

📦 where this page comes from