MakAir Firmware

Versions

For a full history of all minor versions, as well as details of all changes, see CHANGELOG.md.

⚛️ Latest Improvements

A bleeding edge firmware version is available on the dev branch, which contains our latest improvements. This firmware version might still be work in progress and thus might not be suitable for production use.

⚠️ Note that the master branch may not contain the latest firmware version. It might not work with the latest version of makair-control-ui. In this case, please use the dev branch instead.

Releases

Pre-compiled binaries are available in the Releases section.

Documentation

Code documentation can be found there.

How To Build?

First, make sure arduino-cli is installed on your system. The supported version is 0.9.0. Newer versions are known to cause issues with compiling the firmware code.

In order to setup your environment and build the code, please follow the following commands (for MacOS):

1. brew install arduino-cli
2. arduino-cli config init --additional-urls https://github.com/stm32duino/BoardManagerFiles/raw/master/package_stmicroelectronics_index.json
3. arduino-cli core update-index
4. arduino-cli core install STMicroelectronics:stm32@2.0.0
5. arduino-cli lib install LiquidCrystal@1.0.7 && arduino-cli lib install OneButton@1.5.0 && arduino-cli lib install CRC32@2.0.0

Then, compile the project:

arduino-cli compile --fqbn STMicroelectronics:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output builds/respirator-production

How To Flash?

In order to flash the firmware that you just built using the instructions above:

1. Plug your ST-Link programmer to the motherboard, and switch the motherboard to flash mode (switch position to flash mode on the motherboard);
2. Plug the ST-Link programmer to your computer, over USB, and fetch its device name via the arduino-cli board list command (we will call it {SERIAL_PORT});
3. Make sure that STM32CubeProgrammer is installed on your computer, and run:

arduino-cli upload --port {SERIAL_PORT} --fqbn STMicroelectronics:stm32:Nucleo_64:pnum=NUCLEO_F411RE,upload_method=swdMethod --input builds/respirator-production

_Make sure to replace {SERIALPORT} with your serial port, which should begin with /dev/.

Scripts

A few scripts are available, eg. to automate repeated manual actions:

1. Compile & Flash: ./scripts/compile_and_flash.sh (compiles firmware and flashes it over the plugged STM32 programmer);
2. Compile Only: ./scripts/compile_only.sh (compiles firmware, useful to check for code mistakes);

Some specialized scripts are available, eg. that target older hardwares:

1. Compile & DFU (HW3): ./scripts/compile_and_dfu_hardware_v3.sh (compiles firmware and flashes it to Hardware V3);

Configuration

The configuration options can be found in the following files:

• High-level configuration options are available and documented in includes/config.h;
• Low-level configuration options can be found in includes/parameters.h;