Azure IoT EdgeHub Dev Tool
Project description
Azure IoT EdgeHub Dev Tool 
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 |
Installing
- Install Docker CE on Windows, macOS or Linux.
- Install Python (2.7/3.6) and Pip
- Install iotedgehubdev by running below command in your terminal
pip install --upgrade iotedgehubdev
Quickstart
-
Setup
iotedgehubdev setup -c <edge-device-connection-string> -
Start/stop an IoT Edge solution in simulator
iotedgehubdev start -d <path/to/deployment manifest> iotedgehubdev stop -
Start and debug a single module natively
-
Start the module with specific input(s)
iotedgehubdev start -i <module-inputs>For example:
iotedgehubdev start -i "input1,input2" -
Output the module credential environment variables
iotedgehubdev modulecred -
Start the module natively with the environment variables got from previous step
-
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.
Contributing
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 https://cla.microsoft.com.
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 opencode@microsoft.com with any additional questions or comments.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file iotedgehubdev-0.3.0-py2.py3-none-any.whl.
File metadata
- Download URL: iotedgehubdev-0.3.0-py2.py3-none-any.whl
- Upload date:
- Size: 31.4 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 33217d3496faa515652b064d741d9f24d8f05dfffc1e4ab2b00bfb0e9f84d9df |
|
| MD5 | 137df0a4144af4d7e121919bfc316eeb |
|
| BLAKE2b-256 | 85844caadb8dee86ae3d0e85d115cd290de874e6f5baded64d000e7cbdf0262c |
