Color icon upgrade (tmux-plugins#80)

* Upgrade color and icons to have higher granularity

This is a large overhaul of the colors and icons in the plugin to enable
higher granularity. All efforts have been made to have sane defaults.

Additionally, a new 'status' has been added that is a catch-all
'unknown' in case a battery tool acts up or fails to report something
meaningful.

Added 8 new format strings:
* #{battery_color_bg} - will set the background color of the status bar
  based on the battery charge level and status
* #{battery_color_fg} - will set the foreground color of the status bar
  based on the battery charge level and status
* #{battery_color_charge_bg} - will set the background color of the
  status bar based solely on the battery charge level
* #{battery_color_charge_fg} - will set the foreground color of the
  status bar based solely on the battery charge level
* #{battery_color_status_bg} - will set the background color of the
  status bar based solely on the battery status
* #{battery_color_status_fg} - will set the foreground color of the
  status bar based solely on the battery status
* #{battery_icon_charge} - will display a battery charge icon
* #{battery_icon_status} - will display a battery status icon

Removed 2 format strings:
* #{battery_status_bg}
* #{battery_status_fg}

Added 39 new options:
* @batt_color_charge_primary_tier8 - primary color to show at [95%-100%]
  battery charge
* @batt_color_charge_primary_tier7 - primary color to show at [80%-95%)
  battery charge
* @batt_color_charge_primary_tier6 - primary color to show at [65%-90%)
  battery charge
* @batt_color_charge_primary_tier5 - primary color to show at [50%-65%)
  battery charge
* @batt_color_charge_primary_tier4 - primary color to show at [35%-50%)
  battery charge
* @batt_color_charge_primary_tier3 - primary color to show at [20%-35%)
  battery charge
* @batt_color_charge_primary_tier2 - primary color to show at [5%-20%)
  battery charge
* @batt_color_charge_primary_tier1 - primary color to show at [0%-5%)
  battery charge
* @batt_color_charge_secondary_tier8 - secondary color to show at [95%-
  100%] battery charge
* @batt_color_charge_secondary_tier7 - secondary color to show at [80%-
  95%) battery charge
* @batt_color_charge_secondary_tier6 - secondary color to show at [65%-
  90%) battery charge
* @batt_color_charge_secondary_tier5 - secondary color to show at [50%-
  65%) battery charge
* @batt_color_charge_secondary_tier4 - secondary color to show at [35%-
  50%) battery charge
* @batt_color_charge_secondary_tier3 - secondary color to show at [20%-
  35%) battery charge
* @batt_color_charge_secondary_tier2 - secondary color to show at [5%-
  20%) battery charge
* @batt_color_charge_secondary_tier1 - secondary color to show at [0%-
  5%) battery charge
* @batt_color_status_primary_charged - primary color to show for a
  battery in 'fully-charged' status
* @batt_color_status_primary_charging - primary color to show for a
  battery in 'charging' status
* @batt_color_status_primary_discharging - primary color to show for a
  battery in 'discharging' status
* @batt_color_status_primary_attached - primary color to show for a
  battery in 'attached' status
* @batt_color_status_primary_unknown - primary color to show for a
  battery in an unknown status
* @batt_color_status_secondary_charged - secondary color to show for a
  battery in 'fully-charged' status
* @batt_color_status_secondary_charging - secondary color to show for a
  battery in 'charging' status
* @batt_color_status_secondary_discharging - secondary color to show for
  a battery in 'discharging' status
* @batt_color_status_secondary_attached - secondary color to show for a
  battery in 'attached' status
* @batt_color_status_secondary_unknown - secondary color to show for a
  battery in an unknown status
* @batt_icon_charge_tier8 - icon to show at [95%-100%] battery charge
* @batt_icon_charge_tier7 - icon to show at [80%-95%) battery charge
* @batt_icon_charge_tier6 - icon to show at [65%-90%) battery charge
* @batt_icon_charge_tier5 - icon to show at [50%-65%) battery charge
* @batt_icon_charge_tier4 - icon to show at [35%-50%) battery charge
* @batt_icon_charge_tier3 - icon to show at [20%-35%) battery charge
* @batt_icon_charge_tier2 - icon to show at [5%-20%) battery charge
* @batt_icon_charge_tier1 - icon to show at [0%-5%) battery charge
* @batt_icon_status_charged - icon to show for a battery in 'fully-
  charged' status
* @batt_icon_status_charging - icon to show for a battery in 'charging'
  status
* @batt_icon_status_discharging - icon to show for a battery in
  'discharging' status
* @batt_icon_status_attached - icon to show for a battery in 'attached'
  status
* @batt_icon_status_unknown - icon to show for a battery in an unknown
  status

Removed 12 options:
* @batt_charged_icon
* @batt_charging_icon
* @batt_attached_icon
* @batt_full_charge_icon
* @batt_high_charge_icon
* @batt_medium_charge_icon
* @batt_low_charge_icon
* @batt_color_full_charge
* @batt_color_high_charge
* @batt_color_medium_charge
* @batt_color_low_charge
* @batt_color_charging

Format string notes:
* #{battery_color_bg} and #{battery_color_fg} replace
  #{battery_status_bg} and #{battery_status_fg}, respectively and
  continue to act the same way
* #{battery_color_charge_bg/fg} changes colors based ONLY on the battery
  charge level
* #{battery_color_status_bg/fg} changes colors based ONLY on the battery
  status
* #{battery_icon_charge} displays ONLY an icon for the charge level
* #{battery_icon_status} displays ONLY an icon for the charge status
* #{battery_icon} continues to display both

Option notes:
* @batt_color_..._primary options are what will be displayed in the main
  bg or fg you choose - e.g. if you use #{battery_color_bg}, the primary
  color will be the background
* Likewise, the corresponding @batt_color_..._secondary option will be
  the foreground in the example above

* Fixed #{battery_graph} format string

Previously, the #{battery_graph} format string wouldn't show an actual
graph. This has been fixed. The graph is also 5 characters wide now,
regardless of battery charge level.

* Clarified some language in README.md

* Changed a word because words are hard

Author: rux616

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ### master
+- Fixed `#{battery_graph}` to actually display graph (@rux616)
+- High-granularity icons and colors added. (@rux616)
 - Changed preferred order of utility applications to be `pmset` -> `acpi` -> `upower` -> `termux-battery-status` due to CPU usage issues with `upower` (2019-03-05) (@rux616)
 - Added `#{battery_status_bg}` feature (@RyanFrantz) 
 - Added multibattery output support for `upower` (@futuro)

README.md

@@ -9,112 +9,227 @@ In order to read the battery status, this plugin depends on having one of the fo
 - acpi
 - upower
 - termux-battery-status
+- apm
 
 In a normal situation, one of the above should be installed on your system by default and thus it should not be necessary to specifically install one of them. That being said, the `acpi` utility is currently recommended for use over `upower` where possible due to ongoing CPU usage issues.
 
 ### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
 
 Add plugin to the list of TPM plugins in `.tmux.conf`:
 
-    set -g @plugin 'tmux-plugins/tmux-battery'
+```tmux
+set -g @plugin 'tmux-plugins/tmux-battery'
+```
 
-Hit `prefix + I` to fetch the plugin and source it.
+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
+```shell
+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
+```tmux
+run-shell ~/clone/path/battery.tmux
+```
 
-Reload TMUX environment:
+From the terminal, reload TMUX environment:
 
-    # type this in terminal
-    $ tmux source-file ~/.tmux.conf
+```shell
+tmux source-file ~/.tmux.conf
+```
 
 If format strings are added to `status-right`, they should now be visible.
 
 ## Usage
 
-Add `#{battery_icon}`, `#{battery_percentage}` `#{battery_remain}`, or
-`#{battery_status_bg}` format strings to existing `status-right` tmux option.
-Example:
+Add any of the supported format strings (see below) to the `status-right` tmux option in `.tmux.conf`. Example:
 
-    # in .tmux.conf
-    set -g status-right '#{battery_status_bg} Batt: #{battery_icon} #{battery_percentage} #{battery_remain} | %a %h-%d %H:%M '
+```tmux
+set -g status-right '#{battery_status_bg} Batt: #{battery_icon} #{battery_percentage} #{battery_remain} | %a %h-%d %H:%M '
+```
 
+### Supported Format Strings
+
+ - `#{battery_color_bg}` - will set the background color of the status bar based on the battery charge level and status
+ - `#{battery_color_fg}` - will set the foreground color of the status bar based on the battery charge level and status
+ - `#{battery_color_charge_bg}` - will set the background color of the status bar based solely on the battery charge level
+ - `#{battery_color_charge_fg}` - will set the foreground color of the status bar based solely on the battery charge level
+ - `#{battery_color_status_bg}` - will set the background color of the status bar based solely on the battery status
+ - `#{battery_color_status_fg}` - will set the foreground color of the status bar based solely on the battery status
+ - `#{battery_graph}` - will show battery percentage as a bar graph: ▁▂▄▆█
+ - `#{battery_icon}` - will display a battery status/charge icon
+ - `#{battery_icon_charge}` - will display a battery charge icon
+ - `#{battery_icon_status}` - will display a battery status icon
+ - `#{battery_percentage}` - will show battery percentage
+ - `#{battery_remain}` - will show remaining time of battery charge\*
+
+\* These format strings can be further customized via options as described below.
+
+#### Options
+
+`#{battery_remain}`
+
+ - `@batt_remain_short`: 'true' / 'false' - This will shorten the time remaining (when charging or discharging) to `~H:MM`.
+
+### Defaults
+
+#### Options
+
+ - `@batt_remain_short`: 'false'
+
+#### Icons/Colors
+
+By default, the following colors and icons are used. (The exact colors displayed depends on your terminal / X11 config.)
+
+Please be aware that the 'level of charge' as noted below (e.g. `[80%-95%)`) uses interval notation. If you are unfamiliar with it, <a href="https://en.wikipedia.org/wiki/Bracket_(mathematics)#Intervals">check it out here</a>.
+
+Also, a note about the `@batt_color_...` options: `@batt_color_..._primary` options are what will be displayed in the main `bg` or `fg` format strings you choose - e.g. if you use `#{battery_color_bg}`, the `@batt_color_..._primary` color you choose will be the background. Likewise, the corresponding `@batt_color_..._secondary` color will be the foreground.
+
+Level of Charge Colors:
+
+ - primary tier 8 \[95%-100%] (`@batt_tier8_charge_color_primary`): '#00ff00'
+ - primary tier 7 \[80%-95%) (`@batt_tier7_charge_color_primary`): '#55ff00'
+ - primary tier 6 \[65%-80%) (`@batt_tier6_charge_color_primary`): '#aaff00'
+ - primary tier 5 \[50%-65%) (`@batt_tier5_charge_color_primary`): '#ffff00'
+ - primary tier 4 \[35%-50%) (`@batt_tier4_charge_color_primary`): '#ffc000'
+ - primary tier 3 \[20%-35%) (`@batt_tier3_charge_color_primary`): '#ff8000'
+ - primary tier 2 (5%-20%) (`@batt_tier2_charge_color_primary`): '#ff4000'
+ - primary tier 1 \[0%-5%] (`@batt_tier1_charge_color_primary`): '#ff0000'
+ - secondary tier 8 \[95%-100%] (`@batt_tier8_charge_color_secondary`): 'colour0'
+ - secondary tier 7 \[80%-95%) (`@batt_tier7_charge_color_secondary`): 'colour0'
+ - secondary tier 6 \[65%-80%) (`@batt_tier6_charge_color_secondary`): 'colour0'
+ - secondary tier 5 \[50%-65%) (`@batt_tier5_charge_color_secondary`): 'colour0'
+ - secondary tier 4 \[35%-50%) (`@batt_tier4_charge_color_secondary`): 'colour0'
+ - secondary tier 3 \[20%-35%) (`@batt_tier3_charge_color_secondary`): 'colour0'
+ - secondary tier 2 (5%-20%) (`@batt_tier2_charge_color_secondary`): 'colour0'
+ - secondary tier 1 \[0%-5%] (`@batt_tier1_charge_color_secondary`): 'colour0'
+
+Status Colors:
+
+ - primary charged (`@batt_color_primary_charged`): 'colour33'
+ - primary charging (`@batt_color_primary_charging`): 'colour33'
+ - primary discharging (`@batt_color_primary_discharging`): 'colour14'
+ - primary attached (`@batt_color_primary_attached`): 'colour201'
+ - primary unknown (`@batt_color_primary_unknown`): 'colour7'
+ - secondary charged (`@batt_color_secondary_charged`): 'colour0'
+ - secondary charging (`@batt_color_secondary_charging`): 'colour0'
+ - secondary discharging (`@batt_color_secondary_discharging`): 'colour0'
+ - secondary attached (`@batt_color_secondary_attached`): 'colour0'
+ - secondary unknown (`@batt_color_secondary_unknown`): 'colour0'
+
+Level of Charge Icons:
+
+ - tier 8 \[95%-100%] (`@batt_tier8_charge_icon`): '█'
+ - tier 7 \[80%-95%) (`@batt_tier7_charge_icon`): '▇'
+ - tier 6 \[65%-80%) (`@batt_tier6_charge_icon`): '▆'
+ - tier 5 \[50%-65%) (`@batt_tier5_charge_icon`): '▅'
+ - tier 4 \[35%-50%) (`@batt_tier4_charge_icon`): '▄'
+ - tier 3 \[20%-35%) (`@batt_tier3_charge_icon`): '▃'
+ - tier 2 (5%-20%) (`@batt_tier2_charge_icon`): '▂'
+ - tier 1 \[0%-5%] (`@batt_tier1_charge_icon`): '▁'
+
+Status Icons:
+
+ - charged (`@batt_icon_charged`): '🔌'
+ - charged - OS X (`@batt_icon_charged`): '🔌'
+ - charging (`@batt_icon_charging`): '🔌'
+ - discharging (`@batt_icon_discharging`): '🔋'
+ - attached (`@batt_icon_attached`): '⚠️'
+ - unknown (`@batt_icon_unknown`): '?'
+
+#### Changing the Defaults
+
+All efforts have been made to make sane defaults, but if you wish to change any of them, add the option to `.tmux.conf`. For example:
+
+```tmux
+set -g @batt_icon_charge_tier8 '🌕'
+set -g @batt_icon_charge_tier7 '🌖'
+set -g @batt_icon_charge_tier6 '🌖'
+set -g @batt_icon_charge_tier5 '🌗'
+set -g @batt_icon_charge_tier4 '🌗'
+set -g @batt_icon_charge_tier3 '🌘'
+set -g @batt_icon_charge_tier2 '🌘'
+set -g @batt_icon_charge_tier1 '🌑'
+set -g @batt_icon_status_charged '🔋'
+set -g @batt_icon_status_charging '⚡'
+set -g @batt_icon_status_discharging '👎'
+set -g @batt_color_status_primary_charged '#3daee9'
+set -g @batt_color_status_primary_charging '#3daee9'
+```
+
+Don't forget to reload the tmux environment after you do this by either hitting `<prefix> + I` if tmux battery is installed via the tmux plugin manager, or by typing `tmux source-file ~/.tmux.conf` in the terminal if tmux battery is manually installed.
+
+*Warning*: The battery icon change most likely will not be instant. When you un-plug the 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.
 
 ## Examples
-Battery full (for OS X):<br/>
-![battery full](/screenshots/battery_full.png)
 
-Battery discharging, custom discharge icon:<br/>
-![battery discharging, custom icon](/screenshots/battery_discharging.png)
+These are all examples of the default plugin color and icon schemes paired with the default tmux color scheme using the following `status-right` and `status-right-length` settings in `.tmux.conf`
 
-Battery charging:<br/>
-![battery charging](/screenshots/battery_charging.png)
+```tmux
+set -g status-right 'Colors: #{battery_color_bg}bg#[default] #{battery_color_fg}fg#[default] #{battery_color_charge_bg}charge_bg#[default] #{battery_color_charge_fg}charge_fg#[default] #{battery_color_status_bg}status_bg#[default] #{battery_color_status_fg}status_fg#[default] | Graph: #{battery_graph} | Icon: #{battery_icon} | Charge Icon: #{battery_icon_charge} | Status Icon: #{battery_icon_status} | Percent: #{battery_percentage} | Remain: #{battery_remain}'
+set -g status-right-length '150'
+```
 
-Battery remain:<br/>
-![battery remain](/screenshots/battery_remain.png)
+Battery charging at tier 8 \[95%-100%]:<br>
+![battery-charging-tier8](./screenshots/battery_charging_tier8.png)
 
-Battery fully charged:<br/>
-![battery_status_bg_green](/screenshots/battery_status_bg_green.png)
+Battery charging at tier 7 \[80%-95%):<br>
+![battery-charging-tier7](./screenshots/battery_charging_tier7.png)
 
-Battery between 99% and 51% charged:<br/>
-![battery_status_bg_yellow](/screenshots/battery_status_bg_yellow.png)
+Battery charging at tier 6 \[65%-80%):<br>
+![battery-charging-tier6](./screenshots/battery_charging_tier6.png)
 
-Battery between 50% and 16% charged:<br/>
-![battery_status_bg_orange](/screenshots/battery_status_bg_orange.png)
+Battery charging at tier 5 \[50%-65%):<br>
+![battery-charging-tier5](./screenshots/battery_charging_tier5.png)
 
-Battery between 15% and dead:<br/>
-![battery_status_bg_red](/screenshots/battery_status_bg_red.png)
+Battery charging at tier 4 \[35%-50%):<br>
+![battery-charging-tier4](./screenshots/battery_charging_tier4.png)
 
-This is done by introducing 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
-- `#{battery_remain}` - will show remaining time of battery charge
-- `#{battery_status_bg}` - will set the background color of the status bar based on the battery percentage
-- `#{battery_status_fg}` - will set the foreground color of the status bar based on the battery percentage
-- `#{battery_graph}` - will show battery percentage as a bar graph ▁▂▃▅▇
+Battery charging at tier 3 \[20%-35%):<br>
+![battery-charging-tier3](./screenshots/battery_charging_tier3.png)
 
-## Changing icons
+Battery charging at tier 2 (5%-20%):<br>
+![battery-charging-tier2](./screenshots/battery_charging_tier2.png)
 
-By default, these icons are displayed:
+Battery charging at tier 1 \[0%-5%]:<br>
+![battery-charging-tier1](./screenshots/battery_charging_tier1.png)
 
- - charged: ":battery:" ("❇ " when not on OS X)
- - charging: ":zap:"
- - discharging: Moon icons depending on your battery level
- - attached but not charging: ":warning:"
+Battery discharging at tier 8 \[95%-100%]:<br>
+![battery-discharging-tier8](./screenshots/battery_discharging_tier8.png)
 
-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):
+Battery discharging at tier 7 \[80%-95%):<br>
+![battery-discharging-tier7](./screenshots/battery_discharging_tier7.png)
 
