Veethree Extension

Prerequisites Required

You must install and configure everything in Prerequisites before proceeding. The extension will not work otherwise.

SDK Documentation (Doxygen on veethree.com)
Get Started
- Install the Docker Environment
- Grant device permissions
- Connect Device to Environment
- Connect to Environment
Developing on the Environment
- Build, Run and Flash
  - Test on Emulator
  - Test on Device
  - Debug using GDB
  - Debug using JLink using Cortex Debug
  - Generate Release Package
Prerequisites
- Enable HYPER-V and Virtualization
- Install WSL 2 on Windows
- Install Visual Studio Code
- Install Docker
- Install USBIPD
- System Compatibility

Get Started

1. Install the Docker Environment

Click on the Install Environment button to start development environment installation and setup.

NOTE: Make sure Docker Desktop (Docker Engine) is running before installing the environment.

In the left sidebar menu titled: 'Get Started', you will see a number of blue buttons, click the blue button titled: 'Install Environment' button, (top blue button).

If Prompted: Install the Remote Containers extension to enable container-based development. May be seen after installing the Veethree SDK extension.

**Note:** If you see an error like below, make sure your Docker account email is verified and you are logged in.

2. Grant device permissions

Before connecting to the environment and using it for development allow the docker environment to access the device by clicking on the Allow Access to Device button. This requires Admin permissions.

In the left sidebar menu titled: 'VEETHREE SETUP: GET STARTED', you will see a number of blue buttons, click the blue button titled: 'Allow Access to Device', (Second button from the top).

NOTE: Please make sure the device is plugged in and the environment is installed before granting permissions.

3. Connect Device to Environment

Once the device access has been granted, the device can be connected to the development environment by clicking on the Connect Device to Environment button.

In the left sidebar menu titled: 'VEETHREE SETUP: GET STARTED', you will see a number of blue buttons, click the blue button titled: 'Connect Device to Environment' button, (Third button from the top)

NOTE: When connecting to the container, VS Code may show a trust warning. Click Got It to proceed if you're using the official SDKZ container.

4. Connect to Environment

Click on the 'Connect to Environment' button to start developing.

On the left sidebar menu titled: 'VEETHREE SETUP: GET STARTED' below 2 blue buttons there is a 'NOTE' and below that, you will see 2 more Blue buttons, click the second blue button titled: 'Connect to Environment', (Fourth button from the top).

Developing on the Environment

Once connected to the environment, start development by creating a new application from a template or by opening an existing project.

On the left side bar, look under the 'VEETHREE SUPPORT: ACTIONS' menu title you will see 3 options. To start or continue development, you can click either 'Create a new application' or 'Open Project' respectively.

Build, Run and Flash

On the left side bar, look under the menu titled 'VEETHREE SUPPORT' there is a sub-menu called 'BUILD APPLICATION'. In the 'BUILD APPLICATION' menu there are sub-menus options titled: Build, Debug, and Package, each should be expanded to easily follow the rest of the instructions to test.

Predefined commands are available to build the application for Native Posix emulator and to flash and run on the device.

Test on Emulator

Run the West BuildNative Posix to generate build files
Start running the application using the Run command
Open the VNC viewer using the Open VNC Viewer button to view the virtual display

In the left side bar under the menu titled: 'VEETHREE SUPPORT', look at the third sub-menu option titled: 'VNC VIEWER', click the blue 'Open VNC Viewer' button.

Test on Device

Run the West BuildVeethree to generate build files
Connect the device to the environment and run the Flash command

Debug using GDB

Run the Debug BuildNative Posix to generate debug build files
Start a new debug session using Start DebugGDB

Debug using JLink using Cortex Debug

Run the Debug Build and FlashVeethree to generate debug build files and flash them onto the device
Start a new debug session using Start DebugCortex Debug

Generate Release Package

Generate a signed package using the default RSA-2048 PEM file using Generate Signed PackageDefault Key or using a custom PEM file with the command Generate Signed PackageCustom Key
Download the signed packages to local desktop environment using Download command

Prerequisites

1. Enable HYPER-V and Virtualization

First confirm your system is compatible.

You must enable Hyper-V and the Virtual Machine Platform.

Press the Windows key + R to open the Run dialogue box.
Type appwiz.cpl and press Enter.
In the Programs and Features window, select Turn Windows features on or off in the left-hand pane.
In the Windows Features window, scroll down to Hyper-V and check the box next to it.
In this same Windows Features window, scroll down to Virtual Machine Platform and check the box next to it.
Click on OK and wait for the installation process to complete.
Once the installation is complete, click on Restart Now to restart your computer.

2. Install WSL 2 on Windows

You MUST open PowerShell in Administrator mode by right-clicking the icon and selecting Run as administrator.

In PowerShell enter in, wsl --install and press Enter. Then restart your PC.

3. Install Visual Studio Code

Development is designed to happen in VS Code as the VS code extension is a requirement for SDKZ (only currently supported IDE).

Download Visual Studio Code

4. Install Docker

Docker Desktop App GUI interface for your SDKZ workspace.

Download Docker Desktop

NOTE: During Docker Desktop installation, ensure WSL 2 is selected as the backend. This is required for SDKZ compatibility (shortcut to desktop optional).

5. Install USBIPD

Enable USB passthrough on Windows, you must install USBIPD.

NOTE: minimum version: v4.2.0. Use version 4.2.0 - 4.4.1 only. Version 5 is not yet supported. | WSL must be installed and set up.

Open PowerShell (Administrator).
Install usbipd 4.4.1:
- winget install --id dorssel.usbipd-win --version 4.4.1 --interactive --exact
- Or download and run MSI: usbipd-win 4.4.1.
Close all terminals. Open a new PowerShell (Administrator).
Verify installation:
- usbipd --version (expected: 4.4.1)

System Compatibility

System Requirements:

Windows 11 Pro or Enterprise 64-bit Operating System
A 64-bit processor with Second Level Address Translation (SLAT)
A minimum of 4 GB of RAM
BIOS-level hardware virtualization support

Check if your system is compatible:

Press the Windows key + R to open the Run dialogue box.
Type msinfo32 and press Enter.
In the System Information window, scroll down to the System Summary section and look for the Hyper-V Requirements line. If it says Yes, then your system is compatible.

Back to Prerequisites

Veethree SDK Tools

Veethree Technologies