README.md

dwarfAlp documentation

Choose the path that matches what you want to do. The root README is the shortest project overview.

New users

• Install dwarfAlp
• Complete the first run
• Use the Windows Control Center
• Test without hardware
• Connect NINA
• Solve a problem

Advanced users

• Supported device models
• Configuration reference
• Wi-Fi and BLE provisioning
• Capture behavior

Developers

• Development setup
• Testing and hardware-test safety
• Architecture
• Protobuf generation
• Windows releases and GitHub Pages
• Contributing

Protocol researchers

• Research and evidence guide
• DWARF protocol reference
• APK analysis
• Firmware analysis
• Engineering audit
• Historical integration plan
• Raw reference artifacts
• Generated API Observatory

Directory conventions

• scripts/ contains repository generation and maintenance commands.
• tools/ contains standalone firmware/protocol investigation utilities.
• docs/site/ is the publishable Pages site. Its JSON data is generated by scripts/generate_api_site.py; the HTML, CSS, and JavaScript shell is authored.
• firmware-analysis/metadata/ contains small, curated evidence. Extracted firmware, decompiler workspaces, original firmware archives, runtime state, and builds are intentionally ignored.