summaryrefslogtreecommitdiff
path: root/docs/guide/libraries/bluetooth.md
blob: 9a3e5b8f5c52aec5b909037b3506a56c8feb0400 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# Bluetooth

Library for monitoring [bluez](https://www.bluez.org/) over dbus.

## 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
```

:::

## 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 vala valadoc 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 --prefix /usr build
meson install -C build
```