On this page

Microvisor Quick Start

(warning)

Microvisor Public Beta

Microvisor is in a pre-release phase and the information contained in this document is subject to change. Some features referenced below may not be fully available until Microvisor's General Availability (GA) release.

This Quick Start is intended to help experienced embedded developers get up and running as fast as possible. If you are new to embedded development, we strongly recommend you start with Get Started with the Microvisor Nucleo Development Board rather than this guide.

The following instructions assume you have a Twilio account and a Microvisor Nucleo Development board that is powered up and connected to the Internet using the supplied Super SIM, WiFi, or Ethernet. It also assumes familiarity with Ubuntu and/or Docker on Widows and macOS. You must be familiar with Git on your preferred platform and have it installed.

The Microvisor Nucleo Development Board.

The primary Microvisor development platform is Ubuntu 20.0.4.

Windows

The recommended solution for working with Microvisor on Windows 10 and 11 is via Windows Subsystem for Linux 2 (WSL). You will need Administrator privileges to install WSL.

Open an Administrator-level Powershell or Command Prompt instance.
Run wsl --install -d Ubuntu-20.04.
Exit from Ubuntu and quit Powershell.
Open the Ubuntu 20.04 LTS shell from your Start menu.
Follow the command line instructions.

Alternatively, you can use Docker. You can also try native tools, but this is unsupported at this time.

macOS

The recommended solution for working with Microvisor on Mac is Docker, as outlined below. However, if you're happy not to be supported, you can use native tools on macOS.

Command line (Ubuntu/WSL)

1. Install the prerequisites

1sudo bash -c 'apt update && apt install -y gcc-arm-none-eabi binutils-arm-none-eabi \
2  build-essential libsecret-1-dev cmake curl git jq wget gdb-multiarch'

2. Install the Twilio CLI

1curl -sL https://twilio-cli-prod.s3.amazonaws.com/twilio_pub.asc | sudo apt-key add -
2sudo touch /etc/apt/sources.list.d/twilio.list
3echo 'deb https://twilio-cli-prod.s3.amazonaws.com/apt/ /' | sudo tee /etc/apt/sources.list.d/twilio.list
4sudo apt update
5sudo apt install -y twilio

3. Install the Twilio CLI Microvisor Plugin

Close your terminal window or tab, and open a new one. Now run:

twilio plugins:install @twilio/plugin-microvisor

4. Set up the Twilio CLI

twilio login

Enter your account SID and your account Auth Token, and provide a name ("shorthand identifier") for your profile when asked to do so.

twilio profiles:use PROFILE_ID

5. Set environment variables

Enter the following command to get your target device's SID:

twilio api:microvisor:v1\:devices:list

Set your device's SID as an environment variable. It should be added to your shell profile:

export MV_DEVICE_SID=UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

(information)

Info

The QR code on the back of your board and on the anti-static bag in which it shipped also contains your NDB's SID. Scan the code with your mobile phone and a suitable app, and the board's SID is the third /-separated field.

6. Clone the Microvisor FreeRTOS demo

git clone --recurse-submodules https://github.com/korewireless/Microvisor-Demo-CMSIS-Freertos.git && cd Microvisor-Demo-CMSIS-Freertos

7. Build and deploy the demo

twilio microvisor:deploy . --devicesid ${MV_DEVICE_SID} --genkeys --log

You have now completed the set-up and build process using the Linux command line.

Docker

This flow assumes you have Docker installed on your system and that you have started its daemon. It also assumes you have Git installed on your system.

1. Set environment variables

Set your Twilio credentials as environment variables. You can get the first two from your Twilio Console account dashboard. The QR code on the back of your board and on the anti-static bag in which it shipped also contains your NDB's SID. Scan the code with your mobile phone and a suitable app, and the board's SID is the third /-separated field.

They should be added to your shell profile.

macOS

1export TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
2export TWILIO_AUTH_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
3export MV_DEVICE_SID=UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Windows Powershell

1$env:TWILIO_ACCOUNT_SID="ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
2$env:TWILIO_AUTH_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
3$env:MV_DEVICE_SID="UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Windows Command Prompt

1set TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
2set TWILIO_AUTH_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
3set MV_DEVICE_SID=UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

2. Clone the Repo

macOS/Windows

git clone --recurse-submodules https://github.com/korewireless/Microvisor-Demo-CMSIS-Freertos.git && cd Microvisor-Demo-CMSIS-Freertos

3. Build the image

macOS

docker build --build-arg UID=$(id -u) --build-arg GID=$(id -g) -t microvisor-freertos-image .

Windows

docker build -t microvisor-freertos-image .

4. Run the build

macOS/Windows

docker run -it --rm -v .:/home/mvisor/project/ --env-file env.list --name microvisor-freertos microvisor-freertos-image

Under Docker, the demo is compiled, uploaded and deployed to your development board. It also initiates logging — hit Ctrl-c to break out to the command prompt.

You have now completed the set-up and build process using Docker.

(information)

Microvisor Help and Support

We welcome all inquiries you may have about Microvisor and its implementation, and any support questions that arise once you've begun developing with Microvisor. Please submit your queries via a KORE Wireless ticket: log in to the Kore console and click the Contact Support button in the left-hand navbar.