Building .NET nanoFramework firmware
.NET nanoFramework build system is based in CMake. Please read the instructions specific to each target series.
⚠️ NOTE about the need to build .NET nanoFramework firmware ⚠️
You only need to build it if you plan to debug the CLR, interpreter, execution engine, drivers, add new targets or add new features at native level. If your goal is to code in C# you just have to flash your MCU with the appropriate firmware image using nanoff. There are available ready to flash firmware images for several targets, please check the Home repository.
About this document
This document describes how to build the required images for .NET nanoFramework firmware to be flashed in a SoC or MCU. The build is based on CMake tool to ease the development in all major platforms.
Using Dev Container
If you want a simple, efficient way, we can recommend you to use Dev Container to build your image. This has few requirements as well like Docker Desktop and Remote Container extension in VS Code but it is already all setup and ready to run!
If you prefer to install all the tools needed on your Windows machine, you should continue this tutorial.
- GNU ARM Embedded Toolchain
- CMake (Minimum required version is 3.23)
- A build tool for CMake to generate the build files to. We recommend Ninja. This is lightweight build system, designed for speed and it works on Windows and Linux machines. See here how to setup Ninja to build .NET nanoFramework.
If you are using VS Code as your development platform we suggest that you use the CMake Tools extension. This will allow you to run the builds without leaving VS Code.
In case you specify an RTOS and you want its source to be downloaded from the official repository, you'll need:
- For ChibiOS a SVN client. Tortoise SVN seems to be a popular choice for Windows machines.
- For all the other repositories a Git client. Fork it's a great visual git client packed with a lot of features or GitHub Desktop seems to be a popular choice for Windows machines.
It's highly recommended that run the build outside the source tree. This prevents you from cluttering the source tree with CMake artifacts, temporary files etc. In fact this is enforced and checked by the CMake script.
In case you need to clean up or start a fresh build all you have to do is simply delete the contents of the build directory.
As a suggestion we recommend that you create a directory named build in the repository root and run CMake from there.
Build a .NET nanoFramework firmware image
The build script accepts the a number of parameters (some of them are mandatory). Please check the details about each parameter here.
Note 1: The RTOSes currently supported (except for ESP32 target) are ChibiOS for STM32 targets, FreeRTOS for NXP and TI-RTOS for TI targets. If no source path is specified the source files will be downloaded from nanoFramework GitHub fork. Note 2: the very first build will take more or less time depending on the download speed of the Internet connection of the machine were the build is running. This is because the source code of the RTOS of your choice will be downloaded from its repository. On the subsequent builds this won't happen.
You can specify any generator that is supported in the platform where you are building. For more information on this check CMake documentation here.
Building from the command prompt
If you are building from the command prompt, just go to the repository root folder and run CMake from there with the appropriate parameters. The following is a working example:
cmake --preset ST_NUCLEO_F091RC cmake --build --preset ST_NUCLEO_F091RC
This will call CMake and build the ST_NUCLEO_F091RC target from that configuration preset. It's assumed that you've previously adjusted the tools path in the CMakeUserPresets.json file.
Any of the build options in the cache variables can be overridden from the CLI like in the example below here we're setting the TOOLCHAIN_PREFIX:
cmake --preset ST_NUCLEO144_F746ZG -DTOOLCHAIN_PREFIX="E:/GNU_Tools_ARM_Embedded/10.3-2021.10" cmake --build --preset ST_NUCLEO144_F746ZG
After successful completion you'll have the build files ready to be used in the target build tool.
Building from VS Code (using CMake Tools extension)
We've added the required files and configurations to help you launch your build from VS Code. Follows a brief explanation on the files you might want to tweak.
- settings.json (inside .vscode folder) here you can change the generator that CMake uses to generate the build. The default is
"cmake.generator": "NMake Makefiles". The recommendation is to use Ninja as the build tool because it's way faster than NMake.
- launch.json (inside .vscode folder) here you can set up your launch configurations, such as gdb path or OpenOCD configuration. We've made available Gists with launch.json for several of the reference targets. Grab yours from here. ⚠️ Remember to update paths and other preferences according to your setup and machine configuration. 😉
- CMakeUserPresets.TEMPLATE.json (at the repository root). You should copy this one over to CMakeUserPresets.json. Besides adjusting the paths to the location where you have the tools installed locally, you can tweak build options, add new build configurations and override the default ones. Check the documentation here. !!mind to always use forward slashes in the paths!! ⚠️ Remember to update paths and other preferences according to your setup and machine configuration. 😉
To launch the build in VS Code check the status bar at the bottom. Select the Configure Preset that you want and click the build button (or hit F7).
.NET nanoFramework firmware build deliverables
After a successful build you can find the .NET nanoFramework image files in the build directory. Those are:
nanoBooter image (not available for ESP32 builds):
- nanoBooter.bin (raw binary format)
- nanoBooter.hex (Intel hex format)
- nanoBooter.lst (source code listing intermixed with disassembly)
- nanoBooter.map (image map)
- nanoCLR.bin (raw binary format)
- nanoCLR.hex (Intel hex format)
- nanoCLR.lst (source code listing intermixed with disassembly)
- nanoCLR.map (image map)
When working with self built nanoCLR you may get the following message while deploying a new app:
Found assemblies mismatches when checking for deployment pre-check.
This is because the BUILD_VERSION value of your custom built nanoCLR doesn't match the one nanoframework.CoreLibrary expects.
BUILD_VERSION can be set CMakeUserPresets.json. The value defaults to
Change that to the one you need at the moment, like
Don't forget to:
- make this change under appropriate target block, as described here
- make sure you understood that VSCode have to be reloaded to these json changes have effect.
- make sure you understood that the build folder have to be removed to these changes have effect.
- re-select the CMake target (VSCode bottom line) to reconfigure the build.