yambar-modules-battery(5)

💖 battery — the module that reads ur battery status 💅

okay so this is yambar-modules-battery(5), bestie — a whole manpage in the File Formats Manual section, and it's literally the one that tells u what ur battery is doing. let's get into it 🫶

---

✨ NAME ✨

battery — this module reads battery status. that's it. that's the vibe check. 🔋

---

🌸 DESCRIPTION 🌸

so this module reads battery status from /sys/class/power_supply and uses udev to monitor for changes. icon behaviour, no cap. ✨

now, real talk: it is common (and like, "normal") for batteries to be in the state unknown under certain conditions. don't panic, it's not u, it's them. 😭

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. like it just refuses to participate?? 💀

this does not happen with all batteries, and other batteries may enter the state unknown under other conditions. so basically, batteries are unhinged and we love them anyway. 🎀

---

🦋 TAGS 🦋

here's everything the module exposes as tags, bestie — every single one, i would never gatekeep:

• name — string — the battery device name 👑
• manufacturer — string — name of the battery manufacturer 🏭
• model — string — the 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 🎀

these are the knobs u can turn. "Req" = is it required? yes or no, no mystery:

• name — string — required: yes — battery device name (one of the names in /sys/class/power_supply) 📁
• poll-interval — int — required: no — how often, in milliseconds, to poll for capacity changes (default=60000). Set it to 0 to disable polling.

⚠️ warning bestie: many batteries do not support asynchronous reporting. so like, turning polling off might leave u in the dark fr fr.

Also it cannot be less than 250ms — that's the floor, periodt. 🚫

• battery-scale — int — required: 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 — required: no — how many seconds to perform smoothing over for battery discharge estimates. Default=100s. 🧚

---

🌈 EXAMPLES 🌈

here's one that ate, honestly:

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

look at that. BAT0, polling every 30000 ms, and a string particle showing BAT: {capacity}% {estimate}. iconic. ✨

---

💜 SEE ALSO 💜

go read these next, i'm obsessed with cross-references:

• yambar-modules(5)
• yambar-particles(5)
• yambar-tags(5)
• yambar-decorations(5)

---

🫶 this has been the yambar-modules-battery(5) page from the File Formats Manual, dated 2024-04-22. go forth and monitor ur battery, bestie — slay 💅💖