---
name: "yambar-modules-battery"
section: "5"
platform: "linux"
package: "yambar"
version: "1.11.0-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/yambar-modules-battery"
---

# yambar-modules-battery(5)

This module reads battery status

## 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.

Note that it is common (and "normal") for batteries to be in the state **unknown** under certain conditions.

For example, some have been seen to enter the **unknown** state when charging and the capacity reaches ~90%. The battery then stays in **unknown**, rather than **charging**, until it has been fully charged and enters the state **full**.

This does not happen with all batteries, and other batteries may enter the state **unknown** under other conditions.

## 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 milliseconds, to poll for capacity changes (default=**60000**). Set to \`0\` to disable polling (**warning**: many batteries do not support asynchronous reporting). Cannot be less than 250ms. |
| battery-scale | int | no | How much to scale down the battery charge amount. Some batteries report too high resulting in bad discharge estimates. Default=1. |
| smoothing-secs | int | no | How many seconds to perform smoothing over for battery discharge estimates. Default=100s. |

## EXAMPLES

```
bar:
  left:
    - battery:
        name: BAT0
        poll-interval: 30000
        content:
          string: {text: "BAT: {capacity}% {estimate}"}
```

## SEE ALSO

[**yambar-modules**(5)](/yambar-modules/5.md), [**yambar-particles**(5)](/yambar-particles/5.md), [**yambar-tags**(5)](/yambar-tags/5.md), [**yambar-decorations**(5)](/yambar-decorations/5.md)