tangara-fw/luals-stubs/bluetooth.lua

--- @meta

--- The 'bluetooth' module contains Properties and functions for interacting
--- with the device's Bluetooth capabilities.
--- @class bluetooth
--- @field enabled Property Whether or not the Bluetooth stack is currently enabled. This property is writeable, and can be used to enable or disable Bluetooth.
--- @field connected Property Whether or not there is an active connection to another Bluetooth device.
--- @field connecting Property Whether or not we are currently connecting to the paired device.
--- @field discovering Property Whether or not we are actively scanning for new devices.
--- @field paired_device Property The device that is currently paired. The bluetooth stack will automatically connect to this device if possible.
--- @field discovered_devices Property Devices nearby that have been discovered.
--- @field known_devices Property Devices that have previously been paired.
local bluetooth = {}

--- Enables Bluetooth, this is the same as bluetooth.enabled:set(true)
function bluetooth.enable() end

--- Disables Bluetooth, this is the same as bluetooth.enabled:set(false)
function bluetooth.disable() end

return bluetooth
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 'bluetooth' module contains Properties and functions for interacting`
			`--- with the device's Bluetooth capabilities.`
split lua stubs into one set for ldoc, and one set for lua-ls 1 year ago			`--- @class bluetooth`
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			`--- @field enabled Property Whether or not the Bluetooth stack is currently enabled. This property is writeable, and can be used to enable or disable Bluetooth.`
			`--- @field connected Property Whether or not there is an active connection to another Bluetooth device.`
Lua API improvements and fixes Co-authored-by: jacqueline <me@jacqueline.id.au> 8 months ago			`--- @field connecting Property Whether or not we are currently connecting to the paired device.`
			`--- @field discovering Property Whether or not we are actively scanning for new devices.`
			`--- @field paired_device Property The device that is currently paired. The bluetooth stack will automatically connect to this device if possible.`
			`--- @field discovered_devices Property Devices nearby that have been discovered.`
			`--- @field known_devices Property Devices that have previously been paired.`
split lua stubs into one set for ldoc, and one set for lua-ls 1 year ago			`local bluetooth = {}`

Lua API improvements and fixes Co-authored-by: jacqueline <me@jacqueline.id.au> 8 months ago			`--- Enables Bluetooth, this is the same as bluetooth.enabled:set(true)`
			`function bluetooth.enable() end`

			`--- Disables Bluetooth, this is the same as bluetooth.enabled:set(false)`
			`function bluetooth.disable() end`

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