HidProxy

KO | EN

gitlite — search

#react #typescript #go #android #rust #macos #nodejs #java #cli #kubernetes #security #pytorch #ios #open-source

(★ 9)

A firmware for RaspberryPi™ Pico W for making it act as an HID proxy dongle.

HidProxy Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Bluetooth<->USB HID Proxy

## Introduction

A firmware for RaspberryPi™ Pico W for making it act as an HID proxy dongle.

An HID proxy dongle is a device that acts as a proxy between a Bluetooth HID device (e.g.: keyboard, mouse, game-controller) and a USB host device.

The Bluetooth stack runs completely on the dongle itself, which makes it possible to use a Bluetooth HID device when there is no Bluetooth support on a host device (e.g.: when you need to enter a password before an operating-system boots, or to interact with the BIOS).

### Limitations
* It only supports "Bluetooth Classic" (BR/EDR) devices.

## User-Manual

### Pairing the Dongle with a Bluetooth HID Device
1. Open a text editor in the host device, and ensure the typing language of the host device is set to English and "Caps Lock" is off.
2. Hold the dongle's button (for no more than 5 seconds) while connecting the dongle to a USB port of the host.
3. Wait for being prompted to select a device to pair with.
4. Select the device to pair with using the dongle's button.

### Resetting the Dongle
Hold the dongle's button for 5 seconds while connecting the dongle to a USB port.\
The dongle will forget the paired device and all the saved data.

### LED Statuses
| Color  | Behavior              | Meaning                                                    |
|--------|-----------------------|------------------------------------------------------------|
| Blue   | Static                | The dongle is connected to a Bluetooth HID device.         |
| Blue   | Blinking indefinitely | The dongle is ready for a Bluetooth HID device connection. |
| Red    | Blinking indefinitely | The dongle is not paired with a Bluetooth HID device yet.  |
| Red    | Blinking for 1 second | The connected device must be paired again.                 |
| Yellow | Blinking indefinitely | The dongle is in configuration mode.                       |
| Yellow | Blinking for 1 second | The dongle has been reset.                                 |

## Building

Note: The following instructions are for Linux

### Prerequisites

1. Install the required packages:
   ```
   sudo apt install git sed cmake python3 build-essential gcc-arm-none-eabi libnewlib-arm-none-eabi libstdc++-arm-none-eabi-newlib
   ```
2. Navigate to the folder where you want to put the RaspberryPi™ Pico SDK at.
3. Clone the RaspberryPi™ Pico SDK (including all its submodules):
   ```
   git clone --recurse-submodule "https://github.com/raspberrypi/pico-sdk.git"
   ```
4. Add the SDK folder's path to the "PICO_SDK_PATH" environment-variable:
   ```
   echo "export PICO_SDK_PATH=\"$(pwd)/pico-sdk\"" >> ~/.bashrc && source ~/.bashrc
   ```
5. Fix naming collisions between the BTstack and TinyUSB libraries:
   ```
   find "$PICO_SDK_PATH/lib/btstack" -type f -exec sed -i 's/hid_report_type_t/btstack__hid_report_type_t/g' {} +
   find "$PICO_SDK_PATH/lib/btstack" -type f -exec sed -i 's/HID_REPORT_TYPE/BTSTACK__HID_REPORT_TYPE/g' {} +
   find "$PICO_SDK_PATH/lib/tinyusb" -type f -exec sed -i 's/hid_report_type_t/tusb__hid_report_type_t/g' {} +
   find "$PICO_SDK_PATH/lib/tinyusb" -type f -exec sed -i 's/HID_REPORT_TYPE/TUSB__HID_REPORT_TYPE/g' {} +
   ```

### Building the Firmware

1. Navigate to the folder where you want to put this repository at.
2. Clone this repository and enter the folder.
3. Build the firmware:
   ```
   ./build.sh
   ```
The firmware will be compiled into a UF2 file inside the 'build' folder. Just copy it into the emulated storage of the RaspberryPi™ Pico to flash it.

## Wiring
1. Connect a blue LED to pin 2.
2. Connect a yellow LED to pin 3.
3. Connect a red LED to pin 4.
4. Connect a button to pin 5.

## License

## Notices
* This firmware uses the following components and libraries:
  - [RaspberryPi™ Pico SDK](https://github.com/raspberrypi/pico-sdk).\
     Copyright © 2020 Raspberry Pi (Trading) Ltd.
  - [BTstack](https://github.com/bluekitchen/btstack).\
     Copyright © 2009 BlueKitchen GmbH.
  - [TinyUSB](https://github.com/hathach/tinyusb).\
     Copyright © 2018 hathach (tinyusb.org).
* RaspberryPi is a trademark of Raspberry Pi Ltd.

HidProxy

HidProxy Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

HidProxy

HidProxy Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README