OpenRemoteHub is a universal remote hub running on a Raspberry PI. It translates keyboard presses into commands for remote controlled devices. It's goal is to provide a single way for controlling remote controlled devices via a remote control.
| Feature | Progress |
|---|---|
| IR Support | Working |
| Bluetooth Support | Not Working |
| ADB Support | Not Working |
| curl | Not Working |
| app calls | Not Working |
OpenRemoteHub runs on a Raspberry Pi with an IR interface.
$ date
Mon 20 Nov 21:45:44 PST 2023
$ neofetch --ascii_distro debian_small
_____ OS: Debian GNU/Linux 12 (bookworm) aarch64
/ __ \ Host: Raspberry Pi 4 Model B Rev 1.2
| / | Kernel: 6.1.0-rpi6-rpi-v8
| \___- Memory: 112MiB / 3792MiB
-_
--_ssh to the raspberry pi and run the below. This has only been tested on a newly flashed Raspberry Pi 4 with the tested version noted above.
curl https://raw.githubusercontent.com/benjaminmetzler/OpenRemoteHub/main/setup_pi4.sh | bashThis will update the system, install the needed packages, configure lirc, and set up the system to run OpenRemoteHub.
If you don't feel safe running a random script from the Internet:
- Flash a raspian image with the tested version listed above.
- Make sure to enable ssh as a directly connected keyboard could be captured by OpenRemoteHub.
- Insert the SD card into the raspberry pi and power it up.
- Connect to the pi with ssh.
- Update the pi and install git.
sudo apt update; sudo apt -y upgrade; sudo apt install -y git
- Clone the repo.
git clone https://github.com/benjaminmetzler/OpenRemoteHub.git
- Change into the local directory
cd OpenRemoteHub
- Run the setup. The pi will reboot after the script has finished.
sh setup_pi4.sh
- Connect to the pi with ssh.
- cd into the OpenRemoteHub directory and run main.sh
cd OpenRemoteHub; bash main.sh
OpenRemoteHub will start and listen for keystrokes from a directly connected keyboard. Depending on the keystroke, OpenRemoteHub will take different actions. When first booted, it will load the json/common.json file.
OpenRemoteHub takes input from a keyboard or an HID remote and converts it into an appropriate format. OpenRemoteHub uses json files to it's current state. Each state defines the actions that OpenRemoteHub takes when an HID button is pressed. The format of these json files is documented here.
Pull requests are welcome. Help with enabling the Raspberry Pi as a functional bluetooth HID to an android device (think Nvidia Shield or Apple TV) is greatly appreciated. For major changes, please open an issue first to discuss what you would like to change.
The code is written with VSCode in mind. It has a configuration set up in the .vscode directory that allows for debugging. To do development, take the following steps:
- Run the prep command:
./prep. This will:- Create a virtual environment
- Install the requirement.txt into the venv
- Install pre-commit pre-commit hook
- Activate the virtual env for your development:
source venv/bin/activate
Please ensure that any PRs pass pre-commit.
I want to move OpenRemoteHub into a container to avoid having to build everything into the OS. The main issue with this is that the HID based USB remote controls get picked up by the kernel, as shown below, preventing it from being controlled by the container:
ben@scratch:~ $ sudo dmesg -c
[ 898.433073] usb 1-1.1.3: USB disconnect, device number 4
[ 900.132667] usb 1-1.1.3: new full-speed USB device number 8 using dwc_otg
[ 900.277177] usb 1-1.1.3: New USB device found, idVendor=0c40, idProduct=7a1c, bcdDevice= 2.00
[ 900.277216] usb 1-1.1.3: New USB device strings: Mfr=1, Product=2, SerialNumber=0
[ 900.277236] usb 1-1.1.3: Product: SG Control Mic
[ 900.277253] usb 1-1.1.3: Manufacturer: SG.Ltd
[ 900.311884] input: SG.Ltd SG Control Mic Keyboard as /devices/platform/soc/3f980000.usb/usb1/1-1/1-1.1/1-1.1.3/1-1.1.3:1.2/0003:0C40:7A1C.0009/input/input11
[ 900.373615] hid-generic 0003:0C40:7A1C.0009: input,hidraw0: USB HID v1.01 Keyboard [SG.Ltd SG Control Mic] on usb-3f980000.usb-1.1.3/input2
[ 900.377430] input: SG.Ltd SG Control Mic as /devices/platform/soc/3f980000.usb/usb1/1-1/1-1.1/1-1.1.3/1-1.1.3:1.3/0003:0C40:7A1C.000A/input/input12
[ 900.377897] hid-generic 0003:0C40:7A1C.000A: input,hidraw1: USB HID v1.01 Mouse [SG.Ltd SG Control Mic] on usb-3f980000.usb-1.1.3/input3
The hid-generic is built into the kernel, so there doesn't appear to be a way to disable it without recompliling the kernel entirely. As a result, the RF remotes that emulate keyboards will always get attached to the kernel, preventing it from being controlled by a docker container...At least as far as I can tell.
I'd like to use a plugin architecture for handling the way signals are sent from the OneRemoteHub. For instance, instead of a series of if statements, the command_processor would load plugins for ir, bluetooth, etc., which would handle the sending of the command. This would allow other contributers to add to the transmission options without messing with the main code body.
- https://www.raspberrypi.org/
- https://www.lirc.org
- https://github.com/AnaviTechnology/anavi-docs/blob/master/anavi-infrared-phat/anavi-infrared-phat.md
- https://globalcache.zendesk.com/hc/en-us/articles/360034968311-iConvert-Converting-IR-code-formats
- https://www.instructables.com/Transforming-Raspberry-Pi-Into-a-Remote-Control/
- https://projects-raspberry.com/emulate-a-bluetooth-keyboard-with-the-raspberry-pi/
- https://flirc.tv/more/flirc-usb
- https://github.com/ruundii/bthidhub
- https://github.com/quangthanh010290/keyboard_mouse_emulate_on_raspberry