Skip to content

battery ​

battery returns the first battery's information as a native BatteryInfo?.

Signaturebattery(): BatteryInfo?
tyrus
import { BatteryInfo, battery } from "tyrus:os";

const info: BatteryInfo? = battery();
if (info) {
    print(`${info.level * 100.0}%, charging: ${info.charging}`);
}

BatteryInfo Fields ​

FieldTypeMeaning
levelf32State of charge, from 0.0 to 1.0.
chargingbooleanWhether the battery is currently charging.
timeToFullu32?Seconds until full, absent unless currently charging.
timeToEmptyu32?Seconds until empty, absent unless currently discharging.

Absence is a valid outcome

Desktops and most servers have no battery at all, that is a normal result, not a failure.