amateurgod/adb_server repository overview

⁠Amateur-God's ADB-Server Home assistant Addon

⁠About

Welcome to Amateur-God's Home Assistant Add-ons. This repository hosts the ADB-Server add-on, which provides an Android Debug Bridge (ADB) server for Home Assistant, including an ingress terminal for executing commands.

⁠Add-ons

⁠ADB-Server Add-on

The ADB-Server add-on allows you to connect and control your Android devices from within Home Assistant. This is useful for automating tasks and integrating Android devices into your smart home setup.

⁠Usage

⁠Prerequisites

• Ensure you have Home Assistant installed.
• Make sure your Android devices have ADB debugging enabled.
  • On the Android device, go to Settings > About phone and tap Build number seven times to enable developer mode.
  • Go to Settings > Developer options and enable USB debugging or Wireless debugging.

⁠Installation

1. Add the Repository to Home Assistant:

   • In Home Assistant, go to Supervisor > Add-on Store.
   • Click the three-dot menu at the top right and select Repositories.
   • Add the following URL: https://github.com/Amateur-God/Hassio-Addons.

2. Install the ADB-Server Add-on:

   • Find the ADB-Server add-on in the list and click on it.
   • Click on the Install button.

3. Configure the Add-on:

   • Go to the Configuration tab.
   • Edit the config.json to include the IP addresses of your Android devices and any other required configuration. For example:

     {
       "devices": [
         {
           "name": "Living Room TV",
           "ip": "192.168.1.100"
         },
         {
           "name": "Bedroom Tablet",
           "ip": "192.168.1.101"
         }
       ],
       "additional_config": "your_additional_config_here"
     }
     

     Copy
   • Save the configuration.

4. Start the Add-on:

   • Go to the Info tab and click the Start button.
   • Optionally, enable the Start on boot option to ensure the add-on starts automatically when Home Assistant starts.

5. Access the Ingress Terminal:

   • Once the add-on is running, click on Open Web UI to access the ingress terminal.
   • You can now execute ADB commands directly from the terminal.

⁠Example Commands

• List Connected Devices:

  adb devices
  

  Copy

• Install an APK:

  adb -s <device_ip> install /path/to/app.apk
  

  Copy

• Send a Key Event:

  adb -s <device_ip> shell input keyevent 26  # Power button event
  

  Copy

• Reboot the Device:

  adb -s <device_ip> reboot
  

  Copy

⁠Support

Got questions or need help?

• The The Viking Studios chat server⁠ for general Home Assistant discussions and questions.

You can open an issue here⁠ on GitHub.

⁠Contributing

We welcome contributions from the community. If you would like to contribute, please read our contribution guidelines⁠.

Thank you for your interest and contributions! :heart_eyes:

⁠Authors & Contributors

This repository is maintained by Amateur-God⁠. For a full list of all authors and contributors, check the contributor's page⁠.

⁠License

GNU General Public License v3.0

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/⁠.