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 Edge solution could be run with the simulator locally without pushing image and creating deployment
  • It helps to debug the module on the host (not in container) with the EdgeHub

Installing

  1. Install Docker CE on Windows, macOS or Linux.
  2. Install Python (2.7/3.6) and Pip
  3. Install iotedgehubdev by running below command in your terminal
    pip install --upgrade iotedgehubdev
    

Quickstart

  1. Setup

    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
    
  3. Start and debug a single module natively

    1. Start the module with specific input(s)

      iotedgehubdev start -i <module-inputs>
      

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

    2. Output the module credential environment variables

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

    4. 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

Other resources

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

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

iotedgehubdev-0.2.0-py2.py3-none-any.whl (29.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file iotedgehubdev-0.2.0-py2.py3-none-any.whl.

File metadata

  • Download URL: iotedgehubdev-0.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 29.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.5

File hashes

Hashes for iotedgehubdev-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cdd49d78815de82eb47c1b5f161e93b821f2716acb3c66d49cb6a361e443349f
MD5 a9a4b71b55ee8d300e9f784300275698
BLAKE2b-256 c9f083335a064bf79104c989beaea1ffb71a9690c584e87aadd4ac4f1e74efa3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page