设备管理入门 (Python)

后端应用可以使用 Azure IoT 中心基元(例如设备孪生直接方法)远程启动和监视设备上的设备管理操作。 本教程说明后端应用和设备应用如何协同工作,以便使用 IoT 中心发起远程设备重启操作并对其进行监视。

备注

本文所述的功能只能用于 IoT 中心的标准层。 有关 IoT 中心基本层和标准/免费层的详细信息,请参阅选择合适的 IoT 中心层

使用直接方法可从云中的后端应用启动设备管理操作(例如重新启动、恢复出厂设置以及固件更新)。 设备负责以下操作:

  • 处理从 IoT 中心发送的方法请求。
  • 在设备上启动相应的设备特定操作。
  • 通过向 IoT 中心 报告的属性,提供状态更新。

可以使用云中的后端应用运行设备克隆查询,以报告设备管理操作的进度。

本教程演示如何:

  • 使用 Azure 门户创建 IoT 中心,以及如何在 IoT 中心创建设备标识。
  • 创建包含重新启动该设备的直接方法的模拟设备应用。 直接方法是从云中调用的。
  • 创建一个 Python 控制台应用,它通过 IoT 中心调用模拟设备应用中的重新启动直接方法。

在本教程结束时,会获得两个 Python 控制台应用:

  • dmpatterns_getstarted_device.py,它使用先前创建的设备标识连接到 IoT 中心,接收重新启动直接方法,模拟物理重新启动,并报告上次重新启动的时间。

  • dmpatterns_getstarted_service.py,它调用模拟设备应用中的直接方法,显示响应,并显示更新后的报告属性。

备注

IoT 中心通过 Azure IoT 设备 SDK 对许多设备平台和语言(包括 C、Java、Javascript 和 Python)提供 SDK 支持。 有关如何使用 Python 将设备连接到本教程中的代码(通常是连接到 Azure IoT 中心)的说明,请参阅 Azure IoT Python SDK

先决条件

  • 确保已在防火墙中打开端口 8883。 本文中的设备示例使用 MQTT 协议,该协议通过端口 8883 进行通信。 在某些公司和教育网络环境中,此端口可能被阻止。 有关解决此问题的更多信息和方法,请参阅连接到 IoT 中心(MQTT)

创建 IoT 中心

此部分介绍如何使用 Azure 门户创建 IoT 中心。

  1. 登录 Azure 门户

  2. 从 Azure 主页中选择“+ 创建资源”按钮,然后在“搜索市场”字段中输入“IoT 中心”。

  3. 在搜索结果中选择“IoT 中心”,然后选择“创建” 。

  4. 在“基本信息”选项卡上,按如下所示填写字段:

    • 订阅:选择要用于中心的订阅。

    • 资源组:选择一个资源组或新建一个资源组。 若要新建资源组,请选择“新建”并填写要使用的名称。 若要使用现有的资源组,请选择它。 有关详细信息,请参阅管理 Azure 资源管理器资源组

    • 区域:选择中心所在的区域。 选择最靠近你的位置。

    • IoT 中心名称:输入中心的名称。 该名称必须全局唯一。 如果输入的名称可用,会显示一个绿色复选标记。

    重要

    IoT 中心将公开为 DNS 终结点,因此,命名时请务必避免包含任何敏感信息。

    在 Azure 门户中创建中心

  5. 在完成时选择“下一步:大小和规模”,以继续创建中心。

    使用 Azure 门户为新的中心设置大小和规模

    可在此处接受默认设置。 如果需要,可以修改以下任何字段:

    • 定价和缩放层:选择的层。 可以根据你需要的功能数以及每天通过解决方案发送的消息数从多个层级中进行选择。 免费层适用于测试和评估。 允许 500 台设备连接到中心,每天最多可传输 8,000 条消息。 每个 Azure 订阅可以在免费层中创建一个 IoT 中心。

      如果正在完成 IoT 中心设备流的快速入门,请选择免费层。

    • IoT 中心单元:每日每单位允许的消息数取决于中心的定价层。 例如,如果希望中心支持 700,000 条消息引入,请选择两个 S1 层单位。 有关其他层选项的详细信息,请参阅选择合适的 IoT 中心层

    • 高级设置 > 设备到云的分区:此属性将设备到云消息与这些消息的同步读取器数目相关联。 大多数中心只需要 4 个分区。

  6. 在完成时选择“下一步:标记”继续到下一屏幕。

    标记是名称/值对。 可以为多个资源和资源组分配相同的标记,以便对资源进行分类并合并计费。 有关详细信息,请参阅使用标记来组织 Azure 资源

    使用 Azure 门户为新的中心设置大小和规模

  7. 在完成时选择“下一步:查看+创建”可查看选择。 你会看到类似于此屏幕的内容,但其中包含创建中心时选择的值。

    查看用于创建新中心的信息

  8. 选择“创建”以创建新的中心。 创建中心需要几分钟时间。

