Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Quickstart

Clone the mc_one_codey repo, and run docker compose up --build. The compose file automatically downloads the necessary packages and put them together.

Note that on the Raspberry Pi 5, this could take upwards of 15 minutes.

Once the containers are built, they start automatically. Also, after reboot, the containers will come up automatically.

The files calibrations.yaml and persistent.yaml contain the state of the robot. These files are automatically managed by the system. When calibrations.yaml is missing, the system will not start (this could risk overwriting calibrations). When persistent.yaml is missing, the system will assume factory defaults, and create a new persistent.yaml.

Stopping and Restarting the System

To stop the running system, use docker compose stop. To restart again, use docker compose up.

When a Package has Changed

When a package has changed, stop the running system (docker compose stop) and rebuild the containers (docker compose up --build). The system will only rebuild what has changed.