- - set -g @batt_charged_icon ":sunglasses:"
- - set -g @batt_charging_icon ":+1:"
- - set -g @batt_attached_icon ":neutral_face:"
- - set -g @batt_full_charge_icon "🌕 "
- - set -g @batt_high_charge_icon "🌖 "
- - set -g @batt_medium_charge_icon "🌗 "
- - set -g @batt_low_charge_icon "🌘 "
+Battery discharging at tier 6 \[65%-80%):<br>
+![battery-discharging-tier6](./screenshots/battery_discharging_tier6.png)
 
-Don't forget to reload tmux environment (`$ tmux source-file ~/.tmux.conf`)
-after you do this.
+Battery discharging at tier 5 \[50%-65%):<br>
+![battery-discharging-tier5](./screenshots/battery_discharging_tier5.png)
 
-*Warning*: The battery icon change most likely will not be instant. When you un-plug the 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.
+Battery discharging at tier 4 \[35%-50%):<br>
+![battery-discharging-tier4](./screenshots/battery_discharging_tier4.png)
+
+Battery discharging at tier 3 \[20%-35%):<br>
+![battery-discharging-tier3](./screenshots/battery_discharging_tier3.png)
 
-## Shortened remaining output
+Battery discharging at tier 2 (5%-20%):<br>
+![battery-discharging-tier2](./screenshots/battery_discharging_tier2.png)
 
