summaryrefslogtreecommitdiff
path: root/src/lua/stubs/bluetooth.lua
diff options
context:
space:
mode:
authorjacqueline <me@jacqueline.id.au>2023-11-15 10:22:01 +1100
committerjacqueline <me@jacqueline.id.au>2023-11-15 10:22:01 +1100
commit51d1cee3d70bac68e7bc735569e92bc584267f73 (patch)
treeb78090c8c85b672e5e5ad9cb84dcf1e7f01cba46 /src/lua/stubs/bluetooth.lua
parent0cae95a71ee88aafe0a9fffe9ee310b708029146 (diff)
downloadtangara-fw-51d1cee3d70bac68e7bc735569e92bc584267f73.tar.gz
Set up ldoc and lua-language-server, write some module stubs
Diffstat (limited to 'src/lua/stubs/bluetooth.lua')
-rw-r--r--src/lua/stubs/bluetooth.lua14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/lua/stubs/bluetooth.lua b/src/lua/stubs/bluetooth.lua
new file mode 100644
index 00000000..f819c2f1
--- /dev/null
+++ b/src/lua/stubs/bluetooth.lua
@@ -0,0 +1,14 @@
+--- Properties and functions for handling Bluetooth connectivity
+-- @module bluetooth
+
+local bluetooth = {}
+
+-- Whether or not the Bluetooth stack is currently enabled. This property is writeable, and can be used to enable or disable Bluetooth.
+-- @treturn types.Property a boolean property
+function bluetooth.enabled() end
+
+--- Whether or not there is an active connection to another Bluetooth device.
+-- @treturn types.Property a boolean property
+function bluetooth.connected() end
+
+return bluetooth