https://github.com/geo-tp/esp32-bus-pirate

A Hardware Hacking Tool with Web-Based CLI That Speaks Every Protocol
https://github.com/geo-tp/esp32-bus-pirate

debugging esp32 hardware-hacking protocol

Last synced: 5 months ago
JSON representation

A Hardware Hacking Tool with Web-Based CLI That Speaks Every Protocol

• Host: GitHub
• URL: https://github.com/geo-tp/esp32-bus-pirate
• Owner: geo-tp
• License: mit
• Created: 2025-07-05T21:59:46.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-07-20T23:23:45.000Z (5 months ago)
• Last Synced: 2025-07-21T01:12:26.196Z (5 months ago)
• Topics: debugging, esp32, hardware-hacking, protocol
• Language: C++
• Homepage: https://github.com/geo-tp/ESP32-Bus-Pirate/wiki
• Size: 25.9 MB
• Stars: 161
• Watchers: 2
• Forks: 18
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ESP32 Bus Pirate

**ESP32 Bus Pirate** is an open-source firmware that turns your device into a multi-protocol hacker's tool, inspired by the [legendary Bus Pirate](https://buspirate.com/).

It supports sniffing, sending, scripting, and interacting with various digital protocols (I2C, UART, 1-Wire, SPI, etc.) via a serial terminal or web-based CLI.

![Demo showing the different mode of the ESP32 Bus Pirate](images/demo.gif)

## Features

- Interactive command-line interface (CLI) via **USB Serial or WiFi Web**.

- **Modes for:**

  - HiZ (default)

  - I2C

  - SPI

  - UART / Half-Duplex UART

  - 1-WIRE

  - 2WIRE / 3WIRE (planned)

  - DIO (Digital I/O)

  - Infrared (device-b-gone, send and receive)

  - USB (HID, mouse, keyboard, gamepad, storage)

  - Bluetooth (BLE HID, scan, spoofing, sniffing)

  - Wi-Fi (scan, AP, connect, sniff, spoofing)

  - JTAG

  - LED control

  - I2S

- **Protocol sniffers** for I2C, Wi-Fi, Bluetooth, 1Wire.

- Baudrate **auto-detection** and various tools for UART.

- Scripting using **Bus Pirate-style bytecode** instructions.

- Direct I/O management, PWM, pin state.

- Massive infrared protocol support.

- Massive adressable LEDs protocol support.

- Web interface with **live terminal**, or a classic **serial CLI**.

## Supported Devices

- **M5 Cardputer**

![An M5 Stack Cardputer device](images/cardputer.jpg)

- **M5 Stick C Plus 2**

![An M5 Stick C Plus 2 device](images/m5stick.jpg)

- **M5 Stamp S3**

![An M5stampS3 micro controller](images/stamps3.jpg)

## Wiki

📚 Visit the **[Wiki](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki)** for detailed documentation on every mode and command.

Includes:

- [Terminal mode](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/00-Terminal) - About serial and web terminal.

- [Mode overviews](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki) - Browse supported modes.

- [Instruction syntax](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/99-Instructions) - Master the instructions.

- [Serial setup](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/99-Serial) - Serial access via USB.

- [Python scripting examples](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/99-Python) - Automate tasks using Python.

The wiki is the best place to learn how everything works.

## Getting Started

1. 🔧 Flash the firmware  

   - Download the latest release from the [Releases](https://github.com/geo-tp/ESP32-Bus-Pirate/releases) page, and flash it using your favorite tool (`esptool.py`, `PlatformIO`, etc.).

   - You can also burn it on [M5Burner](https://docs.m5stack.com/en/download), in the M5stick or Cardputer category.

2. 🔌 Connect via Serial or Web

   - Serial: any terminal app (see [Connect via Serial](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/99-Serial))

   - Web: configure Wi-Fi and access the CLI via browser

3. 🧪 Use commands like:

   ```bash

   mode

   help

   scan

   sniff

   ...

    ```

   See detailed explanations about [Terminal Commands](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki) and how each one works.

   

## ESP32 Bus Pirate on M5 Devices

![ESP32 Bus Pirate running on M5 Stack devices](images/buspirate_s.jpg)

## Web & Serial Interfaces

The ESP32 Bus Pirate firmware provides two command-line interface (CLI) modes:

| Interface         | Advantages                                                                 | Ideal for...                          |

|------------------|-----------------------------------------------------------------------------|----------------------------------------|

| **Web Interface** | - Accessible from any browser
- Works over Wi-Fi
- No cables needed | Quick tests, demos, headless setups   |

| **Serial Interface** | - Faster performance
- Instant responsiveness
- Handles large data smoothly | Intensive sessions, frequent interactions |

Both interfaces share the same command structure and can be used interchangeably.

![An iPhone screenshot showing Bus Pirate web cli](images/mobile_s.jpg)

## Using the ESP32 Bus Pirate to speak UART over WiFi

![Using the ESP32 Bus pirate with UART](images/demo2.gif)

## Warning

> ⚠️ **Voltage Warning**: Devices should only operate at **3.3V** or **5V**.  

> Do **not** connect peripherals using other voltage levels — doing so may **damage your ESP32**.