Batt

Read the battery status from your laptop. Designed to be used in tmux's status line.

Currently only supports OSX.

Dude I was just realizing I basically cannot live without batt now... it is dope -- Rich Soni

Installation

Add this line to your application's Gemfile:

gem 'batt'

And then execute:

$ bundle

Or install it yourself as:

$ gem install batt

Usage

There is a full API that I'm working on, but it's not complete. Gem docs will come at the time that the code is implemented.

You can use the commandline program, in OSX only for now:

batt <action>

Where action is one of the following:

all -- prints out all status of the battery
status -- 'charging' or 'discharging'
source -- 'AC Power' or 'Battery Power'
remaining -- amount of time remaining til complete discharge or complete charge
capacity -- a percentage of how charged the battery is

tmux

Tmux support is a work in progress and is one of the primary use-cases for the design of this gem. Currently, only the capacity action has tmux support, which can be enabled via passing --tmux to it:

batt capacity --tmux

Future releases will have additional support for tmux. I just need to work out what it's gonna look like.

Example tmux.conf

Example tmux status line configuration. Add this to your .tmux.conf:

set-option status-right-length 120
set-option status-right "[ #(batt source) #(batt capacity --tmux) ] #(date \"+%Y-%m-%d %H:%M\")"

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request