Git Product home page Git Product logo

android-hid-client's Introduction

Contributors Forks Stargazers Issues GPL-3.0 License


App Icon

USB HID Client

Android app that allows you to easily use your phone as a keyboard
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgments

About The Project

Main screen Main screen with menu open Help screen with frequently asked questions

This Android app allows you to use your phone as a keyboard by communicating with /dev/hidg0, a character device that allows your phone to send keys to a connected host device. It presents itself as a standard hardware input device and therefore doesn't require any additional software to be installed on the computer. It is also completely functional within the connected computer's BIOS/UEFI. This app supports most standard keyboard keys, including a-z, 0-9, `~! @#$%^&*()_+{}|:"><,.;'[]=-, function keys, SysRq/Print Screen, and several more (I strongly recommend using Hacker's Keyboard to use special keys such as modifier and function keys).

Disclaimer: This app requires your device to be rooted.

Tested primarily on: Linux (Host computer) and Pixel 5 running Android 13.

(back to top)

Getting Started

Prerequisites

  • Rooted device running Android
    • Only specific root methods are supported, because I need to patch SELinux policy at runtime and am using provided tools to do so. if your root method isn't on this list and provides a method for live-patching SELinux policy, feel free to create an issue.
      • Magisk: magiskpolicy
      • KernelSU: ksud sepolicy patch
    • Android version that I currently test with: 14
  • Soft Keyboard
    • I test the app with Gboard and Hacker's keyboard, but Hacker's keyboard is the one with better support, more keys, and less issues .
    • Important Hacker's Keyboard settings to change:
      • Key behavior settings > Ctrl key code = None (Ignored when not modifying other keys)
      • Key behavior settings > Alt key code = None (Ignored when not modifying other keys)
      • Key behavior settings > Meta key code = None (Ignored when not modifying other keys)

Installation (Source)

Clone the repository.

git clone https://github.com/Arian04/android-hid-client.git

import into Android Studio, build the APK, then install it on your Android device.

Installation (Binary)

Download the APK file from the Github releases page, then install it on your Android device

(back to top)

Usage

Typing in the "Direct Input" text box will immediately relay the keys that you press to the connected device. The keys will not be displayed in the text box as you type them.

Typing in the "Manual Input" text box will send all the characters that you've typed into the box to the connected device once you hit the "send" button.

Some Use Cases

  • Quickly be able to change BIOS/UEFI settings of a computer when you don't have a keyboard with you
  • Typing a long string (such as a password or IP address) into a console

(back to top)

Roadmap

  • Keyboard support
  • Add some special key buttons to the UI (like multimedia keys)
  • Touchpad support
  • Ability to send string all at once
  • Add full settings page
  • Add prompt to create /dev/hidgX if not present

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU GPLv3 License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

(back to top)

android-hid-client's People

Contributors

arian04 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.