# hs.battery

Battery/power information All functions here may return nil, if the information requested is not available.

This module is based primarily on code from the previous incarnation of Mjolnir by Steven Degutis.

# Submodules

# API Overview

Functions - API calls offered directly by the extension

  • _report
  • adapterSerialNumber
  • amperage
  • batterySerialNumber
  • batteryType
  • capacity
  • cycles
  • designCapacity
  • getAll
  • health
  • healthCondition
  • isCharged
  • isCharging
  • isFinishingCharge
  • maxCapacity
  • name
  • otherBatteryInfo
  • percentage
  • powerSource
  • powerSourceType
  • privateBluetoothBatteryInfo
  • timeRemaining
  • timeToFullCharge
  • voltage
  • warningLevel
  • watts

# API Documentation

# Functions

# _report

Signature hs.battery._report() -> table
Type Function
Description Returns a table containing all of the details concerning the Mac's powersource(s).
Parameters
  • None
Returns
  • a table containing the raw data about the power source(s) for the Mac.
Notes
  • This function is generally not required and is provided to aid in debugging. This function combines the output of the following internally used functions:
  • hs.battery._adapterDetails()
  • hs.battery._powerSources()
  • hs.battery._appleSmartBattery()
  • hs.battery._iopmBatteryInfo()
  • You can view this report by typing hs.inspect(hs.battery._report()) (or a subset of it by using one of the above listed functions instead) -- it will primarily be of interest when debugging or extending this module and generally not necessary to use.
Examples None
Source extensions/battery/battery.lua line 365

# adapterSerialNumber

Signature hs.battery.adapterSerialNumber() -> integer | string
Type Function
Description Returns the serial number of the attached power supply, if present
Parameters
  • None
Returns
  • An number or string containing the power supply's serial number, or nil if the adapter is not attached or does not provide one.
Notes None
Examples None
Source extensions/battery/battery.lua line 314

# amperage

Signature hs.battery.amperage() -> number
Type Function
Description Returns the amount of current flowing through the battery, in mAh
Parameters
  • None
Returns
  • A number containing the amount of current flowing through the battery. The value may be:
  • Less than zero if the battery is being discharged (i.e. the computer is running on battery power)
  • Zero if the battery is being neither charged nor discharged
  • Greater than zero if the battery is being charged
Notes None
Examples None
Source extensions/battery/battery.lua line 159

# batterySerialNumber

Signature hs.battery.batterySerialNumber() -> string
Type Function
Description Returns the serial number of the battery, if present
Parameters
  • None
Returns
  • A string containing the battery's serial number, or nil if there is no battery or the battery or UPS does not provide one.
Notes None
Examples None
Source extensions/battery/battery.lua line 328

# batteryType

Signature hs.battery.batteryType() -> string
Type Function
Description Returns the type of battery present, or nil if there is no battery
Parameters
  • None
Returns
  • A string containing one of "UPS" or "InternalBattery", or nil if no battery is present.
Notes None
Examples None
Source extensions/battery/battery.lua line 300

# capacity

Signature hs.battery.capacity() -> number
Type Function
Description Returns the current capacity of the battery in mAh
Parameters
  • None
Returns
  • A number containing the current capacity of the battery in mAh
Notes
  • This is the measure of how charged the battery is, vs the value of hs.battery.maxCapacity()
Examples None
Source extensions/battery/battery.lua line 92

# cycles

Signature hs.battery.cycles() -> number
Type Function
Description Returns the number of discharge cycles of the battery
Parameters
  • None
Returns
  • The number of cycles
Notes
  • One cycle is a full discharge of the battery, followed by a full charge. This may also be an aggregate of many smaller discharge-then-charge cycles (e.g. 10 iterations of discharging the battery from 100% to 90% and then charging back to 100% each time, is considered to be one cycle)
Examples None
Source extensions/battery/battery.lua line 44

# designCapacity

Signature hs.battery.designCapacity() -> number
Type Function
Description Returns the design capacity of the battery in mAh.
Parameters
  • None
Returns
  • A number containing the rated maximum capacity of the battery
Notes None
Examples None
Source extensions/battery/battery.lua line 109

# getAll

Signature hs.battery.getAll() -> table
Type Function
Description Get all available battery information
Parameters
  • None
Returns
  • A table containing all the information provided by the separate functions in hs.battery
