2022-03-19 16:25:43 +00:00
|
|
|
waybar-upower(5)
|
|
|
|
|
|
|
|
|
|
# NAME
|
|
|
|
|
|
|
|
|
|
waybar - upower module
|
|
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
|
|
|
|
The *upower* module displays the main battery capacity with all other upower
|
|
|
|
|
compatible devices in the tooltip.
|
|
|
|
|
|
|
|
|
|
# CONFIGURATION
|
|
|
|
|
|
2023-06-13 15:44:29 +00:00
|
|
|
*native-path*: ++
|
2023-07-30 15:33:02 +00:00
|
|
|
typeof: string ++
|
|
|
|
|
default: ++
|
|
|
|
|
The battery to monitor. Refer to the https://upower.freedesktop.org/docs/UpDevice.html#UpDevice--native-path ++
|
|
|
|
|
Can be obtained using `upower --dump`
|
2023-06-13 15:44:29 +00:00
|
|
|
|
2022-03-19 16:25:43 +00:00
|
|
|
*icon-size*: ++
|
|
|
|
|
typeof: integer ++
|
|
|
|
|
default: 20 ++
|
|
|
|
|
Defines the size of the icons.
|
|
|
|
|
|
2022-03-19 20:15:48 +00:00
|
|
|
*format*: ++
|
|
|
|
|
typeof: string ++
|
|
|
|
|
default: {percentage} ++
|
|
|
|
|
The text format.
|
|
|
|
|
|
|
|
|
|
*format-alt*: ++
|
|
|
|
|
typeof: string ++
|
|
|
|
|
default: {percentage} {time} ++
|
|
|
|
|
The text format when toggled.
|
|
|
|
|
|
2022-03-19 16:25:43 +00:00
|
|
|
*hide-if-empty*: ++
|
|
|
|
|
typeof: bool ++
|
|
|
|
|
default: true ++
|
|
|
|
|
Defines visibility of the module if no devices can be found.
|
|
|
|
|
|
|
|
|
|
*tooltip*: ++
|
|
|
|
|
typeof: bool ++
|
2022-11-04 14:03:10 +00:00
|
|
|
default: true ++
|
2022-03-19 16:25:43 +00:00
|
|
|
Option to disable tooltip on hover.
|
|
|
|
|
|
|
|
|
|
*tooltip-spacing*: ++
|
|
|
|
|
typeof: integer ++
|
|
|
|
|
default: 4 ++
|
|
|
|
|
Defines the spacing between the tooltip device name and device battery ++
|
|
|
|
|
status.
|
|
|
|
|
|
2022-03-21 12:50:46 +00:00
|
|
|
*tooltip-padding*: ++
|
|
|
|
|
typeof: integer ++
|
|
|
|
|
default: 4 ++
|
|
|
|
|
Defines the spacing between the tooltip window edge and the tooltip content.
|
|
|
|
|
|
2022-11-18 13:09:38 +00:00
|
|
|
*on-click*: ++
|
|
|
|
|
typeof: string ++
|
|
|
|
|
Command to execute when clicked on the module.
|
|
|
|
|
|
2023-12-04 20:28:37 +00:00
|
|
|
*show-icon*: ++
|
|
|
|
|
typeof: bool ++
|
|
|
|
|
default: true ++
|
|
|
|
|
Option to disable battery icon
|
|
|
|
|
|
2022-03-19 20:15:48 +00:00
|
|
|
# FORMAT REPLACEMENTS
|
|
|
|
|
|
|
|
|
|
*{percentage}*: The battery capacity in percentage
|
|
|
|
|
|
|
|
|
|
*{time}*: An estimated time either until empty or until fully charged ++
|
|
|
|
|
depending on the charging state.
|
|
|
|
|
|
2022-03-19 16:25:43 +00:00
|
|
|
# EXAMPLES
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
"upower": {
|
|
|
|
|
"icon-size": 20,
|
|
|
|
|
"hide-if-empty": true,
|
|
|
|
|
"tooltip": true,
|
|
|
|
|
"tooltip-spacing": 20
|
|
|
|
|
}
|
|
|
|
|
|
2023-06-13 15:44:29 +00:00
|
|
|
```
|
|
|
|
|
```
|
|
|
|
|
"upower": {
|
|
|
|
|
"native-path": "/org/bluez/hci0/dev_D4_AE_41_38_D0_EF",
|
|
|
|
|
"icon-size": 20,
|
|
|
|
|
"hide-if-empty": true,
|
|
|
|
|
"tooltip": true,
|
|
|
|
|
"tooltip-spacing": 20
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
```
|
|
|
|
|
"upower": {
|
|
|
|
|
"native-path": "battery_sony_controller_battery_d0o27o88o32ofcoee",
|
|
|
|
|
"icon-size": 20,
|
|
|
|
|
"hide-if-empty": true,
|
|
|
|
|
"tooltip": true,
|
|
|
|
|
"tooltip-spacing": 20
|
|
|
|
|
}
|
2023-12-04 20:28:37 +00:00
|
|
|
```
|
|
|
|
|
```
|
|
|
|
|
"upower": {
|
|
|
|
|
"show-icon": false,
|
|
|
|
|
"hide-if-empty": true,
|
|
|
|
|
"tooltip": true,
|
|
|
|
|
"tooltip-spacing": 20
|
|
|
|
|
}
|
|
|
|
|
|
2022-03-19 16:25:43 +00:00
|
|
|
```
|
2022-03-19 18:22:00 +00:00
|
|
|
|
|
|
|
|
# STYLE
|
|
|
|
|
|
|
|
|
|
- *#upower*
|
|
|
|
|
- *#upower.charging*
|
|
|
|
|
- *#upower.discharging*
|
2022-03-25 13:57:04 +00:00
|
|
|
- *#upower.full*
|
|
|
|
|
- *#upower.empty*
|
2022-03-19 18:22:00 +00:00
|
|
|
- *#upower.unknown-status*
|
