.NET Core Application Development on Visual Studio Code
This article describes the main steps for developing .NET applications for Torizon OS devices using the Torizon IDE extension. To help you test and understand the basics, we will also guide you in setting up and running a sample that uses the GPIO interface.
This article covers the following topics:
- Add NuGet packages to projects.
- Add package dependencies.
- Give containers access to devices.
- Deploy and debug projects.
- Create production images.
This article complies with the Typographic Conventions for Torizon Documentation.
- Set up the Torizon IDE extension 2 Environment.
- Learn how to create a single container project.
- Get a Toradex Hardware with Torizon OS installed.
- Connect a Torizon OS Target Device.
The Torizon IDE Extension 2 automatically installs the .NET SDK from the Microsoft package repository. However, as some Linux distributions also provide .NET packages, the .NET SDK installation mix packages, and you will likely run into problems. To avoid this, configure your package manager to ignore the .NET packages from the distribution's repository.
Note that when using WSL, the .NET SDK must be installed on the Linux side. Thus, the previous information remains relevant.
Create a New Project
Create a new project from the .NET 6 C# Console Application template. The Torizon IDE extension automatically generates the project folder and the essential files.
This guideline includes instructions for running a basic GPIO sample to assist your understanding. Note that these steps are set up for a Verdin iMX8MP and a Verdin Development Board V1.1 B. However, with minor adjustments, they can be applied to other boards as well. To replicate the same processes and achieve the same outcomes, refer to the software and hardware subsections below.
This sample consists of a C# application that uses the
System.Device.Gpio .NET package to control a GPIO pin and turn an LED on.
Copy the following source code and paste it into the
Program.cs file, which is located in the project's folder.
To test the GPIO pin, you can utilize either a multimeter or an LED to verify the logic level of the connector. When using an LED, ensure you match the voltage and current of both the LED and the GPIO pin. If necessary, consider using a driver circuit to power the LED correctly.
The Verdin Development Board already provides LEDs with driver circuits for quick evaluation.
Thus, we can directly connect the GPIO pin to the carrier board's LED interface.
Note that the
GPIO_3 pin of the Verdin iMX8M Plus, accessible via the
SODIMM_210 pin on the Verdin Development Board, was used. If you have different hardware and are unsure where to begin, refer to the How to Use GPIO on Torizon OS article.
While developing your projects, you may need to add .NET packages using the NuGet package manager. It is a way to reuse community code and streamline your application development.
To add .NET packages, run the following command in the VS Code's terminal:
dotnet add package <PackageName>
Note that the provided GPIO sample requires the
System.Device.Gpio package, which offers methods for accessing and controlling GPIO pins. The following video shows this package addition.
You can search for package dependencies on the NuGet page. However, depending on the package's documentation, you may not find all its dependencies listed. In such cases, you can run your program and check for any missing libraries.
For example, if we try to run our GPIO sample with no additional setups, we may get the following error:
Libgpiod Driver not installed
This implies that we need to add the
libgpiod-dev library to our project. For detailed information, refer to the Add Dependencies and Tools to Existing Projects article.
Projects that utilize peripherals require additional configuration. You need to specify the devices that the application container will access. On Linux-based OSs like Torizon OS, devices are available in user space through the
There are two methods to make devices accessible within the container:
The Torizon IDE extension manages the creation and running of containers. Additionally, it automatically creates the
docker-compose.yml file in the project directory, so you only need to add the necessary parameters.
For the provided GPIO sample, the following parameters were added to the
Docker Compose file for the GPIO Sample
+ - '/dev:/dev'
+ - 'c 254:* rmw'
+ - '/dev/gpiochip0'
Depending on the development phase of your project, whether you are debugging or have already built a container image, the process of sending arguments to applications varies. For detailed information, refer to the Pass Arguments to Containerized Applications article.
Deploy and Debug
After configuring your project, you can deploy and debug it. Since this is common to all languages supported by the extension, please refer to the Deploy and Debug article.
Create Release Images for Production
The Torizon IDE extension provides a task that automatically generates a Docker image and pushes it to a DockerHub registry.
To create a release image, follow the steps below:
- In the Explorer sidebar, locate the Task Runner tab and click on it.
- A list of tasks will appear. Click on Create Production Image.
- On the top of VS Code, a command palette will show up. Input the following information:
- Docker namespace: The namespace to which the extension pushes the image.
- Container image tag: It specifies a version for the image.
- Docker registry password: the required password to push images to the specified namespace.
- Container architecture: select the architecture based on your target device.
After completing these steps, your container image will be named
<docker_namespace>/<application_name>:<image_tag> and pushed to DockerHub.
Before Pre-provision your application container to a Torizon OS image, you can run the container on your target device for testing purposes using the
docker run command. For comprehensive information, please refer to the Docker Run Reference documentation.
Lastly, the extension creates a
docker-compose.prod.yml file. This file is utilized for the following purposes:
- Pre-provision your application container to a Torizon OS production image during Production Programming.
- Create an Application Package on Torizon Cloud for secure Online and Offline Updates.
Configured debug type 'coreclr' is not supported.
CoreCLR is the execution engine in .NET Core. If not installed on VS Code, the following error occurs:
To solve this error, click
Install coreclr Extension.
A fatal error occurred. A file not being found, such as fxr, libhostfxr.so, or FrameworkList.xml.
This error is generated by mixed packages and occurs because conflicts between Microsoft and Ubuntu repositories. To solve this error, configure your package manager to ignore the .NET packages from the distribution's repository.