Skip to main content

Azure IoT EdgeHub Dev Tool

Project description

Azure IoT EdgeHub Dev Tool Build Status

The Azure IoT EdgeHub Dev Tool provide a local development experience with a simulator for creating, developing, testing, running, and debugging Azure IoT Edge modules and solutions.

  • The bits/code of Edge module running on simulator and IoT Edge Runtime are same.
  • The Edge solution could be run with the simulator locally without pushing image and creating IoT Edge deployment.
  • The credential needed to run Edge solution on simulator is IoT Edge Device Connectionstring. And IoT Hub Connectionstring is not needed.
  • It helps to debug the module on the host (not in container) with the EdgeHub

The following table compares the steps needed to run the solution on the IoT Edge Runtime and iotedgehubdev tool.

IoT Edge Runtime iotedgehubdev
Device Credential Needed YES YES
IoT Hub Credential Needed YES NO
Build Image YES YES
Push Image YES NO
Create Deployment YES NO
Support native debug scenario No YES


  1. Install Docker CE (18.02.0+) on Windows, macOS or Linux.

  2. Install Docker Compose (1.20.0+) (Only required for Linux. Compose has already been included in Windows/macOS Docker CE installation)

  3. Install Python (2.7/3.5+) and Pip

  4. Install iotedgehubdev by running below command in your terminal

    pip install --upgrade iotedgehubdev

    Note: Please install iotedgehubdev to root on Linux/macOS (Don't use '--user' option in the 'pip install' command).

Please make sure there is no Azure IoT Edge runtime running on the same machine with iotedgehubdev since they require the same ports.


  1. Setup


    iotedgehubdev setup -c "<edge-device-connection-string>"


    sudo iotedgehubdev setup -c "<edge-device-connection-string>"
  2. Start/stop an IoT Edge solution in simulator


    iotedgehubdev start -d <path/to/deployment-manifest>
    iotedgehubdev stop


    sudo iotedgehubdev start -d <path/to/deployment-manifest>
    sudo iotedgehubdev stop
  3. Start and debug a single module natively

    1. Start the module with specific input(s)


      iotedgehubdev start -i "<module-inputs>"


      sudo iotedgehubdev start -i "<module-inputs>"

      For example: iotedgehubdev start -i "input1,input2"

    2. Start the module with specific input(s) and environment variable(s)


      iotedgehubdev start -i "<module-inputs>" -e "<environment-variable>"


      sudo iotedgehubdev start -i "<module-inputs>" -e "<environment-variable>"

      For example: iotedgehubdev start -i "input1,input2" -e "TestEnv1=Value1" -e "TestEnv2=Value2"

    3. Output the module credential environment variables

      iotedgehubdev modulecred
    4. Start the module natively with the environment variables got from previous step

    5. Send message to the module through RESTful API.

      For example: curl --header "Content-Type: application/json" --request POST --data '{"inputName": "input1","data": "hello world"}' http://localhost:53000/api/v1/messages

    6. Stop the simulator


      iotedgehubdev stop


      sudo iotedgehubdev stop

Other resources


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 change your telemetry settings by updating collect_telemetry to no in the ini file.


This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for iotedgehubdev, version 0.11.0
Filename, size File type Python version Upload date Hashes
Filename, size iotedgehubdev-0.11.0-py2.py3-none-any.whl (35.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page