Official Azure IoT EdgeHub Dev Tool
The Azure IoT EdgeHub Dev Tool provides a local development experience with a simulator for creating, developing, testing, running, and debugging Azure IoT Edge modules and solutions.
The simulator allows you to run, test and debug your own custom IoT Edge modules locally, without the IoT Edge Runtime, and with the following benefits:
- Your custom Edge module code is the same whether running on the simulator or the full IoT Edge Runtime.
- Your Edge solution can be run locally without the need to push new images or create IoT Edge deployment manifests.
- The only credential required to run your Edge solution on the simulator is the IoT Edge Device Connection String. The IoT Hub Connection String is not needed.
- It helps you debug your custom Edge modules on the host and not just in the container.
The following table compares the requirements to run your 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 (18.02.0+) on
Windows, macOS or Linux
Install Docker Compose (1.20.0+) (Linux only. Compose has already been included in Windows/macOS Docker CE installation)
Install Python (2.7/3.5/3.6/3.7/3.8) and Pip
Install iotedgehubdev by running the following 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 as iotedgehubdev since they require the same ports.
Quickstart
1. Setup
Windows
iotedgehubdev setup -c "<edge-device-connection-string>"
Linux/macOS
sudo iotedgehubdev setup -c "<edge-device-connection-string>"
2. Start/Stop an IoT Edge solution in simulator
Windows
iotedgehubdev start -d <path/to/deployment-manifest>
iotedgehubdev stop
Linux/macOS
sudo iotedgehubdev start -d <path/to/deployment-manifest>
sudo iotedgehubdev stop
3. Start and debug a single module natively
Start the module with specific input(s) and/or environment variable(s)
Windows
iotedgehubdev start -i "<module-inputs>"
// OR
iotedgehubdev start -i "<module-inputs>" -e "<environment-variable>"
Linux/macOS
sudo iotedgehubdev start -i "<module-inputs>"
// OR
sudo iotedgehubdev start -i "<module-inputs>" -e "<environment-variable>"
For example:
iotedgehubdev start -i "input1,input2" -e "TestEnv1=Value1" -e "TestEnv2=Value2"
Output the module credential environment variables
iotedgehubdev modulecred
Start your module natively with the environment variables from the previous step
Send a message to your module through the RESTful API
For example:
curl --header "Content-Type: application/json" --request POST --data '{"inputName": "input1","data": "hello world"}' http://localhost:53000/api/v1/messages
Stop the simulator
Windows
iotedgehubdev stop
Linux/macOS
sudo iotedgehubdev stop
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.
Concerns
While our friend commented he is worried the official link changes, I am hoping the official Microsoft's repo link on GitHub never changes (unless while it still useful). At least, I dont know how other way I can post binary files here.
Here is the repo https://github.com/Azure/iotedgehubdev
Cheers To everyone