-To shorten the output of `#{battery_remain}`, set the following variable:
+Battery discharging at tier 1 \[0%-5%]:<br>
+![battery-discharging-tier1](./screenshots/battery_discharging_tier1.png)
 
-    set -g @batt_remain_short true
+Battery in 'attached' status:<br>
+![battery-status-attached](./screenshots/battery_status_attached.png)
 
-This will shorten the time remaining (when charging or discharging) to `~H:MM`.
+Battery in an unknown status:<br>
+![battery-status-unknown](./screenshots/battery_status_unknown.png)
 
 ### Tmux Plugins
 

battery.tmux

@@ -5,20 +5,33 @@ CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 source "$CURRENT_DIR/scripts/helpers.sh"
 
 battery_interpolation=(
+	"\#{battery_color_bg}"
+	"\#{battery_color_fg}"
+	"\#{battery_color_charge_bg}"
+	"\#{battery_color_charge_fg}"
+	"\#{battery_color_status_bg}"
+	"\#{battery_color_status_fg}"
+	"\#{battery_graph}"
+	"\#{battery_icon}"
+	"\#{battery_icon_charge}"
+	"\#{battery_icon_status}"
 	"\#{battery_percentage}"
 	"\#{battery_remain}"
-	"\#{battery_icon}"
-	"\#{battery_status_bg}"
-	"\#{battery_status_fg}"
-	"\#{battery_graph}"
 )
