Bluetooth: Difference between revisions

(13 intermediate revisions by 5 users not shown)

Line 1:

==~~Enabling Bluetooth support~~==

==Setup==

To enable support for Bluetooth devices, amend your system configuration as follows:

To enable support for Bluetooth devices, amend your system configuration as follows and apply changes:

{{file|/etc/nixos/configuration.nix|nix|<nowiki>

{

hardware.bluetooth.enable = true;

~~...~~

hardware.bluetooth.enable = true; ~~# enables support for Bluetooth~~

~~hardware.bluetooth.powerOnBoot = true; # powers up the default Bluetooth controller on boot~~

~~...~~

}

</nowiki>}}

~~{{evaluate}}~~

==Usage==

==~~Pairing Bluetooth devices~~==

In order to use Bluetooth devices, they must be paired with your NixOS machine. Heavier [[:Category:Desktop_environment|desktop environments]] will usually provide a Bluetooth management GUI which you can use to pair devices.

In order to use Bluetooth devices, they must be paired with your NixOS machine. Heavier desktop environments will usually provide a Bluetooth management GUI which you can use to pair devices.

If your desktop environment does not provide such a GUI, you can additionally enable the blueman service, which provides blueman-applet and blueman-manager with the snippet below.

Line 39:

Line 33:

</syntaxhighlight>

==~~Using Bluetooth headsets with PulseAudio~~==

== Tips and tricks ==

To allow Bluetooth audio devices to be used with PulseAudio, amend <tt>/etc/nixos/configuration.nix</tt> as follows:

=== Using Bluetooth headsets with PulseAudio ===

To allow Bluetooth audio devices to be used with [[PulseAudio]], amend <tt>/etc/nixos/configuration.nix</tt> as follows:

