opentrons-modules | Firmware repository for OT-2 compatible modules

This repo uses CMake as a configuration and build management tool. It requires CMake 3.20 since it uses presets to manage cross-compilation and project configuration options.
Before you can configure any of the cmake presets, you may need to manually install a C compiler and a C++ compiler (e.g. sudo apt install gcc g++ on Ubuntu)
If you want to interact with the STM32 hardware, you should also install st-link.
If you want to build the arduino modules, run cmake --preset=arduino . to set your build step up to build the Arduino-based modules (Magnetic Module, Temperature Module, Thermocycler). This should download the Arduino IDE to the git-ignored arduino_ide directory in the repo's working tree. It will also set up a build system in ./builds.
If you want to build the STM32 modules, run cmake --preset=stm32-cross . to set your build step up to cross-compile the module firmwares for actually putting on modules. This should download the arm cross builds of gcc 10-2020q4 to the git-ignored stm32-tools directory in the repo's working tree and set up a build system in ./build-stm32-cross. By default, this will be a "Debug" build type, which generates debug symbols packed into the elf and doesn't use optimizations (which makes debugging a lot easier). You can change the build type by adding -DCMAKE_BUILD_TYPE=<BUILD_TYPE> on the command line when generating. Valid build types are Debug (default), MinSizeRel (size optimizations for release - what CI uses to build), and RelWithDebInfo (optimizations + debug info, useful if you're seeing failures in the field that don't happen in Debug builds).
If you want to build the STM32 module tests, run cmake --preset=stm32-host . to set your build step up to host-compile the module fimrware libs and tests for local running. You'll need to have at least a gcc installed; if you have a clang installed, the build will run some clang checker steps. This will set up a build system in ./build-stm32-host
Each build dir should have a reasonable all target (invokable by running cmake --build <build-dir>) and individual targets for each module firmware. For instance, the arduino modules have <module-name> set up as individual build targets. You always have to specify the build dir to run in with cmake --build; that can be run from the root of the repo (e.g. by calling cmake --build ./build-stm32-cross or cmake --build ./build) or as . if you navigate into the right build directory first. To build a specific target, use the --target flag: cmake --build ./build --target magdeck. For the arduino modules, the module name target builds the sketch and copies some supporting files like a python-based uploader and a hex for writing the eeprom into builds/module-name. For arduino modules, the special target zip-all will build zip files of all module firmwares and support files (e.g. eeprom writing): cmake --build ./build-arduino --target zip-all. You can then run cmake --install ./build and those zip files will be put in the dist/ directory; this is used in ci. For stm32 modules, there are module name targets that build the requisite firmware defined in the cross toolchain and the test toolchain alike. In the cross toolchain, these build runnable firmwares; in the host toolchain, they build everything necessary to run tests, but running the tests is done with cmake --test.