Azure IoT Toolkit

Interact with Azure IoT Hub, IoT Device Management, IoT Edge Management, IoT Hub Code Snippets.

Device Explorer

• Device management
  • List devices
  • Get device info
  • Create device
  • Delete device
• Interact with Azure IoT Hub
  • Send D2C message to IoT Hub
  • Monitor IoT Hub D2C message
  • Send C2D message to device
  • Monitor C2D message from IoT Hub
  • Invoke Direct Method
  • Get/update Device Twin
• Interact with Azure IoT Edge ^Preview (Install Azure IoT Edge for more IoT Edge support)
  • Manage Edge runtime
  • Create deployment for Edge device
  • Generate Edge setup configuration file
  • Generate Edge deployment manifest

Prerequisites

1. In Explorer of VS Code, click "IoT Hub Devices" in the bottom left corner.

2. Click "Set IoT Hub Connection String" in context menu.

3. An input box will pop up, then enter your IoT Hub Connection String (It is one-time configuration, and please make sure it is IoT Hub Connection String not Device Connection String. The format is HostName=<my-hub>.azure-devices.net;SharedAccessKeyName=<my-policy>;SharedAccessKey=<my-policy-key>).

4. The device list will be shown.

NOTE: You could also go to File > Preferences > Settings (Code > Preferences > Settings on Mac), update the config of azure-iot-toolkit.iotHubConnectionString to change your IoT Hub Connection String.

Sign in to Azure

Instead of copying and pasting to set IoT Hub Connection String, you could sign in to Azure to select IoT Hub from your Azure Subscription.

1. Click "Select IoT Hub" in context menu.

2. If you have not signed in to Azure, a pop-up will show to let you sign in to Azure.
3. After you sign in, your Azure Subscription list will be shown, then select an Azure Subscription.
4. Your IoT Hub list will be shown, then select an IoT Hub.
5. The device list will be shown.

Code Snippets

Trigger	Content
iotSendD2CMessage	Send D2C message to IoT Hub
iotMonitorD2CMessage	Monitor D2C message for IoT Hub
iotSendC2DMessage	Send C2D message to device
iotMonitorC2DMessage	Monitor C2D message from IoT Hub
iotCallDirectMethods	Send direct methods to device
iotReceiveDirectMethods	Receive direct methods from IoT Hub

After code snippet is created, you need to install corresponding npm package (e.g. azure-iot-device-mqtt) to run the code snippet. If you want to 'Run Code' directly, you need to install Code Runner.

Configuration

IoT Hub Connection String:

{
    "azure-iot-toolkit.iotHubConnectionString": "HostName=<my-hub>.azure-devices.net;SharedAccessKeyName=<my-policy>;SharedAccessKey=<my-policy-key>"
}

Device Connection String:

{
    "azure-iot-toolkit.deviceConnectionString": "HostName=<my-hub>.azure-devices.net;DeviceId=<known-device-id>;SharedAccessKey=<known-device-key>"
}

IoT Hub Consumer Group (default is "$Default"):

{
    "azure-iot-toolkit.iotHubConsumerGroup": "$Default"
}

Whether to show verbose info when monitoring messages (default is false):

{
    "azure-iot-toolkit.showVerboseMessage": false
}

Whether to stringify device-to-cloud messages (default is false):

{ 
    "azure-iot-toolkit.iotHubD2CMessageStringify": false
}

Whether to show Connection String Input Box on startup (default is true):

{ 
    "azure-iot-toolkit.showConnectionStringInputBox": true
}

Whether to show IoT Hub info when IoT Hub Connection String is not set (default is true):

{ 
    "azure-iot-toolkit.showIoTHubInfo": true
}

Telemetry

VS Code 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.