waybar/man/waybar-battery.5.scd

165 lines
4.5 KiB
Plaintext
Raw Permalink Normal View History

2019-08-24 18:44:29 +02:00
waybar-battery(5)
# NAME
waybar - battery module
# DESCRIPTION
The *battery* module displays the current capacity and state (eg. charging) of your battery.
2019-08-24 22:46:56 +02:00
# CONFIGURATION
2020-04-12 18:41:44 +02:00
*bat*: ++
2019-08-24 18:44:29 +02:00
typeof: string ++
The battery to monitor, as in /sys/class/power_supply/ instead of auto detect.
2020-04-12 18:41:44 +02:00
*adapter*: ++
2019-08-24 18:44:29 +02:00
typeof: string ++
The adapter to monitor, as in /sys/class/power_supply/ instead of auto detect.
2020-04-12 18:41:44 +02:00
*full-at*: ++
typeof: integer ++
Define the max percentage of the battery, for when you've set the battery to stop charging at a lower level to save it. For example, if you've set the battery to stop at 80% that will become the new 100%.
*design-capacity*: ++
typeof: bool ++
default: false ++
Option to use the battery design capacity instead of it's current maximal capacity.
2020-04-12 18:41:44 +02:00
*interval*: ++
2019-08-24 18:44:29 +02:00
typeof: integer ++
default: 60 ++
The interval in which the information gets polled.
2020-04-12 18:41:44 +02:00
*states*: ++
2022-11-07 08:30:01 +01:00
typeof: object ++
2019-08-24 18:44:29 +02:00
A number of battery states which get activated on certain capacity levels. See *waybar-states(5)*.
2020-04-12 18:41:44 +02:00
*format*: ++
2019-08-24 18:44:29 +02:00
typeof: string ++
default: {capacity}% ++
The format, how information should be displayed.
2019-08-24 18:44:29 +02:00
2020-04-12 18:41:44 +02:00
*format-time*: ++
2019-09-06 20:53:43 +02:00
typeof: string ++
default: {H} h {M} min ++
The format, how the time should be displayed.
2020-01-04 04:31:24 +01:00
*format-icons*: ++
typeof: array/object ++
2019-08-24 18:44:29 +02:00
Based on the current capacity, the corresponding icon gets selected. ++
The order is *low* to *high*. Or by the state if it is an object.
2020-01-04 04:31:24 +01:00
*max-length*: ++
2019-08-24 18:44:29 +02:00
typeof: integer++
The maximum length in character the module should display.
2021-02-01 17:34:51 +01:00
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
2021-02-01 17:34:51 +01:00
*align*: ++
typeof: float ++
The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.
2021-02-01 17:34:51 +01:00
2020-01-04 04:31:24 +01:00
*rotate*: ++
2019-08-24 18:44:29 +02:00
typeof: integer++
Positive value to rotate the text label.
2020-01-04 04:31:24 +01:00
*on-click*: ++
2019-08-24 18:44:29 +02:00
typeof: string ++
Command to execute when clicked on the module.
2019-12-29 05:19:45 +01:00
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
2020-04-12 18:35:41 +02:00
*on-click-right*: ++
2019-08-24 18:44:29 +02:00
typeof: string ++
Command to execute when you right clicked on the module.
2020-04-12 18:35:41 +02:00
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
2020-01-04 04:31:24 +01:00
*on-scroll-up*: ++
2019-08-24 18:44:29 +02:00
typeof: string ++
Command to execute when scrolling up on the module.
2020-01-04 04:31:24 +01:00
*on-scroll-down*: ++
2019-08-24 18:44:29 +02:00
typeof: string ++
Command to execute when scrolling down on the module.
2020-04-12 18:41:44 +02:00
*smooth-scrolling-threshold*: ++
2019-08-24 18:44:29 +02:00
typeof: double ++
Threshold to be used when scrolling.
2020-04-12 18:41:44 +02:00
*tooltip*: ++
2019-08-24 18:44:29 +02:00
typeof: bool ++
default: true ++
Option to disable tooltip on hover.
2019-08-24 22:46:56 +02:00
# FORMAT REPLACEMENTS
2019-08-24 18:44:29 +02:00
*{capacity}*: Capacity in percentage
*{power}*: Power in watts
2019-08-24 18:44:29 +02:00
*{icon}*: Icon, as defined in *format-icons*.
*{time}*: Estimate of time until full or empty. Note that this is based on the power draw at the last refresh time, not an average.
2019-09-06 20:53:43 +02:00
# TIME FORMAT
The *battery* module allows you to define how time should be formatted via *format-time*.
The three arguments are:
2019-09-06 20:53:43 +02:00
*{H}*: Hours
*{M}*: Minutes
*{m}*: Zero-padded minutes
2019-09-06 20:53:43 +02:00
2019-08-24 22:46:56 +02:00
# CUSTOM FORMATS
2019-08-24 18:44:29 +02:00
2021-11-06 10:00:15 +01:00
The *battery* module allows one to define custom formats based on up to two factors. The best fitting format will be selected.
2019-08-24 18:44:29 +02:00
*format-<state>*: With *states*, a custom format can be set depending on the capacity of your battery.
*format-<status>*: With the status, a custom format can be set depending on the status in /sys/class/power_supply/<bat>/status (in lowercase).
*format-<status>-<state>*: You can also set a custom format depending on both values.
2019-08-24 22:46:56 +02:00
# STATES
2019-08-24 18:44:29 +02:00
- Every entry (*state*) consists of a *<name>* (typeof: *string*) and a *<value>* (typeof: *integer*).
- The state can be addressed as a CSS class in the *style.css*. The name of the CSS class is the *<name>* of the state. Each class gets activated when the current capacity is equal or below the configured *<value>*.
- Also each state can have its own *format*. Those con be configured via *format-<name>*. Or if you want to differentiate a bit more even as *format-<status>-<state>*. For more information see *custom-formats*.
2019-08-24 18:44:29 +02:00
2019-08-26 23:28:24 +02:00
# EXAMPLES
2019-08-24 18:44:29 +02:00
```
"battery": {
"bat": "BAT2",
"interval": 60,
"states": {
"warning": 30,
"critical": 15
},
"format": "{capacity}% {icon}",
"format-icons": ["", "", "", "", ""],
"max-length": 25
2019-08-24 18:44:29 +02:00
}
```
2019-08-24 22:46:56 +02:00
# STYLE
2019-08-24 18:44:29 +02:00
- *#battery*
- *#battery.<status>*
- *<status>* is the value of /sys/class/power_supply/<bat>/status in lowercase.
- *#battery.<state>*
- *<state>* can be defined in the *config*. For more information see *states*.
- *#battery.<status>.<state>*
- Combination of both *<status>* and *<state>*.