Logo

General documentation

  • Introduction
  • Installation
  • WHAD communication protocol
  • Compatible devices
  • Command-line tools
  • Whad protocol stack model
  • Whad generic stack model reference

PHY API

  • Getting started
  • Sniffer connector
  • Sniffer configuration classes
  • Derived PHY connectors

Bluetooth Low Energy API

  • Getting started
  • Device Scanning
  • Central role
  • Peripheral role
  • Device Model
  • Exceptions

IEEE 802.15.4 API

  • Getting started

ZigBee API

  • Getting started
  • ZigBee Coordinator connector
  • ZigBee End device connector

LoRaWAN API

  • Getting started
  • LoRaWAN Gateway emulation
  • LoRaWAN connector
  • Channel Plan

Enhanced ShockBurst API

  • Getting started
  • Primary Receiver (PRX) connector
  • Primary Transmitter (PTX) connector
  • Scanner connector
  • Sniffer connector

Logitech Unifying API

  • Getting started
  • Sniffer connector
  • Mouse connector
  • Keyboard connector

Contributing

  • Developing a WHAD compatible firmware

Python API Reference

  • Devices and connectors
  • Packet monitors
WHAD
  • Overview: module code

All modules for which code is available

  • whad.ble.connector.central
  • whad.ble.connector.peripheral
  • whad.ble.connector.scanner
  • whad.ble.exceptions
  • whad.ble.profile
    • whad.ble.profile.attribute
    • whad.ble.profile.characteristic
    • whad.ble.profile.device
    • whad.ble.profile.service
    • whad.ble.profile.services.bas
    • whad.ble.profile.services.dis
    • whad.ble.profile.services.hr
  • whad.ble.scanning
  • whad.ble.stack.att.exceptions
  • whad.common.monitors.pcap
  • whad.common.monitors.wireshark
  • whad.common.stack.layer
  • whad.common.stack.tests
  • whad.device.connector
  • whad.device.device
  • whad.esb.connector.prx
  • whad.esb.connector.ptx
  • whad.esb.connector.scanner
  • whad.esb.connector.sniffer
  • whad.lorawan.channel
  • whad.lorawan.connector
  • whad.phy.connector.lora
  • whad.phy.connector.sniffer
  • whad.phy.sniffing
  • whad.unifying.connector.keyboard
  • whad.unifying.connector.mouse
  • whad.unifying.connector.sniffer
  • whad.zigbee.connector.coordinator
  • whad.zigbee.connector.enddevice

© Copyright 2026, Damien Cauquil, Romain Cayre.

Built with Sphinx using a theme provided by Read the Docs.