Skip to content
Azure IoT Edge for Visual Studio Code
HTML JavaScript TypeScript CSS
Branch: master
Clone or download
Latest commit e084baf Sep 5, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
.vscode Use Webpack to improve extension performance (#323) Dec 13, 2018
assets Only add tempsensor during new solution with custom module (#455) May 31, 2019
images prepare release 1.6.0 (#304) Nov 23, 2018
scripts Separate AI key for prod and test environment (#109) Apr 20, 2018
src
test Read connection string from Toolkit, rename 'tempSensor' to 'Simulate… ( Jul 11, 2019
testResources Read connection string from Toolkit, rename 'tempSensor' to 'Simulate… ( Jul 11, 2019
.gitattributes Force EOL of package.json and package-lock.json as LF (#19) Nov 28, 2017
.gitignore Use Webpack to improve extension performance (#323) Dec 13, 2018
.travis.yml Validate links for markdown files in CI/CD (#494) Aug 23, 2019
.vscodeignore Use Webpack to improve extension performance (#323) Dec 13, 2018
CHANGELOG.md 1.17.0 (#497) Aug 30, 2019
LICENSE.txt
README.md Update README.md Sep 5, 2019
ThirdPartyNotice.html
logo.png Update logo Nov 10, 2017
package-lock.json 1.17.0 (#497) Aug 30, 2019
package.json 1.17.0 (#497) Aug 30, 2019
tsconfig.json First commit Aug 28, 2017
tslint.json Allow users to specify whether to install Node.js template (#329) Dec 20, 2018
webpack.config.js IoT Edge Marketplace (#389) Mar 12, 2019

README.md

Azure IoT Edge for Visual Studio Code

Gitter

Azure IoT Edge extension is now part of Azure IoT Tools extension pack. We highly recommend installing Azure IoT Tools extension pack, which makes it easy to discover and interact with Azure IoT Hub that power your IoT Edge and device applications. This extension pack can help you:

  • Develop and connect your Azure IoT Applications to Azure. With this extension, you can interact with an Azure IoT Hub, manage connected devices, and enable distributed tracing for your Azure IoT applications.
  • Develop and debug Certifies Azure IoT Devices (including MXChip IoT DevKit, ESP32, Raspberry Pi) to Azure. This extension pack makes it easy to code, build, deploy and debug your IoT applications with popular IoT development boards.
  • Develop and deploy artificial intelligence and your custom logic to Azure IoT Edge. This extension pack makes it easy to code, build, deploy, and debug your IoT Edge applications.

Overview

Azure IoT Edge extension makes it easy to code, build, deploy, and debug your IoT Edge solutions in Visual Studio Code, by providing a rich set of functionalities:

  • Create new IoT Edge solution
  • Add new IoT Edge module to Edge solution
  • Build and publish IoT Edge modules
  • Debug IoT Edge modules locally and remotely
  • IntelliSense and code snippets for the deployment manifest
  • Manage IoT Edge devices and modules in IoT Hub (with Azure IoT Toolkit)
  • Deploy IoT solutions to IoT Edge devices

Added

What's New (v1.17.0)

Added

  • Add CodeLens to help user update ASA job information.

Fixed

  • Fix broken link in README.md.

Known Issues

Prerequisites for Azure IoT Edge extension

You need to install prerequisites below to make Azure IoT Edge extension work:

Prerequisites for specific language

To develop IoT Edge modules you also need to install following prerequisites for specific language:

C# module prerequisites

C# Functions on IoT Edge prerequisites

Python module prerequisites

Node.js module prerequisites

Java module prerequisites

C module prerequisites

Quickstart

Click the links below to learn how to develop, debug and deploy IoT Edge modules.

FAQ

Q: All too often, I forget to save a config file, and when I build the docker image. Can we auto-save files before build?

A: By default, VS Code requires an explicit action to save your changes to disk, Ctrl+S. However, it's easy to turn on Auto Save

Q: How to work with Python virtual environment?

A: The Python extension manages your virtual environments in the workspace folder. Please refer to Environments and Automatic Activation of Environments in the Terminal for details.

Q: Help me understand IoT Edge deployment manifest.

A: Learn how to use deployment manifests to deploy modules and establish routes

Q: If I run this extension on Linux (e.g. Ubuntu), when executing docker commands (e.g. the Build IoT Edge Module Image command), the terminal shows permission denied errors. How can I fix this, and avoid having to prefix every command manually with sudo?

A: This extension assumes the current user has sufficient privileges to run docker commands. On Linux you can add the current user to the docker group by executing the following commands:

  • To create the group: sudo groupadd docker
  • To add the current user to it: sudo usermod -aG docker $USER

After executing these commands exit your Terminal session and restart Docker (sudo systemctl restart docker). Or you can reboot the machine completely. Check the Post-installation steps for Linux in the Docker documentation for more information on how to manage Docker as a non-root user.

Commands

Press F1 or Ctrl + Shift + P to open command palette, type Azure IoT Edge: to see all the commands:

  • Azure IoT Edge: New IoT Edge Solution: Create an IoT Edge solution.
  • Azure IoT Edge: Add IoT Edge Module: Add a new IoT Edge module to the IoT Edge solution.
  • Azure IoT Edge: Build IoT Edge Module Image: Containerize IoT Edge module from source code.
  • Azure IoT Edge: Build and Push IoT Edge Module Image: Containerize and push IoT Edge module image to a Docker registry.
  • Azure IoT Edge: Build IoT Edge Solution: Build all the IoT Edge module image in the solution and expand deployment manifest.
  • Azure IoT Edge: Build and Push IoT Edge Solution: Build and push all the IoT Edge module image in the solution and expand deployment manifest.
  • Azure IoT Edge: Setup IoT Edge Simulator: Setup IoT Edge Simulator with an edge device connection string.
  • Azure IoT Edge: Build and Run IoT Edge Solution in Simulator: Build all the IoT Edge module image in the solution and expand deployment manifest. Then run the solution in IoT Edge Simulator.
  • Azure IoT Edge: Run IoT Edge Solution in Simulator: Run the solution of the given deployment manifest in IoT Edge Simulator.
  • Azure IoT Edge: Start IoT Edge Hub Simulator for Single Module: Start the IoT Edge Simulator for testing single module. It will ask for the input names of the module.
  • Azure IoT Edge: Stop IoT Edge Simulator: Stop IoT Edge Simulator.
  • Azure IoT Edge: Set Module Credentials to User Settings: Set the module credential into "azure-iot-edge.EdgeHubConnectionString" and "azure-iot-edge.EdgeModuleCACertificateFile" in user settings. The credentials could be used to connect IoT Edge Simulator.
  • Azure IoT Edge: Create deployment for Edge device: Create and submit the deployment to your IoT Edge device with specified deployment manifest.

You can also trigger following frequently-used commands in context menu.

  • Azure IoT Edge: Add IoT Edge Module: The context menu of deployment.template.json file or modules folder in VS Code file explorer. A new module will be added to the modules folder.
  • Azure IoT Edge: Build IoT Edge Solution: The context menu of deployment.template.json file in VS Code file explorer.
  • Azure IoT Edge: Build and Push IoT Edge Solution: The context menu of deployment.template.json file in VS Code file explorer.
  • Azure IoT Edge: Build and Run IoT Edge Solution in Simulator: The context menu of deployment.template.json file in VS Code file explorer.
  • Azure IoT Edge: Generate IoT Edge Deployment Manifest: The context menu of deployment.template.json file in VS Code file explorer. The deployment manifest (deployment.json) will be expanded from deployment.template.json.
  • Azure IoT Edge: Build IoT Edge Module Image: The context menu of the module.json file in VS Code file explorer. With the input platform from user, it will build the image with the target Dockerfile.
  • Azure IoT Edge: Build and Push IoT Edge Module Image: The context menu of the module.json file in VS Code file explorer. With the input platform from user, it will build and push image with the target Dockerfile.
  • Azure IoT Edge: Create deployment for Edge device: The context menu of an IoT Edge device in device list. Create a deployment for target IoT Edge device with deployment manifest file you select.
  • Azure IoT Edge: Edit module twin: The context menu of a deployed module in device list. Fetch target module twin and then update it in edit view.

Code Snippets

Trigger Content
edgeModule Add IoT Edge module in IoT Edge deployment manifest
edgeRoute Add IoT Edge route in IoT Edge deployment manifest

Resources

Supported Operating Systems

Currently this extension supports the following operating systems:

  • Windows 7 and later (32-bit and 64-bit)
  • macOS 10.10 and later
  • Ubuntu 16.04

The extension might work on other Linux distros as some users have reported, but be aware that Microsoft provides no guarantee or support for such installations. You can find Azure IoT Edge support here.

TypeEdge (Experimental)

The Azure IoT TypeEdge introduces a strongly-typed flavor of the inherently loosely coupled vanilla Azure IoT Edge. We would like to invite you to try TypeEdge out and give us any feedback or recommendations you might have here. TypeEdge is still an experimental project that we don’t recommend to use it in production IoT Edge project.

To get started, please visit the project repo and give us feedback via Github Issues.

Data/Telemetry

This project collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more. If you don’t wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. Learn more in our FAQ.

Support and Contact Us

You can join in our Gitter to ask for help, report issues and talk to the product team directly.

You can’t perform that action at this time.