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 primary Microvisor development platform is Ubuntu 20.0.4.
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.
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.
_10sudo bash -c 'apt update && apt install -y gcc-arm-none-eabi binutils-arm-none-eabi \_10 build-essential libsecret-1-dev cmake curl git jq wget gdb-multiarch'
_10curl -sL https://twilio-cli-prod.s3.amazonaws.com/twilio_pub.asc | sudo apt-key add -_10sudo touch /etc/apt/sources.list.d/twilio.list_10echo 'deb https://twilio-cli-prod.s3.amazonaws.com/apt/ /' | sudo tee /etc/apt/sources.list.d/twilio.list_10sudo apt update_10sudo apt install -y twilio
Close your terminal window or tab, and open a new one. Now run:
_10twilio plugins:install @twilio/plugin-microvisor
_10twilio login
Enter your account SID and your account Auth Token, and provide a name ("shorthand identifier") for your profile when asked to do so.
_10twilio profiles:use PROFILE_ID
Enter the following command to get your target device's SID:
_10twilio api:microvisor:v1\:devices:list
Set your device's SID as an environment variable. It should be added to your shell profile:
_10export MV_DEVICE_SID=UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
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.
_10git clone --recurse-submodules https://github.com/korewireless/Microvisor-Demo-CMSIS-Freertos.git && cd Microvisor-Demo-CMSIS-Freertos
_10twilio microvisor:deploy . --devicesid ${MV_DEVICE_SID} --genkeys --log
You have now completed the set-up and build process using the Linux command line.
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.
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.
_10export TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_10export TWILIO_AUTH_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_10export MV_DEVICE_SID=UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
_10$env:TWILIO_ACCOUNT_SID="ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"_10$env:TWILIO_AUTH_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"_10$env:MV_DEVICE_SID="UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
_10set TWILIO_ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_10set TWILIO_AUTH_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_10set MV_DEVICE_SID=UVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
_10git clone --recurse-submodules https://github.com/korewireless/Microvisor-Demo-CMSIS-Freertos.git && cd Microvisor-Demo-CMSIS-Freertos
_10docker build --build-arg UID=$(id -u) --build-arg GID=$(id -g) -t microvisor-freertos-image .
_10docker build -t microvisor-freertos-image .
_10docker 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.
Info
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.