使用 IoT 中心将文件从设备上传到云

此教程介绍了如何使用 IoT 中心的文件上传功能将文件上传到 Azure Blob 存储。 本教程介绍如何:

  • 安全地提供存储容器用于文件上传。
  • 使用 Python 客户端通过 IoT 中心上传文件。

IoT 中心入门教程展示了 IoT 中心基本的设备到云消息功能。 但是,在某些情况下,无法轻松地将设备发送的数据映射为 IoT 中心接受的相对较小的设备到云消息。 需要从设备上传文件时,仍可以使用 IoT 中心的安全性和可靠性。

Note

IoT 中心 Python SDK 目前仅支持上传基于字符的文件,如 .txt 文件。

在本教程最后,会运行下述 Python 控制台应用:

  • FileUpload.py,该应用使用 Python 设备 SDK 将文件上传到存储中。

Note

IoT 中心通过 Azure IoT 设备 SDK 来支持许多设备平台和语言(包括 C、.NET、Javascript、Python 和 Java)。 有关如何将设备连接到 Azure IoT 中心的分步说明,请参阅 Azure IoT 开发人员中心

要完成本教程,需要以下各项:

创建 IoT 中心

创建模拟设备应用要连接到的 IoT 中心。 以下步骤说明如何使用 Azure 门户来完成此任务。

  1. 登录到 Azure 门户

  2. 选择“创建资源” > “物联网” > “IoT 中心”。

    Azure 门户跳转栏

  3. 在“IoT 中心”窗格中,输入 IoT 中心的以下信息:

    • 订阅:选择需要将其用于创建此 IoT 中心的订阅。

    • 资源组:创建用于托管 IoT 中心的资源组,或使用现有的资源组。 有关详细信息,请参阅使用资源组管理 Azure 资源

    • 区域:选择最近的位置。

    • 名称:创建 IoT 中心的名称。 如果输入的名称可用,会显示一个绿色复选标记。

    Important

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

    IoT 中心基本信息窗口

  4. 选择“下一步: 大小和规模”,以便继续创建 IoT 中心。

  5. 选择“定价和缩放层”。 就本文来说,请选择“F1 - 免费”层(前提是此层在订阅上仍然可用)。 有关详细信息,请参阅定价和缩放层

    IoT 中心大小和规模窗口

  6. 选择“查看 + 创建”。

  7. 查看 IoT 中心信息,然后单击“创建”。 创建 IoT 中心可能需要数分钟的时间。 可在“通知”窗格中监视进度。

  8. 新的 IoT 中心就绪以后,请在 Azure 门户中单击其磁贴,打开其属性窗口。 创建 IoT 中心以后,即可找到将设备和应用程序连接到 IoT 中心时需要使用的重要信息。 单击“共享访问策略”。

  9. 在“共享访问策略”中,选择 iothubowner 策略。 复制 IoT 中心连接字符串 ---主密钥供以后使用。 有关详细信息,请参阅“IoT 中心开发人员指南”中的访问控制

    共享访问策略

创建设备标识

在本部分中,将使用 Azure 门户在 IoT 中心的标识注册表中创建设备标识。 设备无法连接到 IoT 中心,除非它在标识注册表中具有条目。 有关详细信息,请参阅 IoT 中心开发人员指南的“标识注册表”部分。 使用门户中的“IoT 设备”面板为设备生成唯一设备 ID 和密钥,以用于在 IoT 中心中标识它本身。 设备 ID 区分大小写。

  1. 登录到 Azure 门户

  2. 选择“所有资源”,并查找 IoT 中心资源。

  3. 打开 IoT 中心资源后,单击“IoT 设备”工具,并单击顶部的“添加”。

    在门户中创建设备标识

  4. 提供新设备的名称(例如 myDeviceId),然后单击“保存”。 此操作会为 IoT 中心创建新设备标识。

    Important

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

    添加新设备

  5. 在设备列表中,单击新创建的设备,复制“连接字符串---主键”供以后使用。

    设备连接字符串

Note

