iotedgedev | Azure IoT Edge Dev Tool greatly simplifies your Azure IoT | Azure library

To set up development machines manually instead of using the IoT Edge Dev Container, please see the Manual Development Machine Setup Wiki. This quickstart will run a container, create a solution, setup Azure resources, build and deploy modules to your device, setup and start the IoT Edge simulator, monitor messages flowing into IoT Hub, and finally deploy to the IoT Edge runtime. The only thing you need to install is Docker. All of the other dev dependencies are included in the container.
Install Docker CE For Windows, please follow the document to open Docker Settings and setup a Shared Drive. For macOS, please follow the document to choose local directories to share with your containers. Note: If the device is behind the proxy server, you can set the proxy manually
Run the IoT Edge Dev Container Before you run the container, you will need to create a local folder to store your IoT Edge solution files. Windows mkdir c:\temp\iotedge docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v c:/temp/iotedge:/home/iotedge mcr.microsoft.com/iotedge/iotedgedev Linux sudo mkdir /home/iotedge sudo docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v ~/iotedge:/home/iotedge mcr.microsoft.com/iotedge/iotedgedev macOS mkdir ~/iotedge docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v ~/iotedge:/home/iotedge mcr.microsoft.com/iotedge/iotedgedev
Initialize IoT Edge solution and setup Azure resources iotedgedev init iotedgedev init will create a solution and setup your Azure IoT Hub in a single command. The solution comes with a default C# module named filtermodule. More information You will see structure of current folder like below: │ .env │ .gitignore │ deployment.debug.template.json │ deployment.template.json │ ├─.vscode │ launch.json │ └─modules └─filtermodule │ .gitignore │ Dockerfile.amd64 │ Dockerfile.amd64.debug │ Dockerfile.arm32v7 │ Dockerfile.windows-amd64 │ filtermodule.csproj │ module.json │ Program.cs Open .env file, you will see the IOTHUB_CONNECTION_STRING and DEVICE_CONNECTION_STRING environment variables filled correctly. Open deployment.template.json file You will see below section in the modules section: "filtermodule": { "version": "1.0", "type": "docker", "status": "running", "restartPolicy": "always", "settings": { "image": "${MODULES.filtermodule}", "createOptions": {} } } Two default routes are added: "routes": { "sensorTofiltermodule": "FROM /messages/modules/tempSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/filtermodule/inputs/input1\")", "filtermoduleToIoTHub": "FROM /messages/modules/filtermodule/outputs/* INTO $upstream" } You will see privacy statement like below: Welcome to iotedgedev! ------------------------- Telemetry --------- The iotedgedev collects usage data in order to improve your experience. The data is anonymous and does not include commandline argument values. The data is collected by Microsoft. You can change your telemetry settings by updating 'collect_telemetry' to 'no' in ~/.iotedgedev/setting.ini
Build IoT Edge module images sudo iotedgedev build This step will build user modules in deployment.template.json targeting amd64 platform. More information You will see a "BUILD COMPLETE" for each module and no error messages in the terminal output. Open config/deployment.amd64.json file, you will see the module image placeholders expanded correctly. Run sudo docker image ls, you will see the module images you just built.
Setup and start the IoT Edge Simulator to run the solution sudo iotedgedev start --setup --file config/deployment.amd64.json More information You will see an "IoT Edge Simulator has been started in solution mode." message at the end of the terminal output Run sudo docker ps, you will see your modules running as well as an edgeHubDev container
Monitor messages sent from IoT Edge Simulator to IoT Hub iotedgedev monitor More information You will see your expected messages sending to IoT Hub Stopping the monitor doesn't stop the simulator. It will continue running until it is explicitely stopped using iotedgedev stop and at that time all containers used by the simulator will be cleaned up.
Docker containers/images management The containers used by the simulator will be cleaned up when the simulator stops running iotedgedev stop All remaining containers can be cleaned up using iotedgedev docker clean -c All remaining images can be cleaned up using iotedgedev docker clean -i