summaryrefslogtreecommitdiff
path: root/docs/libraries/bluetooth.md
diff options
context:
space:
mode:
authorAylur <[email protected]>2024-09-25 23:22:01 +0000
committerAylur <[email protected]>2024-09-25 23:22:01 +0000
commit65654282a98cb0590d498e4ed9c924f97646f1dc (patch)
tree9150a8c5dca5429fafdd559db6e88f8bccb23d84 /docs/libraries/bluetooth.md
parentfd8c3e81d8f7b235be123ce592f89e72f65a0f05 (diff)
docs: restructure
Diffstat (limited to 'docs/libraries/bluetooth.md')
-rw-r--r--docs/libraries/bluetooth.md104
1 files changed, 0 insertions, 104 deletions
diff --git a/docs/libraries/bluetooth.md b/docs/libraries/bluetooth.md
deleted file mode 100644
index 04d9db2..0000000
--- a/docs/libraries/bluetooth.md
+++ /dev/null
@@ -1,104 +0,0 @@
-# Bluetooth
-
-Library for monitoring [bluez](https://www.bluez.org/) over dbus.
-
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson vala gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson gcc valac gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson valac gobject-introspection
-```
-
-:::
-
-::: info
-Although bluez is not a direct build dependency,
-it should be self-explanatory that the daemon is required to be available at runtime.
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/bluetooth
-```
-
-3. install
-
-```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
-meson setup --prefix /usr build
-```
-
-:::
-
-## Usage
-
-You can browse the [Bluetooth reference](https://aylur.github.io/libastal/bluetooth).
-
-### CLI
-
-There is no CLI for this library, use the one provided by bluez.
-
-```sh
-bluetoothctl --help
-```
-
-### Library
-
-:::code-group
-
-```js [<i class="devicon-javascript-plain"></i> JavaScript]
-import Bluetooth from "gi://AstalBluetooth"
-
-const bluetooth = Bluetooth.get_default()
-
-for (const device of bluetooth.get_devices()) {
- print(device.name)
-}
-```
-
-```py [<i class="devicon-python-plain"></i> Python]
-from gi.repository import AstalBluetooth as Bluetooth
-
-bluetooth = Bluetooth.get_default()
-
-for device in bluetooth.get_devices():
- print(device.get_name())
-```
-
-```lua [<i class="devicon-lua-plain"></i> Lua]
-local Bluetooth = require("lgi").require("AstalBluetooth")
-
-local bluetooth = Bluetooth.get_default()
-
-for _, d in ipairs(bluetooth.devices) do
- print(d.name)
-end
-```
-
-```vala [<i class="devicon-vala-plain"></i> Vala]
-// Not yet documented
-```
-
-:::