battinfo
cli tool & library to query battery info for GNU/Linux
Summary
| Latest Version | 0.2.1 |
|---|---|
| License | GPL-3.0-only |
| CI Status | Failing |
| Stars | 0 |
| Forks | 0 |
| Open Issues | 0 |
| Last Commit | 2024-05-02 |
| Downloads | 0 |
| Last Indexed | 2026-07-21 05:26 |
Tags
Authors
- Prasanna Venkadesh
Installation
nimble install battinfo
choosenim install battinfo
git clone https://github.com/PrasannaVenkadesh/battinfo
OS Compatibility
| Platform | Linux | macOS | Windows | FreeBSD | OpenBSD | NetBSD | Android | iOS | WASM | Embedded |
|---|---|---|---|---|---|---|---|---|---|---|
| battinfo | ✓ | ✓ | ✓ | - | - | - | - | - | - | - |
Dependencies
| Package | Version | Optional |
|---|---|---|
| nim >= | 1.6.12 | No |
Source
| Repository | https://github.com/PrasannaVenkadesh/battinfo |
|---|---|
| Homepage | https://gitlab.com/prashere/battinfo |
| Registry Source | github |
README
battinfo
Introduction
A simple command line utility and a nim library to discover batteries in your GNU/Linux machine and print it's information in the console.
Get Started
Install using nimble package manager
shell
$ nimble install battinfo
Note: One can also install without nimble directly by downloading either the 64-bit executable binary or .deb package for Debian/Ubuntu based distros from the releases
Using as cli tool
shell
# discovers batteries and displays their info
$ battinfo
Using battinfo as library in your Nim program
import battinfopkg/battery
var batteries: seq = get_batteries() # returns a sequence of battery files found in the system.
echo batteries
if batteries.len > 0:
# following procedures accept battery file path as argument
echo get_status(batteries[0]) # returns charging/discharging status as string
echo get_manufacturer(batteries[0]) # returns the name of the manufacturer as string
echo get_model(batteries[0]) # returns the battery model as string
echo get_tech(batteries[0]) # returns the type of battery as string
echo get_serial(batteries[0]) # returns serial info of the battery as string
echo get_percentage(batteries[0]) # returns battery percentage left as int
echo get_current_charge(batteries[0]) # returns the current charge as float
echo get_total_capacity(batteries[0]) # returns the total capacity of the battery as float
License
This software is offered as a Free Software under the terms of GNU General Public License version 3.
