tangara-fw/luals-stubs/power.lua

-- SPDX-FileCopyrightText: 2023 jacqueline <me@jacqueline.id.au>
--
-- SPDX-License-Identifier: GPL-3.0-only

--- @meta

--- The `power` module contains properties and functions that relate to the
--- device's battery and charging state.
--- @class power
--- @field battery_pct Property The battery's current charge, as a percentage of the maximum charge.
--- @field battery_millivolts Property The battery's current voltage, in millivolts.
--- @field plugged_in Property Whether or not the device is currently receiving external power.
--- @field fast_charge Property Whether or not fast charging is enabled. Fast charging can fully recharge the battery up to two times faster than regular charging, but will have a small negative impact on the lifetime of the battery.
--- @field charge_state Property a string property describing the current charging state. May be one of "no_battery", "critical", "discharging", "charge_regular", "charge_fast", "full_charge", "fault", or "unknown".
local power = {}

return power
Add missing copyright/license headers 4 months ago			`-- SPDX-FileCopyrightText: 2023 jacqueline <me@jacqueline.id.au>`
			`--`
			`-- SPDX-License-Identifier: GPL-3.0-only`

split lua stubs into one set for ldoc, and one set for lua-ls 1 year ago			`--- @meta`

Use luals-stubs as the source of truth for docs, instead of maintaining separate docs stubs Includes introducing a cool new script to turn lua-language-server's json output into markdown documentation. 1 year ago			--- The `power` module contains properties and functions that relate to the
			`--- device's battery and charging state.`
split lua stubs into one set for ldoc, and one set for lua-ls 1 year ago			`--- @class power`
			`--- @field battery_pct Property The battery's current charge, as a percentage of the maximum charge.`
			`--- @field battery_millivolts Property The battery's current voltage, in millivolts.`
			`--- @field plugged_in Property Whether or not the device is currently receiving external power.`
Add a settings screen with power+battery info Mostly for debugging, but also u can toggle fast charging off and on now 9 months ago			`--- @field fast_charge Property Whether or not fast charging is enabled. Fast charging can fully recharge the battery up to two times faster than regular charging, but will have a small negative impact on the lifetime of the battery.`
			`--- @field charge_state Property a string property describing the current charging state. May be one of "no_battery", "critical", "discharging", "charge_regular", "charge_fast", "full_charge", "fault", or "unknown".`
split lua stubs into one set for ldoc, and one set for lua-ls 1 year ago			`local power = {}`

			`return power`