mirror of
https://codeberg.org/dnkl/yambar.git
synced 2025-04-23 04:25:42 +02:00
66 lines
1.2 KiB
Markdown
66 lines
1.2 KiB
Markdown
yambar-modules-battery(5)
|
|
|
|
# NAME
|
|
battery - This module reads battery status
|
|
|
|
# DESCRIPTION
|
|
|
|
This module reads battery status from _/sys/class/power_supply_ and
|
|
uses *udev* to monitor for changes.
|
|
|
|
# TAGS
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Description*
|
|
| name
|
|
: string
|
|
: Battery device name
|
|
| manufacturer
|
|
: string
|
|
: Name of the battery manufacturer
|
|
| model
|
|
: string
|
|
: Battery model name
|
|
| state
|
|
: string
|
|
: One of *full*, *not charging*, *charging*, *discharging* or *unknown*
|
|
| capacity
|
|
: range
|
|
: capacity left, in percent
|
|
| estimate
|
|
: string
|
|
: Estimated time left (to empty while discharging, or to full while
|
|
charging), formatted as HH:MM.
|
|
|
|
# CONFIGURATION
|
|
|
|
[[ *Name*
|
|
:[ *Type*
|
|
:[ *Req*
|
|
:[ *Description*
|
|
| name
|
|
: string
|
|
: yes
|
|
: Battery device name (one of the names in */sys/class/power_supply*)
|
|
| poll-interval
|
|
: int
|
|
: no
|
|
: How often, in seconds, to poll for capacity changes (default=*60*). Set to `0` to disable polling (*warning*: many batteries do not support asynchronous reporting).
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
bar:
|
|
left:
|
|
- battery:
|
|
name: BAT0
|
|
poll-interval: 30
|
|
content:
|
|
string: {text: "BAT: {capacity}% {estimate}"}
|
|
```
|
|
|
|
# SEE ALSO
|
|
|
|
*yambar-modules*(5), *yambar-particles*(5), *yambar-tags*(5), *yambar-decorations*(5)
|
|
|