This is a demo project for the stm32F3xx MCU that helps users to learn the many different features of the Lager CLI tool.
With this demo, users can:
- Learn how to build a project inside a docker container
- Remotely flash and run an application on a DUT (in this case the NUCLEO-F334R8 board)
- See how unit testing can be incorporated into their work flow via the Unity Testing Framework
- Set up a continuous integration pipeline
Before experimenting with this project there are a couple of pre-requisites
- Install docker client for your operating system (https://www.docker.com/products/docker-desktop)
- Install Lager's CLI tool:
pip3 install lager-cli
A Lager environment with build instructions is included in this repository.
To build the project simply run:
lager exec cmake-build
This will build all the targets in this project.
To see the different build options run:
lager devenv commands
If you would like to create a development environment from scratch do the following:
lager devenv delete This deletes the current development environment
lager devenv create This creates a new development environment.
This will instruct users to choose a development environment image (e.g. cortex-m, stm32, ti, etc), where to mount their project in the docker container, and what shell type to use. For this project the default settings are OK.
Note: Go to https://hub.docker.com/u/lagerdata to view other development environments supported by Lager
To create a new build command run:
lager exec --command "user defined build command" --save-as user-defined-shortcut
For example, to build this project using the STM32CUBEIDE's gcc compiler a user can define the following:
lager exec --command "headless-build.sh -build demo-nucleo-f334r8 -importAll /app" --save-as my_build_cmd
Moving forward a user could then run lager exec my_build_cmd
To flash a board first connect the Lager Gateway to the NUCLEO-F334R8 development board.
There are two options to do this:
- USB2.0 - This will allow users to use the ST-Link debug probe built into the NUCLEO-F334R8 development board
- Cortex-Debug 20 Pin header on Gateway - This allows users to use the built-in FTDI debug probe on the Gateway but will require breaking out the SWD pins on the development board.
Then run:
lager connect --device stm32f3x --interface stlink --transport swd --speed 480
or if using built-in debug probe
lager connect --device stm32f3x --interfact ftdi --transport swd --speed 480
To flash the board with the project application run the following:
lager flash --hexfile Release/demo-nucleo-f334r8.hex
To execute the program run:
lager run
To run an example unit-test for this project run the following:
lager testrun --serial-device /dev/ttyACM0 --hexfile Test/demo-nucleo-f334r8_test.hex
The results of the individual tests will be streamed back to the terminal.
To test Drone integration first make sure the demo repository is forked, then go to drone.app.lagerdata.com and 'Activate' the repository.
There is already a .drone.yml in the project. You can open it to examine which test images will be flashed to the board and run.
You can test a deploy by doing an empty commit, and then pushing to the remote repo.
git commit --allow-empty
git push
You can view progress of the deploy by going to drone.app.lagerdata.com, selecting the demo repository, clicking on the latest commit, and choosing "Activity Feed".