Notes
  • If you require multiple pieces of information about a battery, this function may be more efficient than calling several other functions separately
Examples None
Source extensions/battery/battery.lua line 342

# health

Signature hs.battery.health() -> string
Type Function
Description Returns the health status of the battery.
Parameters
  • None
Returns
  • A string containing one of {Good, Fair, Poor}, as determined by the Apple Smart Battery controller
Notes None
Examples None
Source extensions/battery/battery.lua line 200

# healthCondition

Signature hs.battery.healthCondition() -> string or nil
Type Function
Description Returns the health condition status of the battery.
Parameters
  • None
Returns
  • Nil if there are no health conditions to report, or a string containing either:
  • "Check Battery"
  • "Permanent Battery Failure"
Notes None
Examples None
Source extensions/battery/battery.lua line 214

# isCharged

Signature hs.battery.isCharged() -> boolean
Type Function
Description Returns the charged state of the battery
Parameters
  • None
Returns
  • True if the battery is charged, false if not
Notes None
Examples None
Source extensions/battery/battery.lua line 258

# isCharging

Signature hs.battery.isCharging() -> boolean
Type Function
Description Returns the charging state of the battery
Parameters
  • None
Returns
  • True if the battery is being charged, false if not
Notes None
Examples None
Source extensions/battery/battery.lua line 244

# isFinishingCharge

Signature hs.battery.isFinishingCharge() -> boolean or string
Type Function
Description Returns true if battery is finishing its charge
Parameters
  • None
Returns
  • True if the battery is in its final charging state (i.e. trickle charging), false if not
Notes None
Examples None
Source extensions/battery/battery.lua line 272

# maxCapacity

Signature hs.battery.maxCapacity() -> number
Type Function
Description Returns the maximum capacity of the battery in mAh
Parameters
  • None
Returns
  • A number containing the observed maximum capacity of the battery in mAh
Notes
  • This may exceed the value of hs.battery.designCapacity() due to small variations in the production chemistry vs the design
Examples None
Source extensions/battery/battery.lua line 75

# name

Signature hs.battery.name() -> string
Type Function
Description Returns the name of the battery
Parameters
  • None
Returns
  • A string containing the name of the battery
Notes None
Examples None
Source extensions/battery/battery.lua line 61

# otherBatteryInfo

Signature hs.battery.otherBatteryInfo() -> table
Type Function
Description Returns information about non-PSU batteries (e.g. Bluetooth accessories)
Parameters
  • None
Returns
  • A table containing information about other batteries known to the system, or an empty table if no devices were found
Notes None
Examples None
Source extensions/battery/libbattery.m line 110

# percentage

Signature hs.battery.percentage() -> number
Type Function
Description Returns the current percentage of battery charge
Parameters
  • None
Returns
  • A number containing the percentage of battery charge
Notes None
Examples None
Source extensions/battery/battery.lua line 123

# powerSource

Signature hs.battery.powerSource() -> string
Type Function
Description Returns the current source providing power
Parameters
  • None
Returns
  • A string containing one of {AC Power, Battery Power, UPS Power}.
Notes None
Examples None
Source extensions/battery/libbattery.m line 55

# powerSourceType

Signature hs.battery.powerSourceType() -> string
Type Function
Description Returns current power source type
Parameters
  • None
Returns
  • A string containing one of {AC Power, Battery Power, Off Line}.
Notes None
Examples None
Source extensions/battery/battery.lua line 286

# privateBluetoothBatteryInfo

Signature hs.battery.privateBluetoothBatteryInfo() -> table
Type Function
Description Returns information about Bluetooth devices using Apple Private APIs
Parameters
  • None
Returns
  • A table containing information about devices using private Apple APIs.
Notes
  • This function uses private Apple APIs - that means it can break without notice on any macOS version update. Please report breakage to us!
  • This function will return information for all connected Bluetooth devices, but much of it will be meaningless for most devices
  • The table contains the following keys:
  • vendorID - Numerical identifier for the vendor of the device (Apple's ID is 76)
  • productID - Numerical identifier for the device
  • address - The Bluetooth address of the device
  • isApple - A string containing "YES" or "NO", depending on whether or not this is an Apple/Beats product, or a third party product
  • name - A human readable string containing the name of the device
  • batteryPercentSingle - For some devices this will contain the percentage of the battery (e.g. Beats headphones)
  • batteryPercentCombined - We do not currently understand what this field represents, please report if you find a non-zero value here
  • batteryPercentCase - Battery percentage of AirPods cases (note that this will often read 0 - the AirPod case sleeps aggressively)
  • batteryPercentLeft - Battery percentage of the left AirPod if it is out of the case
  • batteryPercentRight - Battery percentage of the right AirPod if it is out of the case
  • buttonMode - We do not currently understand what this field represents, please report if you find a value other than 1
  • micMode - For AirPods this corresponds to the microphone option in the device's Bluetooth options
  • leftDoubleTap - For AirPods this corresponds to the left double tap action in the device's Bluetooth options
  • rightDoubleTap - For AirPods this corresponds to the right double tap action in the device's Bluetooth options
  • primaryBud - For AirPods this is either "left" or "right" depending on which bud is currently considered the primary device
  • primaryInEar - For AirPods this is "YES" or "NO" depending on whether or not the primary bud is currently in an ear
  • secondaryInEar - For AirPods this is "YES" or "NO" depending on whether or not the secondary bud is currently in an ear
  • isInEarDetectionSupported - Whether or not this device can detect when it is currently in an ear
  • isEnhancedDoubleTapSupported - Whether or not this device supports double tapping
  • isANCSupported - We believe this likely indicates whether or not this device supports Active Noise Cancelling (e.g. Beats Solo)
  • Please report any crashes from this function - it's likely that there are Bluetooth devices we haven't tested which may return weird data
  • Many/Most/All non-Apple party products will likely return zeros for all of the battery related fields here, as will Apple HID devices. It seems that these private APIs mostly exist to support Apple/Beats headphones.
Examples None
Source extensions/battery/libbattery.m line 171

# timeRemaining

Signature hs.battery.timeRemaining() -> number
Type Function
Description Returns the battery life remaining, in minutes
Parameters
  • None
Returns
  • A number containing the minutes of battery life remaining. The value may be:
  • Greater than zero to indicate the number of minutes remaining
  • -1 if the remaining battery life is still being calculated
  • -2 if there is unlimited time remaining (i.e. the system is on AC power)
Notes None
Examples None
Source extensions/battery/libbattery.m line 33

# timeToFullCharge

Signature hs.battery.timeToFullCharge() -> number
Type Function
Description Returns the time remaining for the battery to be fully charged, in minutes
Parameters
  • None
Returns
  • A number containing the time (in minutes) remaining for the battery to be fully charged, or -1 if the remaining time is still being calculated
Notes None
Examples None
Source extensions/battery/battery.lua line 230

# voltage

Signature hs.battery.voltage() -> number
Type Function
Description Returns the current voltage of the battery in mV
Parameters
  • None
Returns
  • A number containing the current voltage of the battery
Notes None
Examples None
Source extensions/battery/battery.lua line 145

# warningLevel

Signature hs.battery.warningLevel() -> string
Type Function
Description Returns a string specifying the current battery warning state.
Parameters
  • None
Returns
  • a string specifying the current warning level state. The string will be one of "none", "low", or "critical".
Notes
  • The meaning of the return strings is as follows:
  • "none" - indicates that the system is not in a low battery situation, or is currently attached to an AC power source.
  • "low" - the system is in a low battery situation and can provide no more than 20 minutes of runtime. Note that this is a guess only; 20 minutes cannot be guaranteed and will be greatly influenced by what the computer is doing at the time, how many applications are running, screen brightness, etc.
  • "critical" - the system is in a very low battery situation and can provide no more than 10 minutes of runtime. Note that this is a guess only; 10 minutes cannot be guaranteed and will be greatly influenced by what the computer is doing at the time, how many applications are running, screen brightness, etc.
Examples None
Source extensions/battery/libbattery.m line 80

# watts

Signature hs.battery.watts() -> number
Type Function
Description Returns the power entering or leaving the battery, in W
Parameters
  • None
Returns
  • A number containing the rate of energy conversion in the battery. The value may be:
  • Less than zero if the battery is being discharged (i.e. the computer is running on battery power)
  • Zero if the battery is being neither charged nor discharged
  • Greater than zero if the battery is being charged
Notes None
Examples None
Source extensions/battery/battery.lua line 176

© Copyright 2024 LateNite Films Pty Ltd. All rights reserved.