README

ESP32 Bit Pirate




ESP32 Bit Pirate is open-source firmware that turns your device into a multi-protocol development and analysis tool, inspired by the legendary Bus Pirate.

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. It also communicates with radio protocols like Bluetooth, Wi-Fi, Sub-GHz, LoRa and RFID.

The official project website centralizes everything: ESP32 Bit Pirate Website.

From there you can install the firmware, open the web tools, follow hardware guides, explore recipes, and access the documentation.

!Demo showing the different mode of the ESP32 Bit Pirate firmware
 
 Features

- Interactive command-line interface (CLI) via USB Serial or WiFi Web.
- Modes for:
   - HiZ (default)
   - I2C (scan, glitch, slave mode, dump, eeprom)
   - SPI (eeprom, flash, sdcard, slave mode)
   - UART / Half-Duplex UART (bridge, read, write)
   - 1WIRE (ibutton, eeprom)
   - 2WIRE (sniff, smartcard) / 3WIRE (eeprom)
   - DIO (Digital I/O, read, pullup, set, pwm)
   - Infrared (send, record, universal remote)
   - USB (HID, flashrom, storage, usb-uart)
   - Bluetooth (BLE HID, scan, spoofing, sniffing)
   - Wi-Fi / Ethernet (sniff, deauth, nmap, netcat)
   - JTAG (scan, SWD, openOCD)
   - LED (animations, set LEDs)
   - I2S (test speakers, mic, play sound)
   - CAN (sniff, send and receive frames)
   - SUBGHZ (analyze, record, replay)
   - RFID (read, write, clone)
   - RF24 (scan, send, receive)
   - FM (analyze, broadcast)
   - CELL (dump sim card, sms, call)
   - LORA (sniff, payload, meshtatic)


- Protocol sniffers I2C, UART, SPI, 1Wire, 2wire, CAN, Wi-Fi, Bluetooth, SubGhz.
- Baudrate auto-detection, AT commands and various tools for UART.
- Registers manipulation, EEPROM dump tools, identify devices for I2C.
- Read all sort of EEPROM, Flash and various others tools for SPI.
- Scripting using Bus Pirate-style bytecode instructions or Python.
- Infrared support with more than 80 protocols.
- Direct I/O management, PWM, servo, GPIOs state.
- Analyze radio signals and frequencies on every bands.
- Near than 50 addressable LEDs protocols supported.
- Pirate assistant to help you with the firmware.
- USB-Uart dongle, SPI programmer, logic analyzer, ESP-SDR and more.
- Web Serial tools to use USB Serial over a web browser.

 Supported Devices
All boards listed below offer the exact same Bit Pirate features, with no differences in functionality or development status. Some features may require additional hardware.

| Device               |                                     | Description                       |
|-----------------------|------------------------------------------|---------------------------------------------------|
| ESP32 S3 Dev Kit (N8, N8R2, N8R8, N16R8...)  | !Photo of the ESP32 S3 Dev Kit     | More than 20 available GPIO, 1 button |
| ESP32 S3 Zero / Super Mini  | !Photo of the ESP32 S3 SUPERMINI     | 15 GPIO (expo