The Azure IoT Edge Dev Tool greatly simplifies your Azure IoT Edge development process. It has everything you need to get started and helps with your day-to-day Edge development.
Python PowerShell Shell Makefile Batchfile Dockerfile JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode VS Code debugging of iotedgedev (python 3.6 only for now) (#166) May 7, 2018
assets Add quickstart video (#161) Apr 18, 2018
docker Container docker compose support (#243) Aug 10, 2018
iotedgedev Add support for DOTENV_FILE in tests (#257) Aug 15, 2018
scripts Decouple push from build command (#124) Mar 22, 2018
tests Add support for DOTENV_FILE in tests (#257) Aug 15, 2018
.env.tmp Support for multiple registries (#193) Aug 11, 2018
.gitignore Add iotedgehubdev integration (#233) Aug 15, 2018
.travis.yml Support for multiple registries (#193) Aug 11, 2018
CODE_OF_CONDUCT.md update license file, update code of conduct (#172) May 15, 2018
CONTRIBUTING.md add Contributing.md content and fix link (#182) Jun 7, 2018
HISTORY.rst Init Commit Dec 30, 2017
LICENSE update license file, update code of conduct (#172) May 15, 2018
MANIFEST.in Simplified API, azure setup from EnvVars (#49) Mar 9, 2018
Makefile Init Commit Dec 30, 2017
README.md Update README.md Jul 26, 2018
build.sh Added support for windows containers via nanoserver (#158) Aug 10, 2018
cleanup.sh Added support for windows containers via nanoserver (#158) Aug 10, 2018
package-lock.json Added support for windows containers via nanoserver (#158) Aug 10, 2018
package.json Implement the new monitor-events CLI for Py35+ users (#236) Aug 7, 2018
pytest.ini Configure travis for unit tests (#195) Jun 29, 2018
requirements.txt Add iotedgehubdev integration (#233) Aug 15, 2018
requirements_dev.txt Added support for windows containers via nanoserver (#158) Aug 10, 2018
requirements_nodeps.txt Lightweight Az CLI via pip install method. (#29) Feb 28, 2018
requirements_travis.txt Configure travis for unit tests (#195) Jun 29, 2018
setup.cfg Support new schema of deployment.json with backward compatibility (#222) Aug 3, 2018
setup.py Add iotedgehubdev integration (#233) Aug 15, 2018
tox.ini Add support for DOTENV_FILE in tests (#257) Aug 15, 2018
travis_pypi_setup.py Update to Tool and simplify pypi package name (#149) Apr 8, 2018

README.md

Azure IoT Edge Dev Tool

IOTEDGEDEV DOES NOT WORK WITH IOT EDGE GA BITS.

ETA: Mid-August

PLEASE WATCH THIS REPO FOR NOTIFICATIONS

Build Status

The Azure IoT Edge Dev Tool greatly simplifies Azure IoT Edge development down to simple commands driven by Environment Variables.

  • It gets you started with IoT Edge development with the IoT Edge Dev Container and IoT Edge Solution Scaffolding that contains a sample module and all the required configuration files.
  • It speeds up your inner-loop dev (dev, debug, test) by reducing multi-step build & deploy processes into one-line CLI commands and well as drive your outer-loop CI/CD pipeline. You can use all the same commands in both stages of your development life-cycle.

Overview

For the absolute fastest way to get started with IoT Edge Dev, please see the Quickstart section below.

For a more detailed overview of IoT Edge Dev Tool including setup and commands, please see the Wiki.

Quickstart

This quickstart will run a container, create a solution, setup Azure resources, build and deploy modules to your device, setup and start the Edge Runtime and then monitor messages flowing into IoT Hub.

Here's a 3 minute video walk-through of this Quickstart:

Azure IoT Edge Dev Tool: Quickstart

The only thing you need to install is Docker. All of the other dev dependencies are included in the container.

  1. Install Docker

    • Open Docker Settings and setup a Shared Drive that you'll use to store your IoT Edge Solution files.
  2. Run the Azure 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 microsoft/iotedgedev
    

    Linux

    sudo mkdir /home/iotedge
    docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v /home/iotedge:/home/iotedge microsoft/iotedgedev
    
  3. Initialize Edge Solution and Setup Azure Resources

    iotedgedev init

    'iotedgedev init' will run both 'iotedgedev solution .' and 'iotedgedev azure', which will create a solution and setup your Azure resource in a single comamnd.

  4. Build & Push IoT Edge Modules

    iotedgedev push

    You can also combine build, push and deploy with iotedgedev push --deploy

  5. Deploy Modules to IoT Edge Device

    iotedgedev deploy

  6. Start the IoT Edge Runtime

    iotedgedev start

  7. Monitor Messages sent from IoT Edge to IoT Hub

    iotedgedev monitor

Resources

Please refer to the Wiki for details on setup, usage, and troubleshooting.

Please refer to the Contributing file for details on contributing changes.