Module swaystatus::blocks::battery[−][src]

Expand description

Information about the internal power supply

This block can display the current battery state (Full, Charging or Discharging), percentage charged and estimate time until (dis)charged for an internal power supply.

Configuration

Key	Values	Required	Default
`device`	The device in `/sys/class/power_supply/` to read from. When using UPower, this can also be `"DisplayDevice"`.	No	Any battery device
`driver`	One of `"sysfs"` or `"upower"`	No	`"sysfs"`
`interval`	Update interval, in seconds. Only relevant for `driver = "sysfs"`.	No	`10`
`format`	A string to customise the output of this block. See below for available placeholders.	No	`“$percentage\|”`
`full_format`	Same as `format` but for when the battery is full	No	`""`
`allow_missing`	Don’t display errors when the battery cannot be found. Only works with the `sysfs` driver.	No	`false`
`hide_missing`	Completely hide this block if the battery cannot be found.	No	`false`
`hide_full`	Hide the block if battery is full	No	`false`
`info`	Minimum battery level, where state is set to info	No	`60`
`good`	Minimum battery level, where state is set to good	No	`60`
`warning`	Minimum battery level, where state is set to warning	No	`30`
`critical`	Minimum battery level, where state is set to critical	No	`15`
`full_threshold`	Percentage at which the battery is considered full (`full_format` shown)	No	`100`

Placeholder	Value	Type	Unit
`percentage`	Battery level, in percent	String or Integer	Percents
`time`	Time remaining until (dis)charge is complete. Presented only if battery’s status is (dis)charging.	String	-
`power`	Power consumption by the battery or from the power supply when charging	String or Float	Watts

Examples

Hide missing battery:

[block]
block = "battery"
hide_missing = true

Allow missing battery:

[block]
block = "battery"
format = "$percentage|N/A"
allow_missing = true

Icons Used

bat_charging
bat_not_available
“bat_10”,
“bat_20”,
“bat_30”,
“bat_40”,
“bat_50”,
“bat_60”,
“bat_70”,
“bat_80”,
“bat_90”,
“bat_full”,

Modules

zbus_upower

DBus interface proxy for: org.freedesktop.UPower.Device and org.freedesktop.UPower

Structs

BatteryConfig

BatteryInfo

PowerSupplyDevice

Represents a physical power supply device, as known to sysfs. https://www.kernel.org/doc/html/v5.15/power/power_supply_class.html

UPowerDevice

Enums

BatteryDriver

BatteryStatus

Constants

BATTERY_UNAVAILABLE_ICON

Ordered list of icons used to display battery charge

POWER_SUPPLY_DEVICES_PATH

Path for the power supply devices

Traits

BatteryDevice

Functions

run