|
1 | 1 |
|
2 | 2 | # Azure IoT EdgeHub Dev Tool [](https://travis-ci.com/Azure/iotedgehubdev) |
3 | | -The Azure IoT EdgeHub Dev Tool provides a simulated EdgeHub environment for developing Edge moduls and solutions. |
| 3 | +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. |
4 | 4 | - The Edge solution could be run with the simulated EdgeHub locally without pushing image and creating deployment |
5 | 5 | - It helps to debug the module on the host (not in container) with the EdgeHub |
6 | 6 |
|
7 | | -## Quickstart |
8 | | -### Prerequisite |
9 | | -#### 1. **Install Docker** |
10 | | -- Note: On Windows, please make sure the Docker is in **Linux mode**. |
11 | | -#### 2. **Install Python (2.7/3.6)** |
12 | | -#### 3. **Install iotedgehubdev** |
13 | | - |
| 7 | +## Installing |
| 8 | +1. Install [Docker CE](https://www.docker.com/community-edition) on Windows, macOS or Linux. |
| 9 | + > Note: On Windows, please make sure the Docker is in **Linux mode**. |
| 10 | +2. Install [Python (2.7/3.6) and Pip](https://www.python.org/) |
| 11 | +3. Install iotedgehubdev by running below command in your terminal |
| 12 | + ``` |
14 | 13 | pip install --upgrade iotedgehubdev |
| 14 | + ``` |
15 | 15 |
|
16 | | -### Run Tool |
17 | | -#### Setup |
18 | | -- `iotedgehubdev setup -c <edge-device-connection-string>` |
19 | | - |
20 | | -#### Run an IoT Edge Solution in Simulator |
21 | | -- `iotedgehubdev start -d <path/to/deployment manifest>` |
22 | | -- `iotedgehubdev stop` |
23 | | - |
24 | | -#### Run/Debug a single module natively |
25 | | -- `iotedgehubdev start -i <module-inputs>` |
26 | | - |
27 | | - For example: |
28 | | - |
29 | | - `iotedgehubdev start -i "input1,input2"` |
30 | | - |
31 | | -- `iotedgehubdev modulecred` |
32 | | - |
33 | | - It will output the module credential environment variables. |
34 | | - |
35 | | -- Start the module natively with the environment variables got from previous step |
36 | | -- Send message to the module through restful api. |
37 | | - |
38 | | - For example: |
39 | | - |
| 16 | +## Quickstart |
| 17 | +1. Setup |
| 18 | + ``` |
| 19 | + iotedgehubdev setup -c <edge-device-connection-string> |
| 20 | + ``` |
| 21 | +
|
| 22 | +2. Start/Stop an IoT Edge Solution in simulator |
| 23 | + ``` |
| 24 | + iotedgehubdev start -d <path/to/deployment manifest> |
| 25 | + iotedgehubdev stop |
| 26 | + ``` |
| 27 | +
|
| 28 | +3. Start and debug a single module natively |
| 29 | + 1. Start the module with specific input(s) |
| 30 | + ``` |
| 31 | + iotedgehubdev start -i <module-inputs> |
| 32 | + ``` |
| 33 | +
|
| 34 | + For example: `iotedgehubdev start -i "input1,input2"` |
| 35 | + |
| 36 | + 2. output the module credential environment variables |
| 37 | +
|
| 38 | + ``` |
| 39 | + iotedgehubdev modulecred |
| 40 | + ``` |
| 41 | +
|
| 42 | + 3. Start the module natively with the environment variables got from previous step |
| 43 | + 4. Send message to the module through restful api. |
| 44 | +
|
| 45 | + For example: |
40 | 46 | `curl --header "Content-Type: application/json" --request POST --data '{"inputName": "input1","data": "hello world"}' http://localhost:53000/api/v1/messages` |
41 | | - |
| 47 | + |
| 48 | +## Other resources |
| 49 | +- [Azure IoT Edge for Visual Studio Code](https://github.com/microsoft/vscode-azure-iot-edge) |
| 50 | +- [Azure IoT Edge Dev CLI Tool](https://github.com/azure/iotedgedev) |
| 51 | +
|
| 52 | +## Data/Telemetry |
| 53 | +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. |
| 54 | +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. |
0 commit comments