bluetooth-2-usb 0.8.0

Description:

bluetooth2usb 0.8.0

Bluetooth to USB


Table of Contents

1. Introduction
2. Features
3. Requirements
4. Installation

4.1. Prerequisites
4.2. Setup


5. Usage

5.1. Connection to target device / host

5.1.1. Raspberry Pi 4 Model B
5.1.2. Raspberry Pi Zero (2) W(H)


5.2. Command-line arguments
5.3. Consuming the API from your Python code


6. Updating
7. Uninstallation
8. Troubleshooting

8.1. The Pi keeps rebooting or crashes randomly
8.2. The installation was successful, but I don't see any output on the target device
8.3. In bluetoothctl, my device is constantly switching on/off
8.4. I have a different issue
8.5. Everything is working, but can it help me with Bitcoin mining?


9. Bonus points
10. Contributing
11. License
12. Acknowledgments

1. Introduction
Convert a Raspberry Pi into a HID relay that translates Bluetooth keyboard and mouse input to USB. Minimal configuration. Zero hassle.
The issue with Bluetooth devices is that you usually can't use them to:

wake up sleeping devices,
access the BIOS or OS select menu (e.g., GRUB),
access devices without Bluetooth interface (e.g., devices in a restricted environment or most KVM switches).

Sounds familiar? Congratulations! You just found the solution!
Linux's gadget mode allows a Raspberry Pi to act as USB HID (Human Interface Device). Therefore, from the host's perspective, it appears like a regular USB keyboard or mouse. You may think of your Pi as a multi-device Bluetooth dongle.
2. Features

Simple installation and highly automated setup
Supports multiple input devices (currently keyboard and mouse - more than one of each kind simultaneously)
Supports 146 multimedia keys (e.g., mute, volume up/down, launch browser, etc.)
Auto-discovery feature for input devices
Auto-reconnect feature for input devices (power off, energy saving mode, out of range, etc.)
Robust error handling and logging
Installation as a systemd service
Reliable concurrency using state-of-the-art TaskGroups
Clean and actively maintained code base

3. Requirements

A Raspberry Pi with Bluetooth and USB OTG support required for USB gadgets in so-called device mode. Supported models include:

Raspberry Pi Zero W(H): Includes Bluetooth 4.1 and supports USB OTG with the lowest price tag.
Raspberry Pi Zero 2 W: Similar to the Raspberry Pi Zero W, it has Bluetooth 4.1 and USB OTG support while providing additional processing power.
Raspberry Pi 4 Model B: Offers Bluetooth 5.0 and USB-C OTG support for device mode, providing the best performance (that is until the Pi 5 is available).


Linux OS with systemd support (e.g., Raspberry Pi OS, recommended).
Python 3.11 for using TaskGroups.


[!NOTE]
Raspberry Pi 3 Models feature Bluetooth 4.2 but no native USB gadget mode support. Earlier models like Raspberry Pi 1 and 2 do not support Bluetooth natively and have no USB gadget mode support.


[!NOTE]
The latest version of Raspberry Pi OS, based on Debian Bookworm, supports Python 3.11 through the official package repositories. For older versions, you may build it from source. Note that building may take anything between a few minutes (Pi 4B) and more than an hour (Pi 0W).

4. Installation
Follow these steps to install and configure the project:
4.1. Prerequisites


Install an OS on your Raspberry Pi (e.g., using Pi Imager)


Connect to a network via Ethernet cable or Wi-Fi. Make sure this network has Internet access.


(optional, recommended) Enable SSH, if you intend to access the Pi remotely.



[!NOTE]
These settings above may be configured during imaging (recommended), on first boot or afterwards.



Connect to the Pi and make sure git is installed:
sudo apt update && sudo apt upgrade -y && sudo apt install -y git



Pair and trust any Bluetooth devices you wish to relay, either via GUI or via CLI:
bluetoothctl
scan on

... wait for your devices to show up and note their MAC addresses (you may also type the first characters and hit TAB for auto-completion in the following commands) ...
trust A1:B2:C3:D4:E5:F6
pair A1:B2:C3:D4:E5:F6
connect A1:B2:C3:D4:E5:F6




[!NOTE]
Replace A1:B2:C3:D4:E5:F6 by your input device's Bluetooth MAC address

4.2. Setup


On the Pi, clone the repository to your home directory:
cd ~ && git clone https://github.com/quaxalber/bluetooth_2_usb.git



Run the installation script as root:
sudo ~/bluetooth_2_usb/scripts/install.sh



Reboot:
sudo reboot



