Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This script sets up a python virtual environment, installs packages within it, and binds the running of the docker container to the opening/closing of this virtual environment. For a list of tools that we use, take a look at the next section.

Developing on our Team

Overview

Even if a lot of this is made easier for developers, it is still a good idea to become pretty familiar with what’s going on behind the scenes. As mentioned above, our embedded toolkit combines a python virtual environment with a docker container running Ubuntu to combine the ease and freedom of a local, pip-managed environment with the consistency and reliably of a single-platform backend. As long as docker, python.
View filenameFWDevEnv.drawiogit and rust have been properly installed, everything below is set up automatically with the setup script!

...

Mainly, our Cmake build system and Renode Emulator work in docker. Whenever executing commands related to this, the command is passed into the container and run in there, streaming the output back to the user’s console. Most other tools, such as those to flash and debug, monitor serial output, and using git happen locally on the user’s machine inside of their venv.

Commands

We alias a lot of the most helpful commands to make them easier to use. Here is a (likely incomplete) list of some that you may use the most:

  1. Build - runs the cmake build command in docker

  2. Flash - runs the probe-rs command to upload code to a connected board

  3. Debug - runs the probe-rs command to open a gdb server and debug code

Learning Resources

Git

View file
nameGit 101 (Basics of Git).pdf

...