跳转到主要内容

Azure IoT EdgeHub 开发工具

项目描述

Azure IoT EdgeHub 开发工具 Build Status

公告

Azure IoT EdgeHub 开发工具处于维护模式。有关更多详情,请参阅 此公告。我们建议使用VM、物理设备或 EFLOW

简介

Azure IoT EdgeHub 开发工具提供了一个用于创建、开发、测试、运行和调试Azure IoT Edge模块和解决方案的本地开发体验和模拟器。

模拟器允许您在本地运行、测试和调试自己的自定义IoT Edge模块,无需IoT Edge运行时,并具有以下优点:

  • 您的自定义Edge模块代码在模拟器和完整的IoT Edge运行时上运行时是相同的。
  • 您的Edge解决方案可以在本地运行,无需推送新镜像或创建IoT Edge部署清单。
  • 在模拟器上运行您的Edge解决方案所需的唯一凭据是IoT Edge设备连接字符串。不需要IoT Hub连接字符串。
  • 这有助于您在主机上调试自定义Edge模块,而不仅仅是容器中。

以下表格比较了在IoT Edge运行时和iotedgehubdev工具上运行您的解决方案的需求

IoT Edge运行时 iotedgehubdev
设备凭据是否需要
IoT Hub凭据是否需要
构建镜像
推送镜像
创建部署
支持原生调试场景

安装

  1. Docker CE (18.02.0+) 上安装WindowsmacOSLinux

  2. 安装Docker Compose (1.20.0+) (仅限Linux。Compose已经包含在Windows/macOS Docker CE安装中)

  3. 安装Python (3.5/3.6/3.7/3.8/3.9) 和 Pip

  4. 在您的终端中运行以下命令安装iotedgehubdev

    pip install --upgrade iotedgehubdev
    
  5. 确保用户是docker用户组成员(仅限Linux / MacOS)

    sudo usermod -aG docker $USER
    

请确保在运行iotedgehubdev的同一台机器上没有Azure IoT Edge运行时,因为它们需要相同的端口。

快速入门

1. 设置

iotedgehubdev setup -c "<edge-device-connection-string>"

2. 在模拟器中启动/停止IoT Edge解决方案

iotedgehubdev start -d <path/to/deployment-manifest>
iotedgehubdev stop

3. 原生启动和调试单个模块

  1. 使用特定的输入(和/或环境变量)启动模块

    iotedgehubdev start -i "<module-inputs>"
    
    // OR
    
    iotedgehubdev start -i "<module-inputs>" -e "<environment-variable>"
    

    例如:
    iotedgehubdev start -i "input1,input2" -e "TestEnv1=Value1" -e "TestEnv2=Value2"

  2. 输出模块凭据环境变量

    iotedgehubdev modulecred
    
  3. 使用上一步中获取的环境变量原生启动您的模块

  4. 通过RESTful API向您的模块发送消息

    例如:
    curl --header "Content-Type: application/json" --request POST --data '{"inputName": "input1","data": "hello world"}' http://localhost:53000/api/v1/messages

  5. 停止模拟器

    iotedgehubdev stop
    

其他资源

数据/遥测

此项目收集使用数据并将其发送到微软,以帮助改进我们的产品和服务。有关更多信息,请阅读我们的隐私声明。如果您不希望向微软发送使用数据,可以通过在ini文件中将collect_telemetry更新为no来更改遥测设置。

贡献

此项目欢迎贡献和建议。大多数贡献都需要您同意贡献者许可协议(CLA),声明您有权利,并且实际上确实授予我们使用您贡献的权利。有关详细信息,请访问https://cla.microsoft.com

当您提交拉取请求时,CLA机器人将自动确定您是否需要提供CLA,并相应地装饰PR(例如,标签、注释)。只需遵循机器人提供的说明即可。您只需在整个使用我们的CLA的存储库中进行一次即可。

此项目采用了微软开源行为准则。有关更多信息,请参阅行为准则常见问题解答或联系opencode@microsoft.com,提出任何其他问题或评论。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分布

iotedgehubdev-v0.14.18-win32-ia32.zip (24.5 MB 查看哈希值)

上传时间

构建分布

iotedgehubdev-0.14.18-py3-none-any.whl (38.3 kB 查看哈希值)

上传时间 Python 3

支持者