Azure IoT EdgeHub Dev Tool
Project description
# Azure IoT EdgeHub Dev Tool [![Build Status](https://travis-ci.com/Azure/iotedgehubdev.svg?token=KySEv4A21JkyzbCKjpFW&branch=master)](https://travis-ci.com/Azure/iotedgehubdev)
The Azure IoT EdgeHub Dev Tool provide a local development experience with a simulated EdgeHub environment for creating, developing, testing, running, and debugging Azure IoT Edge modules and solutions.
- The Edge solution could be run with the simulated EdgeHub 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](https://www.docker.com/community-edition) on Windows, macOS or Linux.
> Note: On Windows, please make sure the Docker is in **Linux mode**.
2. Install [Python (2.7/3.6) and Pip](https://www.python.org/)
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
- [Azure IoT Edge for Visual Studio Code](https://github.com/microsoft/vscode-azure-iot-edge)
- [Azure IoT Edge Dev CLI Tool](https://github.com/azure/iotedgedev)
## Data/Telemetry
This project collects usage data and sends it to Microsoft to help improve our products and services. Read our [privacy statement](http://go.microsoft.com/fwlink/?LinkId=521839) 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.
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
The Azure IoT EdgeHub Dev Tool provide a local development experience with a simulated EdgeHub environment for creating, developing, testing, running, and debugging Azure IoT Edge modules and solutions.
- The Edge solution could be run with the simulated EdgeHub 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](https://www.docker.com/community-edition) on Windows, macOS or Linux.
> Note: On Windows, please make sure the Docker is in **Linux mode**.
2. Install [Python (2.7/3.6) and Pip](https://www.python.org/)
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
- [Azure IoT Edge for Visual Studio Code](https://github.com/microsoft/vscode-azure-iot-edge)
- [Azure IoT Edge Dev CLI Tool](https://github.com/azure/iotedgedev)
## Data/Telemetry
This project collects usage data and sends it to Microsoft to help improve our products and services. Read our [privacy statement](http://go.microsoft.com/fwlink/?LinkId=521839) 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.
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Project details
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
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
File details
Details for the file iotedgehubdev-0.1.0-py2.py3-none-any.whl
.
File metadata
- Download URL: iotedgehubdev-0.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 28.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa2112d5296931ea9cea82bbf554e9c7ba1bd73c641fc8511a81659534b02389 |
|
MD5 | e91c73cec168411dac1deb38029ff975 |
|
BLAKE2b-256 | ab2866cbeb631bcd09ab42f08c3329aa8fed6bbb3a4f02ada71a13bfd439a62c |