tmux/tmux-plugins.tmux-battery
1
0
Fork 0
mirror of https://github.com/tmux-plugins/tmux-battery.git synced 2026-09-10 07:26:19 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
Battery info for tmux.
34 commits 2 branches 7 tags 587 KiB
Shell 100%
Go to file
Jan Ahrens 417d20a213 Determine battery icon by examine all batteries 
Luckily the alphabetical sort order of all states can also be used to
determine to global system state (attached, charging or fully-charged).
2015-02-21 19:23:38 +01:00
screenshots Add screenshots 2014-05-19 15:01:13 +02:00
scripts Determine battery icon by examine all batteries 2015-02-21 19:23:38 +01:00
battery.tmux Change plugin name to tmux-battery 2014-08-31 01:00:10 +02:00
CHANGELOG.md Change the default icon for 'attached' battery state 2015-02-06 00:33:48 +01:00
LICENSE.md Add Readme and License 2014-05-19 14:30:24 +02:00
README.md Change the default icon for 'attached' battery state 2015-02-06 00:33:48 +01:00

README.md

Tmux battery status

Enables displaying battery percentage and status icon in Tmux status-right.

Battery full (for OS X):
battery full

Battery discharging, custom discharge icon:
battery discharging, custom icon

Battery charging:
battery charging

This is done by introducing 2 new format strings that can be added to status-right option:

  • #{battery_icon} - will display a battery status icon
  • #{battery_percentage} - will show battery percentage

Usage

Add #{battery_icon} or #{battery_percentage} format strings to existing status-right Tmux option. Example:

# in .tmux.conf
set -g status-right "Batt: #{battery_icon} #{battery_percentage} | %a %h-%d %H:%M "

Installation with Tmux Plugin Manager (recommended)

Add plugin to the list of TPM plugins in .tmux.conf:

set -g @tpm_plugins "             \
  tmux-plugins/tpm                \
  tmux-plugins/tmux-battery       \
"

Hit prefix + I to fetch the plugin and source it.

If format strings are added to status-right, they should now be visible.

Manual Installation

Clone the repo:

$ git clone https://github.com/tmux-plugins/tmux-battery ~/clone/path

Add this line to the bottom of .tmux.conf:

run-shell ~/clone/path/battery.tmux

Reload TMUX environment:

# type this in terminal
$ tmux source-file ~/.tmux.conf

If format strings are added to status-right, they should now be visible.

Changing icons

By default, these icons are displayed:

  • charged: "🔋" ("❇ " when not on OS X)
  • charging: "⚡"
  • discharging: (nothing shown)
  • attached but not charging: "⚠️"

You can change these defaults by adding the following to .tmux.conf (the following lines are not in the code block so that emojis can be seen):

  • set-option -g @batt_charged_icon "😎"
  • set-option -g @batt_charging_icon "👍"
  • set-option -g @batt_discharging_icon "👎"
  • set-option -g @batt_attached_icon "😐"

Don't forget to reload TMUX environment ($ tmux source-file ~/.tmux.conf) after you do this.

Limitations

  • Battery icon change most likely won't be instant.
    When you un-plug power cord it will take some time (15 - 60 seconds) for the icon to change. This depends on the status-interval TMUX option. Setting it to 15 seconds should be good enough.

Other plugins

You might also find these useful:

  • logging - easy logging and screen capturing
  • online status - online status indicator in Tmux status-right. Useful when on flaky connection to see if you're online.

Contributors

License

MIT