+
 battery_commands=(
+	"#($CURRENT_DIR/scripts/battery_color.sh bg)"
+	"#($CURRENT_DIR/scripts/battery_color.sh fg)"
+	"#($CURRENT_DIR/scripts/battery_color_charge.sh bg)"
+	"#($CURRENT_DIR/scripts/battery_color_charge.sh fg)"
+	"#($CURRENT_DIR/scripts/battery_color_status.sh bg)"
+	"#($CURRENT_DIR/scripts/battery_color_status.sh fg)"
+	"#($CURRENT_DIR/scripts/battery_graph.sh)"
+	"#($CURRENT_DIR/scripts/battery_icon.sh)"
+	"#($CURRENT_DIR/scripts/battery_icon_charge.sh)"
+	"#($CURRENT_DIR/scripts/battery_icon_status.sh)"
 	"#($CURRENT_DIR/scripts/battery_percentage.sh)"
 	"#($CURRENT_DIR/scripts/battery_remain.sh)"
-	"#($CURRENT_DIR/scripts/battery_icon.sh)"
-	"#($CURRENT_DIR/scripts/battery_status_bg.sh)"
-	"#($CURRENT_DIR/scripts/battery_status_fg.sh)"
-	"#($CURRENT_DIR/scripts/battery_graph.sh)"
 )
 
 set_tmux_option() {