diff options
| author | jacqueline <me@jacqueline.id.au> | 2023-11-15 10:22:01 +1100 |
|---|---|---|
| committer | jacqueline <me@jacqueline.id.au> | 2023-11-15 10:22:01 +1100 |
| commit | 51d1cee3d70bac68e7bc735569e92bc584267f73 (patch) | |
| tree | b78090c8c85b672e5e5ad9cb84dcf1e7f01cba46 /src/lua/stubs/power.lua | |
| parent | 0cae95a71ee88aafe0a9fffe9ee310b708029146 (diff) | |
| download | tangara-fw-51d1cee3d70bac68e7bc735569e92bc584267f73.tar.gz | |
Set up ldoc and lua-language-server, write some module stubs
Diffstat (limited to 'src/lua/stubs/power.lua')
| -rw-r--r-- | src/lua/stubs/power.lua | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/src/lua/stubs/power.lua b/src/lua/stubs/power.lua new file mode 100644 index 00000000..30fe7520 --- /dev/null +++ b/src/lua/stubs/power.lua @@ -0,0 +1,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
\ No newline at end of file |
