A HomeBridge plugin to control remote ADB enabled Android device. The idea is to make random Android based TV box can be controlled with Home App. It make any Android device appear as TV accesory. Where you can control on/off status, volume and dpad control via Control Center remote, and launch certain predefined app defined in the configuration.
This plugins register it self as external accesorries. Make sure after adding Homebridge bridge in Home App, manually "add accesories" to add the android device in the Home App.
![]() |
![]() |
![]() |
![]() |
---|
Install Homebridge, Homebridge Config UI X (this plugin support web configuration over there), and this plugins
sudo npm install -g --unsafe-perm homebridge homebridge-config-ui-x
sudo npm install homebridge-adb
Install ADB tools inside Homebridge server. Open Homebridge Config UI X in your browser then navigate to terminal or ssh to your homebridge server, and then run this command:
sudo apt-get install android-tools-adb android-tools-fastboot
adb --version
This will output something like Android Debug Bridge version x.x.x
Enable remote developer mode in your Android device. Visit this documentation for more information https://developer.android.com/studio/debug/dev-options
IMPORTANT: Some Android device doesn't support "Remote ADB" by default. If your device is one of them, connect your device with USB cable to any computer with ADB installed. Open terminal and run this command:
adb tcpip 5555
if no error produced, disconnect unplug the USB cable from the computer.
OPTIONAL Run this command to make sure you can connect to device:
adb connect your-device-ip
If all goes well, there will be a popup window in your android device asking for debug permission. After you accept the request, you might want to do kill the adb server to make a fresh connection
adb kill-server
After that reconnect your device again with previous adb connect. Test your adb connection by running this command:
adb -s your-device-ip shell "getprop ro.product.model"
This command will output your device model.
MANDATORY If you're using a container based on Alpine Linux (like oznu/docker-homebridge:latest
), run this command in terminal to install adb
# Install adb, required by the homebridge-adb plugin
echo 'http://dl-cdn.alpinelinux.org/alpine/v3.14/main/' >> /etc/apk/repositories
echo 'http://dl-cdn.alpinelinux.org/alpine/v3.14/community/' >> /etc/apk/repositories
apk add android-tools
You can use other version of repo, but I only tested the v3.14 repo, and it seems it's the only adb tools that work with oznu/docker-homebridge .
MANDATORY If you're using a container based on Debian (like the oznu/docker-homebridge:ubuntu
& oznu/docker-homebridge:debian
docker image), run this command in terminal to install adb
# Update apt package index
apt-get update
# Install adb, required by the homebridge-adb plugin
apt-get install -y android-tools-adb android-tools-fastboot
OPTIONAL Append the followings line to your config/startup.sh
to install or update this plugin on every container restart:
# Install the homebridge-adb plugin
npm install homebridge-adb
OPTIONAL If you run into issues when connecting your android device (sometimes adb can't create the $HOME/.android/adbkey
), add this line to your config/startup.sh
:
# Fix connection issues for the homebridge-adb plugin
adb connect YOUR_ANDROID_DEVICE_IP
Here an example of configuration that you can use.
"platforms": [
{
"platform": "HomebridgeADB",
"accessories": [
{
"name": "NVIDIA Shield",
"interval": 1000,
"ip": "192.168.1.1",
"path": "/usr/bin/adb",
"timeout": 1000,
"playbacksensor": true,
"playpauseobutton": "KEYCODE_MEDIA_PLAY_PAUSE",
"backbutton": "shell sh ./myscript.sh",
"infobutton": "KEYCODE_HOME KEYCODE_HOME",
"category": "TV_STREAMING_STICK",
"hidenumber": true,
"hidehome": true,
"hideother": true,
"debug": true,
"skipSpeaker": false,
"inputs": [
{
"name": "HBO Max",
"id": "com.hbo.hbonow"
},
{
"name": "Apple Music",
"id": "com.apple.android.music"
}
]
},
{
"name": "Meizu",
"ip": "192.168.1.2",
"playbacksensor": false,
"mac": "97:b6:e8:46:9f:cb",
"inputs": [
{
"name": "Termux",
"id": "com.termux",
"adb": "monkey -p com.termux 1"
}
]
}
]
}
]
monkey -p com.app.id 1
. This is an ADB shell command, so you doesn't need to type "adb -s ipaddress shell ...".volumeup: "KEYCODE_VOLUME_UP KEYCODE_VOLUME_DOWN"
. See https://developer.android.com/reference/android/view/KeyEvent for the keycode list. Or,leftbutton: "monkey -p com.termux 1"
. Or,shell
identifier to let the plugins know it's a shell script, eg: volumeup: "shell sh ./myscript.sh"
.infobutton: "com.google.android.youtube.tv"
.dumpsys power
value to determine its state. Define your own adb shell command based on your device. eg: dumpsys power | grep mWakefulness=
Awake
If you're using Homebridge Config UI X, you can configure your device there, but there's a small hiccup with Inputs. It only display one input, but if you press add, it will display the rest of the inputs.
If your have any question, refer to FAQ.md first before sending GitHub issues.
If want to support this plugin, you can buy me an Ice cream by follow this link. Or feel free to share and stared this repo.
There is currently an Android TV homebridge plugins that work with "Android TV remote control protocol version 2", it should have simpler setup. You can check the plugin here and see if it's work with your device. However, it will only work with Android TV devices, not every Android devices. Note: I'm not the contributor of the that plugin.