<syntaxhighlight lang="nix">{

Line 54:

Line 49:

You can verify that PulseAudio has loaded the Bluetooth module by running <tt>pactl list | grep -i 'Name.*module.*blue'</tt>; Bluetooth modules should be present in the list.

== Using Bluetooth headset buttons to control media player ==

=== Using Bluetooth headset buttons to control media player ===

Many bluetooth headsets have buttons for pause/play or to skip to the next track.

~~Some~~ bluetooth headsets have buttons for pause/play or to skip to the next track.

To make these buttons usable with media players supporting the dbus-based [https://specifications.freedesktop.org/mpris-spec/latest/ MPRIS] standard,

one can use <code>mpris-proxy</code> that is part of bluez package.

Line 72:

Line 66:

Or, starting with Home Manager 21.05, enable the <code>mpris-proxy</code> service.

===System-Wide PulseAudio ===

Some headsets (such as Sony's WH-1000XM series) also support AVRCP directly and as such <code>mpris-proxy</code> is not required for this functionality, as headset button presses will register as media key presses. If you are using a WM or a desktop environment which doesn't support media keys, you will have to set up keybindigs yourself; the keys are typically called <code>XF86AudioPlay</code>, <code>XF86AudioPause</code>, <code>XF86AudioNext</code>, and <code>XF86AudioPrev</code>. However, note that some functionality, such as "take off headphones to pause" on WH-1000XM4/5 requires two-way AVRCP communication to work properly, so `mpris-proxy` is still recommended if you wish to use it. It also may or may not help with Bluetooth multipoint.

==== System-Wide PulseAudio ====

{{Expansion|When setting up pulseaudio systemWide extra policies needs to be deployed for pulse to be able to connect to the bluetooth stack. The Info below is not enough.}}

Line 88:

Line 84:

</syntaxHighlight>

===Enabling extra codecs===

==== Enabling extra codecs ====

While pulseaudio itself only has support for the SBC bluetooth codec there is out-of-tree support for AAC, APTX, APTX-HD and LDAC.

To enable extra codecs add the following to <tt>/etc/nixos/configuration.nix</tt>:

<~~syntaxHighlight~~ lang="nix">

{

...

~~hardware~~.pulseaudio = {

services.pulseaudio = {

enable = true;

package = pkgs.pulseaudioFull;

Line 101:

Line 97:

...

}

</~~syntaxHighlight~~>

</syntaxhighlight>

===Enabling A2DP Sink===

==== Enabling A2DP Sink ====

Modern headsets will generally try to connect using the A2DP profile. To enable this for your bluetooth connection, add the following to <tt>/etc/nixos/configuration.nix</tt>

<syntaxhighlight lang="nix">{

{

hardware.bluetooth.settings = {

General = {

Line 113:

Line 108:

};

}

}</syntaxhighlight>

</syntaxhighlight>

This configuration may be unnecessary and does not work with bluez5 (<tt>Unknown key Enable for group General</tt> ).

===Managing audio devices===

==== Managing audio devices ====

<tt>pavucontrol</tt> can be used to reconfigure the device:

* To enable A2DP, change the profile to “High Fidelity Playback (A2DP Sink)” on the “Configuration” tab.

Line 140:

Line 133:

Note that you may need to clear the pulseaudio config located at ~/.config/pulse to get this to work. Also you may have to unset and then set the default audio device to the bluetooth device, see https://github.com/NixOS/nixpkgs/issues/86441 for more info

==Showing battery charge of bluetooth devices==

=== Showing battery charge of bluetooth devices ===

If you want to see what charge your bluetooth devices have you have to enable experimental features, which might lead to bugs (according to [https://wiki.archlinux.org/title/Bluetooth_headset#Battery_level_reporting Arch Wiki). You can add the following to your config to enable experimental feature for bluetooth:

If you want to see what charge your bluetooth devices have you have to enable experimental features, which might lead to bugs (according to [https://wiki.archlinux.org/title/Bluetooth_headset#Battery_level_reporting Arch Wiki]). You can add the following to your config to enable experimental feature for bluetooth:

<syntaxhighlight lang="nix">{

...

Line 151:

Line 144:

...

}</syntaxhighlight>

Afterwards rebuild your system and then restart your bluetooth service by executing <syntaxhighlight lang="console">$ systemctl restart bluetooth</syntaxhighlight>.

Afterwards rebuild your system and then restart your bluetooth service by executing <syntaxhighlight lang="console">$ systemctl restart bluetooth</syntaxhighlight>

=== Pairing hearing aids using the ASHA protocol ===

The upstream bluez project [https://github.com/thewierdnut/asha_pipewire_sink#alternatives-are-coming has not yet implemented audio support for the ASHA protocol]. As an alternative it is possible to enable audio streaming using the [https://github.com/thewierdnut/asha_pipewire_sink asha-pipewire-sink] project.

Add following to your system config and apply it:

boot.extraModprobeConfig = ''

options bluetooth enable_ecred=1

'';

hardware = {

bluetooth = {

enable = true;

settings = {

LE = {

MinConnectionInterval = 16;

MaxConnectionInterval = 16;

ConnectionLatency = 10;

ConnectionSupervisionTimeout = 100;

};

environment.systemPackages = [ pkgs.asha-pipewire-sink ];

</syntaxhighlight>Ensure that profiles <code>LE2MTX LE2MRX</code> are part of <code>Selected phys</code> when running <code>sudo btmgmt phy</code>, otherwise follow the instruction [https://github.com/thewierdnut/asha_pipewire_sink#enable-2m-phy-optional here].

Pair and connect to both of your hearing aids.

Run the command <code>asha_pipewire_sink</code> and choose your hearing aids as audio sink in your sound mixer application, for example <code>pavucontrol</code>.

=== File Transfer from/to Mobile Device ===

Use Case: When you're not using a desktop/window manager who supports accepting files the GUI (e.g. sway, etc)

<code>systemctl --user edit obex</code>

<syntaxhighlight lang="ini">{

### Editing /home/<youruser>/.config/systemd/user/obex.service.d/override.conf

### Anything between here and the comment below will become the contents of the drop-in file

[Service]

ExecStart=

ExecStart=/nix/store/...-bluez-5.78/libexec/bluetooth/obexd --root=./Downloads --auto-accept

### Edits below this comment will be discarded

...

}</syntaxhighlight>

With this config, after pairing (and - I suspect - trusting) your mobile device, you should be able to receive files from your phone.

Caveat: When sending files to the phone, take into account that not all file extensions are accepted. Renaming the file before transfer did the trick.

<code>sudo journalctl -f -t obexd</code> be your friend.

==Troubleshooting==

@@ Line 1: / Line 1: @@
-==Enabling Bluetooth support==
+==Setup==
-To enable support for Bluetooth devices, amend your system configuration as follows:
+To enable support for Bluetooth devices, amend your system configuration as follows and apply changes:
 {{file|/etc/nixos/configuration.nix|nix|<nowiki>
-{
+hardware.bluetooth.enable = true;
-  ...
-  hardware.bluetooth.enable = true; # enables support for Bluetooth
-  hardware.bluetooth.powerOnBoot = true; # powers up the default Bluetooth controller on boot
-  ...
-}
 </nowiki>}}
-{{evaluate}}
+==Usage==
-==Pairing Bluetooth devices==
+In order to use Bluetooth devices, they must be paired with your NixOS machine. Heavier [[:Category:Desktop_environment|desktop environments]] will usually provide a Bluetooth management GUI which you can use to pair devices.
-In order to use Bluetooth devices, they must be paired with your NixOS machine. Heavier desktop environments will usually provide a Bluetooth management GUI which you can use to pair devices.
 If your desktop environment does not provide such a GUI, you can additionally enable the blueman service, which provides blueman-applet and blueman-manager with the snippet below.
@@ Line 39: / Line 33: @@
 </syntaxhighlight>
-==Using Bluetooth headsets with PulseAudio==
+== Tips and tricks ==
-To allow Bluetooth audio devices to be used with PulseAudio, amend <tt>/etc/nixos/configuration.nix</tt> as follows:
+=== Using Bluetooth headsets with PulseAudio ===
+To allow Bluetooth audio devices to be used with [[PulseAudio]], amend <tt>/etc/nixos/configuration.nix</tt> as follows:
 <syntaxhighlight lang="nix">{
@@ Line 54: / Line 49: @@
 You can verify that PulseAudio has loaded the Bluetooth module by running <tt>pactl list | grep -i 'Name.*module.*blue'</tt>; Bluetooth modules should be present in the list.
-== Using Bluetooth headset buttons to control media player ==
+=== Using Bluetooth headset buttons to control media player ===
+Many bluetooth headsets have buttons for  pause/play or to skip to the next track.
-Some bluetooth headsets have buttons for  pause/play or to skip to the next track.
 To make these buttons usable with media players supporting the dbus-based [https://specifications.freedesktop.org/mpris-spec/latest/ MPRIS] standard,
 one can use <code>mpris-proxy</code> that is part of bluez package.
@@ Line 72: / Line 66: @@
 Or, starting with Home Manager 21.05, enable the <code>mpris-proxy</code> service.
-===System-Wide PulseAudio ===
+Some headsets (such as Sony's WH-1000XM series) also support AVRCP directly and as such <code>mpris-proxy</code> is not required for this functionality, as headset button presses will register as media key presses. If you are using a WM or a desktop environment which doesn't support media keys, you will have to set up keybindigs yourself; the keys are typically called <code>XF86AudioPlay</code>, <code>XF86AudioPause</code>, <code>XF86AudioNext</code>, and <code>XF86AudioPrev</code>. However, note that some functionality, such as "take off headphones to pause" on WH-1000XM4/5 requires two-way AVRCP communication to work properly, so `mpris-proxy` is still recommended if you wish to use it. It also may or may not help with Bluetooth multipoint.
+==== System-Wide PulseAudio ====
 {{Expansion|When setting up pulseaudio systemWide extra policies needs to be deployed for pulse to be able to connect to the bluetooth stack. The Info below is not enough.}}
@@ Line 88: / Line 84: @@
 </syntaxHighlight>
-===Enabling extra codecs===
+==== Enabling extra codecs ====
 While pulseaudio itself only has support for the SBC bluetooth codec there is out-of-tree support for AAC, APTX, APTX-HD and LDAC.
 To enable extra codecs add the following to <tt>/etc/nixos/configuration.nix</tt>:
-<syntaxHighlight lang="nix">
+<syntaxhighlight lang="nix">
 {
 ...
-   hardware.pulseaudio = {
+   services.pulseaudio = {
      enable = true;
      package = pkgs.pulseaudioFull;
@@ Line 101: / Line 97: @@
 ...
 }
-</syntaxHighlight>
+</syntaxhighlight>
-===Enabling A2DP Sink===
+==== Enabling A2DP Sink ====
 Modern headsets will generally try to connect using the A2DP profile. To enable this for your bluetooth connection, add the following to <tt>/etc/nixos/configuration.nix</tt>
-<syntaxhighlight lang="nix">
+<syntaxhighlight lang="nix">{
-{
    hardware.bluetooth.settings = {
      General = {
@@ Line 113: / Line 108: @@
      };
    };
-}
+}</syntaxhighlight>
-</syntaxhighlight>
 This configuration may be unnecessary and does not work with bluez5 (<tt>Unknown key Enable for group General</tt> ).
-===Managing audio devices===
+==== Managing audio devices ====
 <tt>pavucontrol</tt> can be used to reconfigure the device:
 * To enable A2DP, change the profile to &#8220;High Fidelity Playback (A2DP Sink)&#8221; on the &#8220;Configuration&#8221; tab.
@@ Line 140: / Line 133: @@
 Note that you may need to clear the pulseaudio config located at ~/.config/pulse to get this to work. Also you may have to unset and then set the default audio device to the bluetooth device, see https://github.com/NixOS/nixpkgs/issues/86441 for more info
-==Showing battery charge of bluetooth devices==
+=== Showing battery charge of bluetooth devices ===
-If you want to see what charge your bluetooth devices have you have to enable experimental features, which might lead to bugs (according to [https://wiki.archlinux.org/title/Bluetooth_headset#Battery_level_reporting Arch Wiki). You can add the following to your config to enable experimental feature for bluetooth:
+If you want to see what charge your bluetooth devices have you have to enable experimental features, which might lead to bugs (according to [https://wiki.archlinux.org/title/Bluetooth_headset#Battery_level_reporting Arch Wiki]). You can add the following to your config to enable experimental feature for bluetooth:
 <syntaxhighlight lang="nix">{
 ...
@@ Line 151: / Line 144: @@
 ...
 }</syntaxhighlight>
-Afterwards rebuild your system and then restart your bluetooth service by executing  <syntaxhighlight lang="console">$ systemctl restart bluetooth</syntaxhighlight>.
+Afterwards rebuild your system and then restart your bluetooth service by executing  <syntaxhighlight lang="console">$ systemctl restart bluetooth</syntaxhighlight>
+=== Pairing hearing aids using the ASHA protocol ===
+The upstream bluez project [https://github.com/thewierdnut/asha_pipewire_sink#alternatives-are-coming has not yet implemented audio support for the ASHA protocol]. As an alternative it is possible to enable audio streaming using the [https://github.com/thewierdnut/asha_pipewire_sink asha-pipewire-sink] project.
+Add following to your system config and apply it:
+<syntaxhighlight lang="nix">
+boot.extraModprobeConfig = ''
+  options bluetooth enable_ecred=1
+'';
+hardware = {
+  bluetooth = {
+    enable = true;
+    settings = {
+      LE = {
+        MinConnectionInterval = 16;
+        MaxConnectionInterval = 16;
+        ConnectionLatency = 10;
+        ConnectionSupervisionTimeout = 100;
+      };
+    };
+  };
+};
+environment.systemPackages = [ pkgs.asha-pipewire-sink ];
+</syntaxhighlight>Ensure that profiles <code>LE2MTX LE2MRX</code> are part of <code>Selected phys</code> when running <code>sudo btmgmt phy</code>, otherwise follow the instruction [https://github.com/thewierdnut/asha_pipewire_sink#enable-2m-phy-optional here].
+Pair and connect to both of your hearing aids.
+Run the command <code>asha_pipewire_sink</code> and choose your hearing aids as audio sink in your sound mixer application, for example <code>pavucontrol</code>.
+=== File Transfer from/to Mobile Device ===
+Use Case: When you're not using a desktop/window manager who supports accepting files the GUI (e.g. sway, etc)
+<code>systemctl --user edit obex</code>
+<syntaxhighlight lang="ini">{
+### Editing /home/<youruser>/.config/systemd/user/obex.service.d/override.conf
+### Anything between here and the comment below will become the contents of the drop-in file
+[Service]
+ExecStart=
+ExecStart=/nix/store/...-bluez-5.78/libexec/bluetooth/obexd --root=./Downloads --auto-accept
+### Edits below this comment will be discarded
+...
+}</syntaxhighlight>
+With this config, after pairing (and - I suspect - trusting) your mobile device, you should be able to receive files from your phone.
+Caveat: When sending files to the phone, take into account that not all file extensions are accepted. Renaming the file before transfer did the trick.
+<code>sudo journalctl -f -t obexd</code> be your friend.
 ==Troubleshooting==