Welcome to WHAD’s documentation!

General documentation

• Introduction
  • What is WHAD ?
  • Main concepts behind WHAD
• Installation
  • System dependencies
  • Installing WHAD with pip
  • Installing WHAD from our Github repository
  • Installing rules for WHAD-compatible devices
  • Flashing firmware on WHAD-compatible devices
  • Installing WHAD in a virtual machine
• WHAD communication protocol
  • Main concepts behind our protocol
  • Protocol definition
• Compatible devices
  • Hardware devices
  • Virtual devices
  • Makerdiary nRF52840 MDK USB Dongle
  • Nordic nRF52840 Dongle
  • SeeedStudio LoRa-e5-Mini
  • STM32WL55 Nucleo board
  • Espressif ESP32-WROOM
• Command-line tools
  • Generic tools
  • Bluetooth Low Energy tools
  • Logitech Unifying tools
  • Tool chaining and packet processing chain
• Whad protocol stack model
  • Generic stack layer
  • Creating a protocol stack layer
  • Protocol stack instantiation
  • Contextual layers
  • Visualizing a stack
  • Testing protocol layers
• Whad generic stack model reference
  • Decorators
  • Layer classes
  • Unit testing

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