summaryrefslogtreecommitdiff
path: root/src/lua/stubs/power.lua
blob: 30fe7520d42a1d612b7724c22d29dab68a4f0db8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
--- Properties and functions that deal with the device's battery and power state
-- @module power

local power = {}

--- battery_pct returns the battery's current charge as a percentage
-- @treturn types.Property an integer property, from 0 to 100
function power.battery_pct() end

--- battery_millivolts returns the battery's current voltage in millivolts
-- @treturn types.Property an integer property, typically from about 3000 to about 4200.
function power.battery_millivolts() end

--- plugged_in returns whether or not the device is currently receiving external power
-- @treturn types.Property a boolean property
function power.plugged_in() end

return power