在 IoT 中心内注册新设备

在本部分中,将使用 Azure CLI 为本文创建设备标识。 设备 ID 区分大小写。

  1. 运行以下命令以安装适用于 Azure CLI 的 Microsoft Azure IoT 扩展:

    az extension add --name azure-iot
    
  2. 使用以下命令创建一个名为 myDeviceId 的新设备标识并检索设备连接字符串:

    az iot hub device-identity create --device-id myDeviceId --hub-name {Your IoT Hub name}
    az iot hub device-identity show-connection-string --device-id myDeviceId --hub-name {Your IoT Hub name} -o table
    

    重要

    收集的日志中可能会显示设备 ID 用于客户支持和故障排除,因此,在为日志命名时,请务必避免包含任何敏感信息。

记下结果中的设备连接字符串。 设备应用使用此设备连接字符串以设备身份连接到 IoT 中心。

创建模拟设备应用程序

本部分的操作:

  • 创建一个 Python 控制台应用,用于响应通过云调用的直接方法
  • 模拟设备重新启动
  • 通过报告的属性,设备孪生查询可标识设备及设备上次重新启动的时间
  1. 在命令提示符处,运行以下命令以安装 azure-iot-device 包:

    pip install azure-iot-device
    
  2. 使用文本编辑器,在工作目录中创建名为 dmpatterns_getstarted_device.py 的文件。

  3. dmpatterns_getstarted_device.py 文件开头添加以下 import 语句。

    import time
    import datetime
    from azure.iot.device import IoTHubDeviceClient, MethodResponse
    
  4. 添加 CONNECTION_STRING 变量。 将 {deviceConnectionString} 占位符值替换为设备连接字符串。 以前在在 IoT 中心内注册新设备中复制了此连接字符串。

    CONNECTION_STRING = "{deviceConnectionString}"
    
  5. 添加以下函数以实例化为设备上的直接方法配置的客户端。

    def create_client():
        # Instantiate the client
        client = IoTHubDeviceClient.create_from_connection_string(CONNECTION_STRING)
    
        # Define the handler for method requests
        def method_request_handler(method_request):
            if method_request.name == "rebootDevice":
                # Act on the method by rebooting the device
                print("Rebooting device")
                time.sleep(20)
                print("Device rebooted")
    
                # ...and patching the reported properties
                current_time = str(datetime.datetime.now())
                reported_props = {"rebootTime": current_time}
                client.patch_twin_reported_properties(reported_props)
                print( "Device twins updated with latest rebootTime")
    
                # Create a method response indicating the method request was resolved
                resp_status = 200
                resp_payload = {"Response": "This is the response from the device"}
                method_response = MethodResponse(method_request.request_id, resp_status, resp_payload)
    
            else:
                # Create a method response indicating the method request was for an unknown method
                resp_status = 404
                resp_payload = {"Response": "Unknown method"}
                method_response = MethodResponse(method_request.request_id, resp_status, resp_payload)
    
            # Send the method response
            client.send_method_response(method_response)
    
        try:
            # Attach the handler to the client
            client.on_method_request_received = method_request_handler
        except:
            # In the event of failure, clean up
            client.shutdown()
    
        return client
    
  6. 启动直接方法示例并等待。

    def main():
        print ("Starting the IoT Hub Python sample...")
        client = create_client()
    
        print ("Waiting for commands, press Ctrl-C to exit")
        try:
            # Wait for program exit
            while True:
                time.sleep(1000)
        except KeyboardInterrupt:
            print("IoTHubDeviceClient sample stopped")
        finally:
            # Graceful exit
            print("Shutting down IoT Hub Client")
            client.shutdown()
    
    if __name__ == '__main__':
        main()
    
  7. 保存并关闭 dmpatterns_getstarted_device.py 文件。

备注

为简单起见,本教程不实现任何重试策略。 在生产代码中,应该按文章暂时性故障处理中所述实施重试策略(例如指数退避)。

获取 IoT 中心连接字符串

在本文中,你将创建一个在设备上调用直接方法的后端服务。 若要通过 IoT 中心在设备上调用直接方法,服务需要“服务连接” 权限。 默认情况下,每个 IoT 中心都使用名为 service 的共享访问策略创建,该策略授予此权限。

若要获取 service 策略的 IoT 中心连接字符串,请执行以下步骤:

  1. Azure 门户中,选择“资源组” 。 选择中心所在的资源组,然后从资源列表中选择中心。

  2. 在 IoT 中心的左侧窗格中,选择“共享访问策略” 。

  3. 从策略列表中选择“service” 策略。

  4. 在“共享访问密钥” 下,选择“连接字符串 - 主密钥” 所对应的“复制”图标并保存该值。

    显示如何检索连接字符串

有关 IoT 中心共享访问策略和权限的详细信息,请参阅访问控制和权限

使用直接方法在设备上触发远程重新启动

