https://github.com/lupin3000/bulldog
Python USB OTG HID (Keyboard) for Raspberry PI Zero (and other)
https://github.com/lupin3000/bulldog
keyboard python3-keyboard raspberry-pi-zero raspberry-pi-zero-wh-keyboard usb-hid usb-keyboard usb-otg
Last synced: about 1 year ago
JSON representation
Python USB OTG HID (Keyboard) for Raspberry PI Zero (and other)
- Host: GitHub
- URL: https://github.com/lupin3000/bulldog
- Owner: Lupin3000
- Created: 2021-04-23T12:29:56.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-04-27T06:55:17.000Z (about 5 years ago)
- Last Synced: 2025-01-26T13:31:55.269Z (over 1 year ago)
- Topics: keyboard, python3-keyboard, raspberry-pi-zero, raspberry-pi-zero-wh-keyboard, usb-hid, usb-keyboard, usb-otg
- Language: Python
- Homepage: https://softwaretester.info
- Size: 231 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BullDog
Python USB OTG HID (_Keyboard_) for Raspberry PI Zero (_and other_)
> Inspired by [RubberDucky](https://shop.hak5.org/products/usb-rubber-ducky-deluxe), [O.MG cable](https://mg.lol/blog/omg-cable/) and other nice tools (_e.g. [Cactus WHID](https://github.com/whid-injector/WHID), BadUSB_), I created this Python3 BullDog cli tool.
> As I was a little unhappy with the DuckyScript and WHID syntax, I developed the new [Barking syntax](https://github.com/Lupin3000/BullDog#the-barking-script) (_which is very similar_).
## Preparation
If you need to create a USB OTG HID, [here](https://github.com/Lupin3000/Raspberry-PI-Tutorials) you will find all information (_for Raspberry PI Zero_).
```shell
# install git and pip (Python 3.x)
$ sudo apt install git python3-pip
```
## Usage
```shell
# clone repository
$ git clone https://github.com/Lupin3000/BullDog.git
# change into cloned directory
$ cd BullDog/
# install via pip3 (system wide or virtualenv)
$ pip3 install .
# show help (optional)
$ bulldog -h
# execute barking script
$ bulldog -b examples/macOS/woof.txt
# execute barking script with default delay
$ bulldog -b examples/macOS/woof.txt -d 0.05
# just test barking script (no need for /dev/hidg0)
$ bulldog -b examples/macOS/woof.txt -t
# write some string directly
$ bulldog --text "who am i" -t
# write some command directly
$ bulldog --command "GUI SPACE" -t
```
> **Note:** `-b|--barking`, `--text` and `--command` cannot be used together!
## The Barking script
Example of the barking script `woof.txt` (_simple text file_)...
```
# This is a simple barking script example for macOS
#
# ,--._______,-.
# ,',' , . ,_`-.
# / / ,' , _` ``. | )
# (,';'""`/ '"`-._ ` \/
# : ,o.-`- ,o. )\` -'
# : , d8b ^-. '| `
# |/ __:_ `. | ,
# | ( ,-.`-. ;' ;
# | | , `. /
# `-'`:::._,`.__),'
#
[CMD] GUI SPACE
[DELAY] 1.0
Terminal
[CMD] ENTER
[DELAY] 1.0
who am i
[CMD] ENTER
```
- Comment starts with a `#`
- Specific delays do start with `[DELAY]` and value is in milliseconds
- Standard and/or Shifted keystrokes are just written
- Commands and/or Modifier start with `[CMD]`
### Supported Keyboard Keys
**Standard/Shifted Keys**
Decimals from 4 till 39, 44, 45 till 56
**Modifier Keys**
- LEFT_CONTROL or RIGHT_CONTROL (_or simply **CONTROL**_)
- LEFT_SHIFT or RIGHT_SHIFT (_or simply **SHIFT**_)
- LEFT_ALT or RIGHT_ALT (_or simply **ALT**_)
- LEFT_GUI or RIGHT_GUI (_or simply **GUI** or **WIN**_)
**Command Keys**
ENTER, ESCAPE, BACKSPACE, TAB, SPACE, CAPS_LOCK, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, PRINT, SCROLL_LOCK,
PAUSE, INSERT, HOME, PAGE_UP, DELETE, END, PAGE_DOWN, RIGHT_ARROW, LEFT_ARROW, DOWN_ARROW, UP_ARROW, LEFT_CONTROL,
LEFT_SHIFT, LEFT_ALT, LEFT_GUI, RIGHT_CONTROL, RIGHT_SHIFT, RIGHT_ALT, RIGHT_GUI
**Keypad Keys**
Maybe some time later ;)
## ToDo's
- Add triple and quadruple keystrokes