Get started
gunkslab is software for running a fleet of small robots, and a course that teaches how it works, one piece at a time. It all runs in containers on your own computer. You don’t need a robot to start. Simulated bots stand in for real ones, and they talk to the rest of the fleet the same way a real one does.
The pieces:
- The broker. Every bot, and everything that talks to the bots, sends its messages through one MQTT broker.
- The bots. Each one drives where it’s told and reports what it sees. A simulated bot does it on a virtual desk.
- The station. It runs the fleet. Tell it where a bot should go, and it drives the bot there and keeps it out of the other bots’ way.
- The page. It shows the desk from above, each bot and its messages, in your browser, and lets you drive.
When you have a real bot on an ESP32, gunkslab’s firmware goes on it, and you drive it from the same page. The first real bot, gl_zero, a small desk bot, is still being designed.
It’s for anyone who wants to learn how a robot fleet works by running one, from a student to a developer. The tutorials start at the broker and end at a bot reading its own distance sensor, about four hours in all.
gunkslab Desk, everything on this site, is free and runs on your own machine. gunkslab Lab, for real bots on a school’s or lab’s network with classroom and research features, is planned.
To start, get gunkslab onto your machine, then see a fleet running before learning how it works.
- InstallGet the repo and check your container runtime. PlatformIO too, once you have a real board
- QuickstartA simulated fleet on your desk in about five minutes once it's installed. One command, then drive from the browser
- Known issuesWhat's known not to work, or not checked yet, in this version, and what to do instead
- FAQShort answers: what it is, what it costs, what it runs on, whether you need a robot