Phystro / batman

Battery AC Technology Monitoring Analysis and Notifications program for Linux and Windows based systems.

Batman

Battery AC Technology Monitoring Analysis and Notifications.

Batman is a convenience utility tool that monitors the battery's energy consumption and usage while displaying notifications alerts to the user in response to changing battery states e.g. charging, discharging, battery absence, low charge capacity e.t.c.

In Linux, on installation, the tool will thereafter always automatically start during the startup of the user's desktop environment after the user has logged in.

The Linux Batman incooporates a small daemon called batmand that collects and analyses various power supply parameters. Batmand runs as root and can also be controlled using systemctl commands.

Currently supported in Linux and Windows based systems.

---

🔧 Installation on Windows Based Systems

---

To be able to successfully run Batman on Windows, a few steps are required. Please follow the guidlines outlined in the README file on building and running batman on Windows.

Consider checking out LiquidSnow framework as it has made this version of batman for Windows susccessful. Thanks.

---

🔧 Installation on Linux Based Systems

How to Build and Install on Linux

Build the project from the sources:

$ make

Install the project:

$ make install

Uninstalling

Uninstalling

$ make uninstall

Uninstall and delete all associated batman program files

$ make purge

Note More details on installation can be found on the Build file.

Requirements: The following packages and libraries are required by batman in Linux based systems.

   `libnotify-dev`, `libao-dev`, `libmpg123-dev`

$ sudo apt install libnotify-dev libao-dev libmpg123-dev

Note: Remember to update the necessary packages and dependancies

$ sudo apt install gcc build-essential

---

📈 How to Use

Getting Power Supply Info:

batman -i
batman --info

Getting Power Supply Stats:

batman -s
batman --stats

---

Note: If batman is running but unable to display notifications for whatever reason, you can initialize it manually with the command below on your terminal

batman --events &

---

💚 Contributing

---

If ANYTHING comes to mind; functionality of the tool, features you would like us to consider, BUGS, etc.. Please just drop it in an issue! Report any bugs encountered

Keep in mind that this tool is quite young, and do be a helpful so-and-so and report any bugs you encounter.

Read the Contributing file on details and guidlines of makeing a contribution to the project. Ensure to adhere to the Code of Conduct. Read the Security file to see the security policy and how to help in case of a vulnerability.

---

📜 License

---

This project is Copyright (c) Anthony Karoki and licensed under the terms of the GPL-3.0 license.