Verify that the service is running:
service bluetooth_2_usb status

It should look something like this and say Active: active (running):
user@pi0w:~ $ service bluetooth_2_usb status
● bluetooth_2_usb.service - Bluetooth to USB HID relay
Loaded: loaded (/etc/systemd/system/bluetooth_2_usb.service; enabled; preset: enabled)
Active: active (running) since Wed 2023-12-13 10:33:00 CET; 44min ago
Main PID: 5865 (bash)
Tasks: 4 (limit: 389)
CPU: 2min 49.448s
CGroup: /system.slice/bluetooth_2_usb.service
├─5865 bash /usr/bin/bluetooth_2_usb --auto_discover --grab_devices
└─5869 python3.11 /home/user/bluetooth_2_usb/bluetooth_2_usb.py --auto_discover --grab_devices

Dec 13 10:33:00 pi0w systemd[1]: Started bluetooth_2_usb.service - Bluetooth to USB HID relay.
Dec 13 10:33:06 pi0w bluetooth_2_usb[5869]: 23-12-13 10:33:06 [INFO] Launching Bluetooth 2 USB v0.8.0
Dec 13 10:33:06 pi0w bluetooth_2_usb[5869]: 23-12-13 10:33:06 [INFO] Discovering input devices...
Dec 13 10:33:09 pi0w bluetooth_2_usb[5869]: 23-12-13 10:33:09 [INFO] Activated relay for device /dev/input/event2, name "AceRK Mouse", phys "0a:1b:2c:3d:4e:5f"
Dec 13 10:33:09 pi0w bluetooth_2_usb[5869]: 23-12-13 10:33:09 [INFO] Activated relay for device /dev/input/event1, name "AceRK Keyboard", phys "0a:1b:2c:3d:4e:5f"
Dec 13 10:33:09 pi0w bluetooth_2_usb[5869]: 23-12-13 10:33:09 [INFO] Activated relay for device /dev/input/event0, name "vc4-hdmi", phys "vc4-hdmi/input0"




[!NOTE]
Something seems off? Try yourself in Troubleshooting!

5. Usage
5.1. Connection to target device / host
5.1.1. Raspberry Pi 4 Model B
Connect the USB-C power port of your Pi 4B via cable with a USB port on your target device. You should hear the USB connection sound (depending on the target device) and be able to access your target device wirelessly using your Bluetooth keyboard or mouse. In case the Pi solely draws power from the host, it will take some time for the Pi to boot.

[!IMPORTANT]
It's essential to use the small power port instead of the bigger USB-A ports, since only the power port has the OTG feature required for USB gadgets.

5.1.2. Raspberry Pi Zero (2) W(H)
For the Pi Zero, the situation is quite the opposite: Do not use the power port to connect to the target device, use the other port instead (typically labeled "DATA" or "USB"). You may connect the power port to a stable power supply.
5.2. Command-line arguments
Currently you can provide the following CLI arguments:
user@pi0w:~ $ bluetooth_2_usb -h
usage: bluetooth_2_usb.py [--device_ids DEVICE_IDS] [--auto_discover] [--grab_devices] [--list_devices] [--log_to_file] [--log_path LOG_PATH] [--debug] [--version] [--help]

Bluetooth to USB HID relay. Handles Bluetooth keyboard and mouse events from multiple input devices and translates them to USB using Linux's gadget mode.

options:
--device_ids DEVICE_IDS, -i DEVICE_IDS
Comma-separated list of identifiers for input devices to be relayed.
An identifier is either the input device path, the MAC address or any case-insensitive substring of the device name.
Example: --device_ids '/dev/input/event2,a1:b2:c3:d4:e5:f6,0A-1B-2C-3D-4E-5F,logi'
Default: None
--auto_discover, -a Enable auto-discovery mode. All readable input devices will be relayed automatically.
Default: disabled
--grab_devices, -g Grab the input devices, i.e., suppress any events on your relay device.
Devices are not grabbed by default.
--list_devices, -l List all available input devices and exit.
--log_to_file, -f Add a handler that logs to file, additionally to stdout.
--log_path LOG_PATH, -p LOG_PATH
The path of the log file
Default: /var/log/bluetooth_2_usb/bluetooth_2_usb.log
--debug, -d Enable debug mode (Increases log verbosity)
Default: disabled
--version, -v Display the version number of this software and exit.
--help, -h Show this help message and exit.

5.3. Consuming the API from your Python code
The API is designed such that it may be consumed both via CLI and from within external Python code. More details on this coming soon!
6. Updating
You may update to the latest stable release by running:
sudo ~/bluetooth_2_usb/scripts/update.sh


