gunkslab docs
gunkslab is fleet software for small robots: a message protocol over MQTT, simulated bots to build against before the real ones are wired, a station that runs the fleet, and a page in your browser to watch and drive from. It’s written for gl_zero first, a small desk bot still being designed, then Pirate Stage, then Soleil. Everything runs in containers on your own machine.
- Try it: the quickstart, a simulated fleet on your desk in about five minutes once it’s installed.
- Learn it: the tutorials, a course from the broker up, one command at a time.
- Build on it: the guides for tasks, and the reference for exact details.
| Section | What’s in it |
|---|---|
| Get started | Install, then a fleet on your desk in about five minutes |
| Tutorials | The course: lessons in order, each building on the last |
| Guides | One task each: flash a bot, put a real bot on the bench, run the bench programs |
| Concepts | Why it’s built the way it is: the architecture, safety, the protocol’s design |
| Primers | The technologies it’s built from, one page each in plain words: MQTT first |
| Reference | Exact details, to look up: the protocol, every script, the firmware, the codebase |
| Robots | The machines it runs on: Pirate Stage |
| Security | How the fleet is kept to the people meant to drive it: logins, every way in, what raises an alert, what’s still open |
| Project | The roadmap, and how to contribute |