此部分将创建一个 Python 控制台应用,以使用直接方法在设备上启动远程重新启动。 该应用使用设备孪生查询来搜索该设备的上次重新启动时间。

  1. 在命令提示符处,运行以下命令以安装 azure-iot-hub 包:

    pip install azure-iot-hub
    
  2. 使用文本编辑器,在工作目录中创建名为 dmpatterns_getstarted_service.py 的文件。

  3. dmpatterns_getstarted_service.py 文件开头添加以下 import 语句。

    import sys, time
    
    from azure.iot.hub import IoTHubRegistryManager
    from azure.iot.hub.models import CloudToDeviceMethod, CloudToDeviceMethodResult, Twin
    
  4. 添加以下变量声明。 将 {IoTHubConnectionString} 占位符值替换为以前在获取 IoT 中心连接字符串中复制的 IoT 中心连接字符串。 将 {deviceId} 占位符值替换为在在 IoT 中心内注册新设备中注册的设备 ID。

    CONNECTION_STRING = "{IoTHubConnectionString}"
    DEVICE_ID = "{deviceId}"
    
    METHOD_NAME = "rebootDevice"
    METHOD_PAYLOAD = "{\"method_number\":\"42\"}"
    TIMEOUT = 60
    WAIT_COUNT = 10
    
  5. 添加以下函数以调用设备方法重新启动目标设备,然后查询设备孪生并获取上次重新启动时间。

    def iothub_devicemethod_sample_run():
        try:
            # Create IoTHubRegistryManager
            registry_manager = IoTHubRegistryManager(CONNECTION_STRING)
    
            print ( "" )
            print ( "Invoking device to reboot..." )
    
            # Call the direct method.
            deviceMethod = CloudToDeviceMethod(method_name=METHOD_NAME, payload=METHOD_PAYLOAD)
            response = registry_manager.invoke_device_method(DEVICE_ID, deviceMethod)
    
            print ( "" )
            print ( "Successfully invoked the device to reboot." )
    
            print ( "" )
            print ( response.payload )
    
            while True:
                print ( "" )
                print ( "IoTHubClient waiting for commands, press Ctrl-C to exit" )
    
                status_counter = 0
                while status_counter <= WAIT_COUNT:
                    twin_info = registry_manager.get_twin(DEVICE_ID)
    
                    if twin_info.properties.reported.get("rebootTime") != None :
                        print ("Last reboot time: " + twin_info.properties.reported.get("rebootTime"))
                    else:
                        print ("Waiting for device to report last reboot time...")
    
                    time.sleep(5)
                    status_counter += 1
    
        except Exception as ex:
            print ( "" )
            print ( "Unexpected error {0}".format(ex) )
            return
        except KeyboardInterrupt:
            print ( "" )
            print ( "IoTHubDeviceMethod sample stopped" )
    
    if __name__ == '__main__':
        print ( "Starting the IoT Hub Service Client DeviceManagement Python sample..." )
        print ( "    Connection string = {0}".format(CONNECTION_STRING) )
        print ( "    Device ID         = {0}".format(DEVICE_ID) )
    
        iothub_devicemethod_sample_run()
    
  6. 保存并关闭 dmpatterns_getstarted_service.py 文件。

运行应用

现在可以运行应用了。

  1. 在命令提示符处,运行以下命令以开始侦听重新启动直接方法。

    python dmpatterns_getstarted_device.py
    
  2. 在另一个命令提示符处,运行以下命令以触发远程重新启动并查询设备孪生以查找上次重新启动时间。

    python dmpatterns_getstarted_service.py
    
  3. 可在控制台查看对直接方法的设备响应。

    下面显示了对重新启动直接方法的设备响应:

    模拟设备应用输出

    下面显示服务调用重新启动直接方法并轮询设备孪生以获取状态:

    触发重新启动服务输出

自定义和扩展设备管理操作

IoT 解决方案可扩展已定义的设备管理模式集,或通过使用设备孪生和云到设备方法基元启用自定义模式。 设备管理操作的其他示例包括恢复出厂设置、固件更新、软件更新、电源管理、网络和连接管理以及数据加密。

设备维护时段

通常情况下,将设备配置为在某一时间执行操作,以最大程度减少中断和停机时间。 设备维护时段是一种常用模式,用于定义设备应更新其配置的时间。 后端解决方案使用设备克隆所需属性在设备上定义并激活策略,以启用维护时段。 当设备收到维护时段策略时,它可以使用设备克隆报告属性报告策略状态。 然后,后端应用可以使用设备克隆查询来证明设备和每个策略的符合性。

后续步骤

在本教程中,将使用直接方法触发设备上的远程重新启动。 使用报告属性报告设备上次重新启动时间,并查询设备孪生从云中发现设备上次重新启动时间。

若要继续完成 IoT 中心和设备管理模式(如远程无线固件更新)的入门内容,请参阅如何更新固件

若要了解如何扩展 IoT 解决方案并在多个设备上计划方法调用,请参阅计划和广播作业