[!NOTE]
The update script performs a clean reinstallation, that is run uninstall.sh, delete the repo folder, clone again and run the install script. The current branch will be maintained.

7. Uninstallation
You may uninstall Bluetooth 2 USB by running:
sudo ~/bluetooth_2_usb/scripts/uninstall.sh

8. Troubleshooting
8.1. The Pi keeps rebooting or crashes randomly
This is likely due to the limited power the Pi can draw from the host's USB port. Try these steps:

If available, connect your Pi to a USB 3 port on the host / target device (usually blue) or preferably USB-C.


[!IMPORTANT]
Do not use the blue (or black) USB-A ports of your Pi to connect. This won't work.
Do use the small USB-C power port (in case of Pi 4B). For Pi Zero, use the data port to connect to the host and attach the power port to a dedicated power supply.



Try to connect to the Pi via SSH instead of attaching a display directly and remove any unnecessary peripherals.


Install a lite version of your OS on the Pi (without GUI)


For Pi 4B: Get a USB-C Data/Power Splitter and draw power from a dedicated power supply. This should ultimately resolve any power-related issues, and your Pi 4B will no longer be dependent on the host's power supply.



[!NOTE]
The Pi Zero is recommended to have a 1.2 A power supply for stable operation, the Pi Zero 2 requires 2.0 A and the Pi 4B even 3.0 A, while hosts may typically only supply up to 0.5/0.9 A through USB-A 2.0/3.0 ports. However, this may be sufficient depending on your specific soft- and hardware configuration. For more information see the Raspberry Pi documentation.

8.2. The installation was successful, but I don't see any output on the target device
This could be due to a number of reasons. Try these steps:


Verify that the service is running:
service bluetooth_2_usb status



Verify that you specified the correct input devices in bluetooth_2_usb.service


Verify that your Bluetooth devices are paired, trusted, connected and not blocked:
bluetoothctl
info A1:B2:C3:D4:E5:F6

It should look like this:
user@pi0w:~ $ bluetoothctl
Agent registered
[CHG] Controller 0A:1B:2C:3D:4E:5F Pairable: yes
[AceRK]# info A1:B2:C3:D4:E5:F6
Device A1:B2:C3:D4:E5:F6 (random)
Name: AceRK
Alias: AceRK
Paired: yes <---
Trusted: yes <---
Blocked: no <---
Connected: yes <---
WakeAllowed: no
LegacyPairing: no
UUID: Generic Access Profile (00001800-0000-1000-8000-00805f9b34fb)
UUID: Generic Attribute Profile (00001801-0000-1000-8000-00805f9b34fb)
UUID: Device Information (0000180a-0000-1000-8000-00805f9b34fb)
UUID: Human Interface Device (00001812-0000-1000-8000-00805f9b34fb)
UUID: Nordic UART Service (6e400001-b5a3-f393-e0a9-e50e24dcca9e)




[!NOTE]
Replace A1:B2:C3:D4:E5:F6 by your input device's Bluetooth MAC address



Reload and restart service:
sudo systemctl daemon-reload && sudo service bluetooth_2_usb restart



Reboot Pi
sudo reboot



Re-connect the Pi to the host and check that the cable is capable of transmitting data, not power only


Try a different USB port on the host


Try connecting to a different host


8.3. In bluetoothctl, my device is constantly switching on/off
This is a common issue, especially when the device gets paired with multiple hosts. One simple fix/workaround is to re-pair the device:
bluetoothctl
power off
power on
block A1:B2:C3:D4:E5:F6
remove A1:B2:C3:D4:E5:F6
scan on
trust A1:B2:C3:D4:E5:F6
pair A1:B2:C3:D4:E5:F6
connect A1:B2:C3:D4:E5:F6

If the issue persists, it's worth trying to delete the cache:
sudo -i
cd '/var/lib/bluetooth/0A:1B:2C:3D:4E:5F/cache'
rm -rf 'A1:B2:C3:D4:E5:F6'
exit


[!NOTE]
Replace 0A:1B:2C:3D:4E:5F by your Pi's Bluetooth controller's MAC and A1:B2:C3:D4:E5:F6 by your input device's MAC

8.4. I have a different issue
Here's a few things you could try:

Check the log files (default at /var/log/bluetooth_2_usb/) for errors


[!NOTE]
Logging to file requires the -f flag



You may also query the journal to inspect the service logs in real-time:
journalctl -u bluetooth_2_usb.service -n 50 -f



For easier degguging, you may temporarily stop the service and run the script manually, modifying arguments as required, e.g., increase log verbosity by appending -d:
sudo service bluetooth_2_usb stop && sudo bluetooth_2_usb -ad ; sudo service bluetooth_2_usb start



When you interact with your Bluetooth devices with -d set, you should see debug output in the logs such as:
user@pi0w:~/bluetooth_2_usb $ sudo service bluetooth_2_usb stop && sudo bluetooth_2_usb -i hdmi,a1:b2:c3:d4:e5:f6,/dev/input/event3 -d ; sudo service bluetooth_2_usb start
23-12-16 15:52:21 [DEBUG] CLI args: device_ids=['hdmi', 'a1:b2:c3:d4:e5:f6', '/dev/input/event3'], auto_discover=False, grab_devices=False, list_devices=False, log_to_file=False, log_path=/var/log/bluetooth_2_usb/bluetooth_2_usb.log, debug=True, version=False
23-12-16 15:52:21 [DEBUG] Logging to stdout
23-12-16 15:52:21 [INFO] Launching Bluetooth 2 USB v0.8.0
23-12-16 15:52:21 [INFO] Discovering input devices...
23-12-16 15:52:21 [DEBUG] Relaying devices with matching name "hdmi" or MAC "a1:b2:c3:d4:e5:f6" or path "/dev/input/event3"
23-12-16 15:52:21 [DEBUG] Initializing USB gadgets...
23-12-16 15:52:24 [DEBUG] Enabled USB gadgets: [mouse gadget (/dev/hidg0), keyboard gadget (/dev/hidg1), consumer control gadget (/dev/hidg2)]
23-12-16 15:52:24 [INFO] Activated relay for device /dev/input/event2, name "AceRK Mouse", phys "0a:1b:2c:3d:4e:5f"
23-12-16 15:52:24 [INFO] Activated relay for device /dev/input/event1, name "AceRK Keyboard", phys "0a:1b:2c:3d:4e:5f"
23-12-16 15:52:24 [INFO] Activated relay for device /dev/input/event0, name "vc4-hdmi", phys "vc4-hdmi/input0"
### Manually switched Pi's Bluetooth off ###
23-12-16 15:53:27 [CRITICAL] Connection to AceRK Keyboard lost [OSError(19, 'No such device')]
23-12-16 15:53:27 [CRITICAL] Connection to AceRK Mouse lost [OSError(19, 'No such device')]
### Manually switched Pi's Bluetooth back on ###
23-12-16 15:53:31 [INFO] Activated relay for device /dev/input/event2, name "AceRK Mouse", phys "0a:1b:2c:3d:4e:5f"
23-12-16 15:53:31 [INFO] Activated relay for device /dev/input/event1, name "AceRK Keyboard", phys "0a:1b:2c:3d:4e:5f"
23-12-16 15:54:20 [DEBUG] Received event at 1702738460.417525, code 04, type 04, val 458827 from AceRK Keyboard
23-12-16 15:54:20 [DEBUG] Received key event at 1702738460.417525, 104 (KEY_PAGEUP), down from AceRK Keyboard
23-12-16 15:54:20 [DEBUG] Converted evdev scancode 0x68 (KEY_PAGEUP) to HID UsageID 0x4B (PAGE_UP)
23-12-16 15:54:20 [DEBUG] Pressing PAGE_UP (0x4B) on keyboard gadget (/dev/hidg1)
23-12-16 15:54:20 [DEBUG] Received synchronization event at 1702738460.417525, SYN_REPORT from AceRK Keyboard
23-12-16 15:54:20 [DEBUG] Received event at 1702738460.466388, code 04, type 04, val 458827 from AceRK Keyboard
23-12-16 15:54:20 [DEBUG] Received key event at 1702738460.466388, 104 (KEY_PAGEUP), up from AceRK Keyboard
23-12-16 15:54:20 [DEBUG] Converted evdev scancode 0x68 (KEY_PAGEUP) to HID UsageID 0x4B (PAGE_UP)
23-12-16 15:54:20 [DEBUG] Releasing PAGE_UP (0x4B) on keyboard gadget (/dev/hidg1)
23-12-16 15:54:20 [DEBUG] Received synchronization event at 1702738460.466388, SYN_REPORT from AceRK Keyboard
23-12-16 15:54:34 [DEBUG] Received event at 1702738474.116380, code 04, type 04, val 786665 from AceRK Keyboard
23-12-16 15:54:34 [DEBUG] Received key event at 1702738474.116380, 115 (KEY_VOLUMEUP), down from AceRK Keyboard
23-12-16 15:54:34 [DEBUG] Converted evdev scancode 0x73 (KEY_VOLUMEUP) to HID UsageID 0xE9 (VOLUME_INCREMENT)
23-12-16 15:54:34 [DEBUG] Pressing VOLUME_INCREMENT (0xE9) on consumer control gadget (/dev/hidg2)
23-12-16 15:54:34 [DEBUG] Received synchronization event at 1702738474.116380, SYN_REPORT from AceRK Keyboard
23-12-16 15:54:34 [DEBUG] Received event at 1702738474.117192, code 04, type 04, val 786665 from AceRK Keyboard
23-12-16 15:54:34 [DEBUG] Received key event at 1702738474.117192, 115 (KEY_VOLUMEUP), up from AceRK Keyboard
23-12-16 15:54:34 [DEBUG] Converted evdev scancode 0x73 (KEY_VOLUMEUP) to HID UsageID 0xE9 (VOLUME_INCREMENT)
23-12-16 15:54:34 [DEBUG] Releasing VOLUME_INCREMENT (0xE9) on consumer control gadget (/dev/hidg2)
23-12-16 15:54:34 [DEBUG] Received synchronization event at 1702738474.117192, SYN_REPORT from AceRK Keyboard
23-12-16 15:54:36 [DEBUG] Received event at 1702738476.895033, code 04, type 04, val 589826 from AceRK Mouse
23-12-16 15:54:36 [DEBUG] Received key event at 1702738476.895033, 273 (BTN_RIGHT), down from AceRK Mouse
23-12-16 15:54:36 [DEBUG] Converted evdev scancode 0x111 (BTN_RIGHT) to HID UsageID 0x02 (RIGHT)
23-12-16 15:54:36 [DEBUG] Pressing RIGHT (0x02) on mouse gadget (/dev/hidg0)
23-12-16 15:54:36 [DEBUG] Received synchronization event at 1702738476.895033, SYN_REPORT from AceRK Mouse
23-12-16 15:54:36 [DEBUG] Received event at 1702738476.943781, code 04, type 04, val 589826 from AceRK Mouse
23-12-16 15:54:36 [DEBUG] Received key event at 1702738476.943781, 273 (BTN_RIGHT), up from AceRK Mouse
23-12-16 15:54:36 [DEBUG] Converted evdev scancode 0x111 (BTN_RIGHT) to HID UsageID 0x02 (RIGHT)
23-12-16 15:54:36 [DEBUG] Releasing RIGHT (0x02) on mouse gadget (/dev/hidg0)
23-12-16 15:54:36 [DEBUG] Received synchronization event at 1702738476.943781, SYN_REPORT from AceRK Mouse
23-12-16 15:54:37 [DEBUG] Received relative axis event at 1702738477.675038, REL_X from AceRK Mouse
23-12-16 15:54:37 [DEBUG] Moving mouse gadget (/dev/hidg0) (x=125, y=0, mwheel=0)
23-12-16 15:54:37 [DEBUG] Received synchronization event at 1702738477.675038, SYN_REPORT from AceRK Mouse
^C23-12-16 15:54:50 [INFO] Received signal: SIGINT, frame: <frame at 0xb5ec9930, file '/usr/lib/python3.11/selectors.py', line 468, code select>
23-12-16 15:54:50 [CRITICAL] vc4-hdmi was cancelled
23-12-16 15:54:50 [CRITICAL] AceRK Keyboard was cancelled
23-12-16 15:54:50 [CRITICAL] AceRK Mouse was cancelled



Still not resolved? Double-check the installation instructions


For more help, open an issue in the GitHub repository


8.5. Everything is working, but can it help me with Bitcoin mining?
Absolutely! Here's how.
9. Bonus points
After successfully setting up your Pi as a HID proxy for your Bluetooth devices, you may consider making Raspberry Pi OS read-only. That helps preventing the SD card from wearing out and the file system from getting corrupted when powering off the Raspberry forcefully.
10. Contributing
Contributions are welcome! Please read the CONTRIBUTING.md file for guidelines.
11. License
This project is licensed under the MIT License - see the LICENSE file for details.
"Bluetooth 2 HID" image @PixelGordo is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.

12. Acknowledgments

Mike Redrobe for the idea and the basic code logic and HeuristicPerson's bluetooth_2_hid based off this.
Georgi Valkov for python-evdev making reading input devices a walk in the park.
The folks at Adafruit for CircuitPython HID and Blinka providing super smooth access to USB gadgets.
Special thanks to the open-source community for various other libraries and tools.