Manual Installation

Follow these steps to manually install tools and packages for DevKit development. If you are on Windows, we suggest you use the installation package to install everything automatically.

Windows

Step 1. Install Azure CLI 2.0 MSI

Follow the official guide to install Azure CLI 2.0 with MSI:

Download and run MSI for the Windows command line from: https://aka.ms/InstallAzureCliWindows

Step 2. Install Arduino IDE

The Visual Studio Code Arduino extension relies on the Arduino IDE. Download and install the Arduino IDE for Windows. Make sure you download the Windows Installer version.

Step 3. Install Visual Studio Code

Download and install Visual Studio Code for Windows. This is the primary development tool for building DevKit IoT applications.

Step 4. Download latest package

  1. Download Windows Installer to install Node.js.

  2. Download .zip file containing task scripts required for DevKit development in VS Code.

Download

MD5: 215a2e9b26e8d0f8d296986d31597c02

Locate the .zip and extract it to your Windows user folder (C:\Users\[your name]). Then launch Command Prompt (cmd) and run the following commands to configure:

  cd C:\Users\[your name]\azure-board-cli

  npm install

Step 5. Install VS Code extension for Arduino

Visual Studio Code allows you to install Marketplace extensions directly in the tool, simply click the extensions icon in the left menu pane and then search Arduino to install:

installation-extensions

Step 6. Install DevKit board package

You need to add the DevKit board using the Board Manager in Visual Studio Code.

  1. Use Ctrl+Shift+P (macOS: Cmd+Shift+P) to invoke command palette and type Arduino then find and select Arduino: Board Manager.

  2. Click ‘Additional URLs’ at the bottom right. installation-additional-urls

  3. In the settings.json file, add a line at the bottom of USER SETTINGS pane and save.
     "arduino.additionalUrls": "https://raw.githubusercontent.com/VSChina/azureiotdevkit_tools/master/package_azureboard_index.json"
    

    installation-settings-json

  4. Now in the Board Manager search for ‘az3166’ and install the latest version. installation-az3166

ST-Link/V2 driver is required to communicate with the DevKit.

  1. Download the driver from STMicro product page or here.

  2. Extract the .zip file and double click stlink_winusb_install.bat to install: installation-st-link

You now have all the necessary tools and packages installed for Windows.

macOS (Preview)

Step 1. Install Azure CLI 2.0

Follow the official guide to install Azure CLI 2.0:

Install Azure CLI 2.0 with one curl command:

curl -L https://aka.ms/InstallAzureCli | bash

And restart your command shell for changes to take effect:

exec -l $SHELL

Step 2. Install Arduino IDE

The Visual Studio Code Arduino extension relies on the Arduino IDE. Download and install the Arduino IDE for macOS.

Step 3. Install Visual Studio Code

Download and install Visual Studio Code for macOS. This is the primary development tool for building DevKit IoT applications.

Step 4. Download latest package

  1. Install Node.js. You can use popular macOS package manager Homebrew or pre-built installer to install it.

  2. Download .zip file containing task scripts required for DevKit development in VS Code.

Download

MD5: 5aac488ea530e5bdc9161145bb5d1254

Locate the .zip and extract it. Then launch Terminal app and run the following commands to configure:

  mv [.zip extracted folder]/azure-board-cli ~/. | cd ~/azure-board-cli

  npm install

Step 5. Install VS Code extension for Arduino

Visual Studio Code allows you to install Marketplace extensions directly in the tool, simply click the extensions icon in the left menu pane and then search Arduino to install:

installation-extensions

Step 6. Install DevKit board package

You need to add the DevKit board using the Board Manager in Visual Studio Code.

  1. Use Cmd+Shift+P to invoke command palette and type Arduino then find and select Arduino: Board Manager.

  2. Click ‘Additional URLs’ at the bottom right. installation-additional-urls

  3. In the settings.json file, add a line at the bottom of USER SETTINGS pane and save.
     "arduino.additionalUrls": "https://raw.githubusercontent.com/VSChina/azureiotdevkit_tools/master/package_azureboard_index.json"
    

    installation-settings-json

  4. Now in the Board Manager search for ‘az3166’ and install the latest version. installation-az3166

You now have all the necessary tools and packages installed for macOS.

Next Steps

You are all set! It’s time to build your first IoT application by following instructions in Projects Catalog.