A utility tool, notifies user about charging, discharging and not charging state of the battery on Linux.
Python Makefile Shell
Clone or download
Latest commit bec230f Jun 19, 2018

README.md

Battery Monitor

Battery Monitor is a utility tool developed on Python3 and PyGtk3. It will notify the user about charging, discharging, not charging and critically low battery state of the battery on Linux (surely if the battery is present).

Dependencies

  • acpi
  • python3
  • python3-gi
  • libnotify4
  • libappindicator3-1
  • gir1.2-appindicator3-0.1

To use Battery Monitor you need these dependencies installed on your PC.

Installation

Common Method

wget https://github.com/maateen/battery-monitor/archive/master.zip
unzip master.zip
cd battery-monitor-master
sudo make install

That's all. Battery Monitor (Stable) is installed on your system.

For Ubuntu and its derivatives

Let's install from PPA (currently supported: 14.04, 16.04, 17.10 & 18.04):

sudo add-apt-repository ppa:maateen/battery-monitor -y
sudo apt-get update
sudo apt-get install battery-monitor -y

That's all. Battery Monitor (Stable) is installed on your system.

For Arch Linux and its derivatives

Both the stable version and the beta version are available in the Arch User Repository:

Stable: battery-monitor Beta: battery-monitor-devel-git

If you're not sure how to use the AUR, please see the Manjaro and Arch wiki entries about it. You will need an AUR helper to install packages.

For Beta Testers

wget https://github.com/maateen/battery-monitor/archive/devel.zip
unzip devel.zip
cd battery-monitor-devel
sudo make install

That's all. Battery Monitor (Beta) is installed on your system.

For Developers

Now you can automatically test Battery Monitor from Terminal:

python3 run.py --test

Or, if you've already installed:

battery-monitor --test

User Manual

Auto Start

Every time Battery Monitor starts automatically after PC boots up. It pops up notifications and you see its Icon in the system tray. To reveal the other beauties, you can click on the icon. Currently, there are three menus: Settings, About and Quit.

You can also start battery monitor from the menu entries. Please, search for Battery Monitor launcher in the menu entries and simply click on it. In case, if Battery Monitor doesn't start automatically, please open an issue. We would like to debug the issue and help you.

Settings

In Settings menu, you can configure and adjust settings for Battery Monitor.

Configuration

Here, you can set the battery percentage levels at which you want to get notifications. The warning levels are listed in ascending order. Critical Battery Warning refers to the lowest level while First Custom Warning refers to the highest level. Custom warning levels are optional.

If you change any configuration, it will be in action only after next reboot.

Battery Monitor GUI

Issue Tracking

If you find a bug, please open a new issue with details: https://github.com/maateen/battery-monitor/issues

Screenshots

Initial State

Initial State

Charging State

Charging State

Discharging State

Discharging State

Not Charging State

Not Charging State

Critically Low Battery State

Critically Low Battery State

Roadmap

Please take a look at our milestones to get a clear idea about our roadmap. They are dynamic and they can change frequently on user requests.

Changelog

v0.6

v0.5.4

v0.5.3

  • Fixed issue #45
  • Support for Ubuntu 17.10 has been added.

v0.5.2

v0.5.1

v0.5

  • Developed a GUI to manage the custom warning easily.
  • Minimized CPU consumption.
  • Added Makefile for easy installation and up-gradation.
  • Re-structured the project.
  • Support for Ubuntu 14.04, 16.04, 16.10 and 17.04 has been added.

v0.4

  • Reformatted the code in a new style.
  • Optimized the code in a way so that Battery Monitor consumes a little resource of your PC.

v0.3

  • Fixed issue #7, decreased CPU consuming from 40% to below 0.7%
  • Fixed issue #4, Added warning at 30% battery life (temporary solution, will be replaced by a GUI in near future).
  • Fixed issue #6, Added an entry in dash.

v0.2.1

  • Added trusty support.

v0.2

  • Added Critically Low Battery warning when the battery is below 10%.
  • Added ctrl+C pressing support to stop the battery-monitor command on terminal.

v0.1

  • Initial release.

Contributors

Safwan Rahman

He has reformatted the code in a new style. The style represents the code easier to understand. Also, he has optimized the code in a way that Battery Monitor consumes a little resource of your PC. Please take a minute to thank him.

Abdelhak Bougouffa

He has fixed some bugs and optimized Battery Monitor in a way so that it consumes lower CPU and RAM than before. Please take a minute to thank him.

Yochanan Marqos

He is our official package maintainer in AUR. He has put Arch users' life at ease. Please take a minute to thank him.