This repository is for developing the USB analyzer mode of Cynthion.
It includes several other projects as submodules to aid with making changes across all of them:
To set up the environment and build everything:
make
To update Apollo on an attached Cynthion:
make flash-apollo
To update analyzer gateware on an attached Cynthion:
make flash-analyzer
To run Packetry:
./packetry
If you make changes to any of the submodules, they should be picked up automatically when you run make
.
This works because:
- It always runs
make
for the Apollo firmware. - It always runs
cargo build
for Packetry. - All Python submodules are installed in editable mode.
- All Python files the gateware depends on are detected and saved in
analyzer.deps
using this trick, so if any of them change, the gateware will be automatically rebuilt.
Still, this is probably not completely foolproof, so if you want to clean up and start from scratch just run:
make clean
Note that this does not run cargo clean
for Packetry, because Cargo's own caching works well, and the Rust dependencies take a long time to build.