Skip to main content
Version: 6

Create a Single-Container Project

Introduction​

This article guides you on creating a single-container project using the Torizon IDE Extension 2. 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.

info

The instructions provided in this article works for both Linux and Windows environment. When required for a particular OS environment, specific additional instructions will be provided.

Prerequisites​

Before Start​

For TorizonCore 5, to get the right templates it is important to include the following variable on the settings.json file in VS Code:

"apollox.templatesBranch": "bullseye"

Also, if you then want TorizonCore 6 templates, remember to remove it or to change it to bookworm (which is the default), like this:

"apollox.templatesBranch": "bookworm"

Start a New Project from a Template​

  1. Create a new project: open a new VS Code window (Ctrl + Shift + N). Click the Explorer icon (1) on the left menu bar. There will be two buttons for creating projects. Click New Torizon Project (2).

  2. Select a template: you will see a new tab with a list of templates that can be used for the project creation. Click the image from the template that closely matches your project requirements.

    info

    Note that there are Toradex-supported, partner-supported and community-supported templates. Toradex-supported templates are templates with development stacks commonly used by customers of the Torizon platform. These templates are maintained by the Toradex Torizon team and pass through a quality assurance process. The quality and maintenance of partner and community templates are the sole responsibility of their contributors.

  3. Input the project name, container name and creation path. Then, click Create Project:

    • Use just 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.

    This will trigger the creation project task with the user inputs. You can monitor its process by checking the terminal at the bottom of the VS Code interface. Then, the VS Code window will reload using the newly created project as the default workspace.

  4. 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. Click Yes. Then, the extension will check the needed packages to build the project. If there are missing packages, it will install them.

    During the first load of a new project, some extra tasks are triggered:

    • run-torizon-binfmt: it runs the torizon/binfmt Docker image to register foreign architecture interpreters, which is necessary to build containers for 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: This task is specific for Windows users (that need to use WSL 2). 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 as administrator, which binds the necessary ports between WSL 2 and Windows to be accessible from the target device. This requires user confirmation, so a User 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 be closed automatically.

    • check-deps: This task checks the necessary local packages (on development host, such as SDK, for example) to build the project. If there are missing packages, it tries to install them.

  5. Install dependencies: if any missing dependencies are detected, the check-deps task will try to install them. Confirm the installation and your sudo password will be requested.

  6. Proceed with your project development: now you can remotely debug your project.



Send Feedback!