Introduction
Some weeks ago, a new version of the .Net Micro Framework was published. It is a very interesting but very specific technology. And, like many open source-projects, it has some problems with documentation. So, it can take much time to run just a simple example.
In this article, I want to correct this deficiency and to talk about how to quickly and easily install everything you need to work with the emulator of .Net Micro Framework on Windows. Russian version of this article is here.
Backgound
This article focuses on the .Net Micro Framework version 4.4. Starting with this release, the project moved to GitHub. It consists of two branches:
- llilum — the new platform, which compiles C# code directly to a microcontroller assembly code,
- netmf-interpreter — .Net Micro Framework interpreter, "classical" branch, which uses realisations of runtime environment for specific hardware platforms.
I will talk about netmf-interpreter, because this branch is best for practical use at the moment.
For a start it should be noted that netmf-interpreter 4.4 only works with Visual Studio 2015 Community, Pro and Ultimate editions.
Start working with .NetMF 4.4
There are three different ways to start working with netmf-interpreter 4.4:
- Build installation files from the repository,
- Download installation files from GitHub releases page,
- Download installation files through Visual Studio 2015 Extensions and Updates.
Build from the repository
This way is the most difficult one. But it allows to use the most recent code from the repository. Morecover the ability to work with repository will be useful when you need to make some changes in the emulator or to build your own "ports" on other hardware platforms.
You can find the repository here. It can be downloaded as a zip-archive or can be obtained using git. Instructions on how to get the repository and build the installation files can be found here. This article is based on these instructions. Versions of the repository associated with specific releases can be downloaded as a zip-archive from here.
Use these steps to get repository using git:
- Create public copy of the repository in your GitHub account on the GitHub servers with fork command. All pull requests must come from a public GitHub repository.
- Get a local copy of the repository by using clone command. For example:
git clone https:
Important: When you select a path to a local repository, it is necessary to make at least one parent folder. For example, D:\NETMF\repo, where the repo - folder for the repository.
- Set up a local repository as the Upstream. Establishing the official repository as the "Upstream" repository for your local clone enables you to pull changes from the latest official commits into your repository and resolve merge issues locally before submitting a pull request. The command for establishing the Upstream remote is:
git remote add upstream https:
Important: When you unpack the repository from a zip-file, you also need to make at least one parent folder. For example, D:\NETMF\repo, where the repo - folder for the repository.
Unfortunately .NET Micro Framework v4.4 Release To Web (RTW) contains issues that do not allow you to immediately build the installation files from the repository. However, these issues can be easily fixed.
When you get your own local copy of the repository, you need to do this steps:
- Download binary tools zip file. This file contains the tools needed to build both the installation files and "ports" for devices. In the future, it is planned to remove these utilities, but they are still needed.
-
Unzip the contents of binary tools zip-file in the parent folder of the repository. For example, for the path D:\NETMF\repo, where the repo - the repository folder, the bin and tools folder must be in the folder D:\NETMF.
- Important: In the file
<repo folder>\Framework\Tools\BuildTasksInternal\BuildSigner\BuildSignerSpotBuild.csproj
in line 37 change
<HintPath>$(MSBuildProgramFiles32)\Microsoft Internal\Codesign.Submitter\CODESIGN.Submitter.dll</HintPath>
to
<HintPath>$(SPOROOT)\tools\x86\CODESIGN\CODESIGN.Submitter.dll</HintPath>
This is the first issue fix. Without such replacement, build of the repository will not succeed. This fix is needed only for .NET Micro Framework v4.4 Release To Web (RTW). In the future, the repository will already contain correct file. You can read here about this issue.
- You need to download the CMSIS library and put it in the folder
<repo folder>\CMSIS. More information about version and links to the CMSIS library can be found in the file <repo folder>\CMSIS\ReadMe.md.
CMSIS stands for Cortex Microcontroller Software Interface Standard. This library does not depend on a particular manufacturer and intend to work with the Cortex-M core. CMSIS is supplied and supported by kernel developers - the ARM company. Using this library allows you to simplify the creation of the "ports" for different microcontrollers from different manufacturers.
In case of version of .Net Micro Framework 4.4 you need to download CMSIS version 4.3 or newer. The library is supplied as a zip-archive (CMSIS-SP-00300-r4p3-00rel0.zip). It can be downloaded at ARM web site. The content of the archive should be put in the folder <repo folder>\СMSIS.
- In this step you need to install the .Net Micro Framework Cryptographic Libraries. These libraries are used to sign the assemblies that will be executed on the microcontroller. Only executable files of cryptographic library are needed for build process. But you can download source code too.
Libraries are available as msi file. I recommend to install them in any convenient folder (we will call it <crypto install folder>), and then copy them to the root of each repository. For example D:\NETMF\repo and D:\NETMF\repo_master.
The separate folder with cryptographic libraries is needed to fix second build issue.
The repository and all the necessary libraries are finally downloaded. You can build the installation files. .Net Micro Framework is using MSBuild as a building platform. The repository contains many sln and proj files, but Visual Studio can’t be used because these files contain extended format. Visual studio uses MSBuild too, but this building platform allows to create more complex projects.
So, you need to open a command prompt and navigate to the folder with the repository, like this:
cd /d D:\WORKDIR\NetMf\NetMFRepo\repo
Then you need to execute build_sdk.cmd file. This will start build process:
Build process will be completed after a few minutes. Many files will be created, but we need only one: <repo folder>\BuildOutput\public\Release\Server\dll\NetmfVS14.vsix
However, the second installation file will not be created due to the second issue. The final step is fixing it. You need to copy file
<crypto install folder>\crypto\lib\x86\dll\crypto.dll
into folder
<repo folder>\BuildOutput\public\Release\Server\dll\
This library should be copied automatically while building process, but this is not done.
If you start build process again, there will be created two files:
<repo folder>\BuildOutput\public\Release\Server\dll\NetmfVS14.vsix
<repo folder>\BuildOutput\public\Release\Server\msm\MicroFrameworkSDK.MSI
Now you have all installation files.
NetmfVS14.vsix is Visual Studio plugin. MicroFrameworkSDK.MSI is libraries and emulator installation file.
Plugin will configure itself automatically when you install it. Libraries must be installed in the Typical setup type:
Installation from Visual Studio
MicroFrameworkSDK.MSI and NetmfVS14.vsix files can be obtained by using Tools->Extensions and Updates menu item in Visual Studio:
Select Online tab in opened dialog and use “netmf” keyword in the search field (red frame):
Green frame highlight what you need to download and install.
.NET Micro Framework project system is Visual Studio plugin. It matches NetmfVS14.vsix file and is install through Extensions and Updates dialog.
.NET Micro Framework SDK is libraries and emulator installation file. This is a MicroFrameworkSDK.MSI file. You need to download and install it in Typical setup type:
Downloading from GitHub
MicroFrameworkSDK.MSI and NetmfVS14.vsix files can be downloaded from releases page:
NetmfVS14.vsix is Visual Studio plugin. MicroFrameworkSDK.MSI is libraries and emulator installation file.
Plugin will configure itself automatically when you install it. Libraries must be installed in the Typical setup type:
Create and launch first project
Now all libraries and plugins are installed by one of the three ways. So, you can create your first project on the .Net Micro Framework.
The Visual Studio plugin already has some examples. You need only to choose which one you like.
However, there is one important thing. The emulator is installed on the system disk and need to be run in an administrator mode. Otherwise, it will not work correctly. The emulator is started from the Visual Studio, so exactly Visual Studio must be run in administrator mode.
Run Visual Studio as an administrator and create a new project:
If the installation was performed correctly, there will be a new Micro Framework project template:
Choose Windows Application as the most interesting project. You can go to the project properties after creating a solution:
You can find a new tab .NET Micro Framework in the project settings:
Leave all the default values to work with the emulator. If you build and run the project, then you will see the emulator window:
The emulator have a screen, 5 buttons, two virtual SD-cards and a COM-port. All of these perfectly work. For example, pressing the buttons will display their code in the Visual Studio Output window:
You can modify the project and try other functionality.
Summary
Net Micro Framework is a promising open-source technology that allows you to write C# code for microcontrollers. With new IoT ideas and creation UWP concept its development received a new impulse. With time it will cover very small devices that can’t support Windows 10 IoT, but together with this fully support the UWP concept.
Points of Interest
Here are some links about .Net Micro Framework:
History
