Create a Single-Container Project
Introduction
This article guides you on creating a single-container project using the Torizon IDE Extension. The extension provides templates to start from and automates the dependency installation process. By the end of this article, you will be ready to choose the correct template for your project and start your application development.
The instructions of this article work for both Linux and Windows environments. When required for a particular OS environment, additional instructions will be provided.
Prerequisites
- Read the basics of Torizon IDE Extension.
- Toradex System on Module (SoM) with Torizon OS installed.
Start a New Project from a Template
Create a new project:
- Open a new VS Code window.
- Click the
Explorer
icon (1) on the left menu bar. - There will be two buttons for creating projects. Click
New Torizon Project
(2).
Select a template: You will see a new tab with a list of templates that can be used for project creation. Select the template that closely matches your project requirements.
infoTorizon Templates support Level
Note that there are different types of support for templates:
Torizon-supported
: contain development stacks officially provided by the Torizon team, commonly used by customers of Torizon Cloud. Those templates are maintained by the Torizon team and pass through a quality assurance process.Partner-supported
: contain development stacks provided by Toradex partners. They also pass through the same quality assurance process from Torizon-supported templates. The maintenance and support of partner templates are handled by the partners authors of the templates.Community-supported
: contain development stacks provided by community members of Torizon ecosystem. The quality, maintenance and support for community templates are the sole responsibility of their contributors.
Input the project name, container name and creation path. Then, click
Create Project
:- Use only letters and numbers in your project name.
- The container name also accepts the
-
symbol. - The
Creation path
is the system folder in which the project files will be stored.
You can monitor the project creation by checking the terminal at the bottom of the VS Code interface.
After configuring the project, VS Code will reload the window using the newly created project as the default workspace, enabling the use of VS Code debugger and tasks.
During the first load of a new project, the following tasks are triggered:
run-torizon-binfmt
: It runs thetorizon/binfmt
Docker image to register foreign architecture interpreters, which is necessary to build containers for the ARM architecture.run-docker-registry
: It runs a local Docker registry to enable optimized image exchange between the development PC and the target device.run-share-wsl-ports
(Windows-only): By default, services created on a WSL 2 distro are not visible to the external network. This task runs a PowerShell script on the Windows side. That script binds the necessary ports in WSL to make it accessible from the target device. Since that requires administrator user permissions, aUser Account Control
window will appear:Click
Yes
. After the confirmation, a new empty terminal will pop up. Do not close it. The terminal will run the script and then will close automatically.
Check for dependencies on your system:
During the first load of a new project, the notification
Do you want to check for dependencies on your system?
will appear. ClickYes
.The extension will then trigger the
check-deps
task, which checks the necessary local packages (on the development host, such as SDKs) to build the project. For more information, see Check Host Machine Dependencies Required by the Project.tipIf you don't see the notification, you can manually trigger the
check-deps
task. For more information, see Workspace - Tasks.Confirm the installation and your
sudo
password will be requested.