IoT 中心标识注册表仅存储用于实现 IoT 中心安全访问的设备标识。 它存储设备 ID 和密钥作为安全凭据,以及启用/禁用标志让你禁用对单个设备的访问。 如果应用程序需要存储其他特定于设备的元数据,则应使用特定于应用程序的存储。 有关详细信息,请参阅 IoT 中心开发人员指南

将 Azure 存储帐户关联到 IoT 中心

由于模拟设备应用将文件上传到 Blob,因此必须拥有与 IoT 中心关联的 Azure 存储帐户。 将 Azure 存储帐户与 IoT 中心相关联时,IoT 中心会生成一个 SAS URI。 设备可以使用此 SAS URI 安全地将文件上传到 Blob 容器。 IoT 中心服务和设备 SDK 协调生成 SAS URI 的过程,并使其可供设备用来上传文件。

按照通过 Azure 门户配置文件上传中的说明,将 Azure 存储帐户关联到 IoT 中心。 确保有一个 Blob 容器与 IoT 中心关联并且已启用文件通知。

在门户中启用文件通知

从设备应用上传文件

本部分中操作将会创建可将文件上传到 IoT 中心的设备应用。

  1. 在命令提示符处,运行以下命令来安装 azure-iothub-device-client 包:

    pip install azure-iothub-device-client
    
  2. 使用文本编辑器,在工作文件夹中创建一个 FileUpload.py 文件。

  3. 在 FileUpload.py 文件的开头添加以下 import 语句和变量。 将 deviceConnectionString 替换为 IoT 中心设备的连接字符串:

    import time
    import sys
    import iothub_client
    import os
    from iothub_client import IoTHubClient, IoTHubClientError, IoTHubTransportProvider, IoTHubClientResult, IoTHubError
    
    CONNECTION_STRING = "[Device Connection String]"
    PROTOCOL = IoTHubTransportProvider.HTTP
    
    PATHTOFILE = "[Full path to file]"
    FILENAME = "[File name on storage after upload]"
    
  4. 针对 upload_blob 函数创建一个回调:

    def blob_upload_conf_callback(result, user_context):
        if str(result) == 'OK':
            print ( "...file uploaded successfully." )
        else:
            print ( "...file upload callback returned: " + str(result) )
    
  5. 添加以下代码用于连接客户端和上传文件。 此外还包含 main 例程:

    def iothub_file_upload_sample_run():
        try:
            print ( "IoT Hub file upload sample, press Ctrl-C to exit" )
    
            client = IoTHubClient(CONNECTION_STRING, PROTOCOL)
    
            f = open(PATHTOFILE, "r")
            content = f.read()
    
            client.upload_blob_async(FILENAME, content, len(content), blob_upload_conf_callback, 0)
    
            print ( "" )
            print ( "File upload initiated..." )
    
            while True:
                time.sleep(30)
    
        except IoTHubError as iothub_error:
            print ( "Unexpected error %s from IoTHub" % iothub_error )
            return
        except KeyboardInterrupt:
            print ( "IoTHubClient sample stopped" )
        except:
            print ( "generic error" )
    
    if __name__ == '__main__':
        print ( "Simulating a file upload using the Azure IoT Hub Device SDK for Python" )
        print ( "    Protocol %s" % PROTOCOL )
        print ( "    Connection string=%s" % CONNECTION_STRING )
    
        iothub_file_upload_sample_run()
    
  6. 保存并关闭 UploadFile.py 文件。

  7. 将示例文本文件复制到工作文件夹,并将其重命名为 sample.txt

    Note

    IoT 中心 Python SDK 目前仅支持上传基于字符的文件,如 .txt 文件。

运行应用程序

现即可运行应用程序。

  1. 在工作文件夹的命令提示符处,运行以下命令:

    python FileUpload.py
    
  2. 以下屏幕截图显示来自 FileUpload 应用的输出:

    simulated-device 应用的输出

  3. 可以使用门户查看所配置的存储容器中上传的文件:

    上传的文件

后续步骤

在本教程中,已学习了如何使用 IoT 中心的文件上传功能来简化从设备进行的文件上传。 可以使用以下文章继续探索 IoT 中心功能和方案: