创建自定义使用流管理器的组件 - AWS IoT Greengrass
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

创建自定义使用流管理器的组件

在自定义 Greengrass 组件中使用流管理器来存储、处理和导出 IoT 设备数据。使用本节中的过程和示例创建与流管理器一起使用的组件配方、构件和应用程序。有关如何开发和测试组件的更多信息,请参阅创建自定义 AWS AWS IoT Greengrass 组件

定义使用流管理器的组件配方

要在自定义组件中使用流管理器,您必须将aws.greengrass.StreamManager组件定义为依赖项。您还必须提供 Stream Manager 开发工具包。完成以下任务,以所选语言下载并使用 Stream Manager 开发工具包。

适用于 Java 的 Stream Manager 开发工具包作为 JAR 文件提供,可用于编译组件。然后,您可以创建包含 Stream Manager 开发工具包的应用程序 JAR,将应用程序 JAR 定义为组件构件,并在组件生命周期中运行应用程序 JAR。

使用适用于 Java 的 Stream Manager 开发工具包

  1. 下载适用于 Java 的 Stream Manager 开发工具包 JAR 文件

  2. 执行以下操作之一以从 Java 应用程序和 Stream Manager 开发工具包 JAR 文件创建组件构件:

    • 将应用程序构建为包含 Stream Manager 开发工具包 JAR 的 JAR 文件,然后在组件配方中运行此 JAR 文件。

    • 将 Stream Manager 开发工具包 JAR 定义为组件构件。当您在组件配方中运行应用程序时,将该构件添加到类路径。

    您的组件配方可能类似于以下示例。此组件运行 StreamManagerS3.java 示例的修改版本,其中 StreamManagerS3.jar 包含 Stream Manager 开发工具包 JAR。

    JSON
    { "RecipeFormatVersion": "2020-01-25", "ComponentName": "com.example.StreamManagerS3Java", "ComponentVersion": "1.0.0", "ComponentDescription": "Uses stream manager to upload a file to an S3 bucket.", "ComponentPublisher": "Amazon", "ComponentDependencies": { "aws.greengrass.StreamManager": { "VersionRequirement": "^2.0.0" } }, "Manifests": [ { "Lifecycle": { "Run": "java -jar {artifacts:path}/StreamManagerS3.jar" }, "Artifacts": [ { "URI": "s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3Java/1.0.0/StreamManagerS3.jar" } ] } ] }
    YAML
    --- RecipeFormatVersion: '2020-01-25' ComponentName: com.example.StreamManagerS3Java ComponentVersion: 1.0.0 ComponentDescription: Uses stream manager to upload a file to an S3 bucket. ComponentPublisher: Amazon ComponentDependencies: aws.greengrass.StreamManager: VersionRequirement: "^2.0.0" Manifests: - Lifecycle: Run: java -jar {artifacts:path}/StreamManagerS3.jar Artifacts: - URI: s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3Java/1.0.0/StreamManagerS3.jar

    有关如何开发和测试组件的更多信息,请参阅创建自定义 AWS AWS IoT Greengrass 组件

适用于 Python 的 Stream Manager 开发工具包作为源代码提供,您可以将其包含在组件中。创建 Stream Manager 开发工具包的 ZIP 文件,将 ZIP 文件定义为组件构件,然后在组件生命周期中安装开发工具包的要求。

使用适用于 Python 的 Stream Manager 开发工具包

  1. 克隆或下载 aws-greengrass-stream-manager-sdk-python 存储库。

    git clone git@github.com:aws-greengrass/aws-greengrass-stream-manager-sdk-python.git
  2. 创建一个包含 stream_manager 文件夹的 ZIP 文件,该文件夹包含适用于 Python 的 Stream Manager 开发工具包的源代码。您可以将此 ZIP 文件作为 AWS AWS IoT Greengrass 核心软件在安装组件时解压缩的组件构件提供。执行以下操作:

    1. 打开包含您在上一步中克隆或下载的存储库的文件夹。

      cd aws-greengrass-stream-manager-sdk-python
    2. stream_manager文件夹压缩到名为 的 ZIP 文件中stream_manager_sdk.zip

      zip -r stream_manager_sdk.zip stream_manager
    3. 验证 stream_manager_sdk.zip 文件是否包含 stream_manager 文件夹及其内容。运行以下命令以列出 ZIP 文件的内容。

      unzip -l stream_manager_sdk.zip

      该输出值应该类似于以下内容。

      Archive: aws-greengrass-stream-manager-sdk-python/stream_manager.zip Length Date Time Name --------- ---------- ----- ---- 0 02-24-2021 20:45 stream_manager/ 913 02-24-2021 20:45 stream_manager/__init__.py 9719 02-24-2021 20:45 stream_manager/utilinternal.py 1412 02-24-2021 20:45 stream_manager/exceptions.py 1004 02-24-2021 20:45 stream_manager/util.py 0 02-24-2021 20:45 stream_manager/data/ 254463 02-24-2021 20:45 stream_manager/data/__init__.py 26515 02-24-2021 20:45 stream_manager/streammanagerclient.py --------- ------- 294026 8 files
  3. 将 Stream Manager 开发工具包构件复制到您的组件的构件文件夹中。除了 Stream Manager 开发工具包 ZIP 文件之外,您的组件还使用开发工具包的 requirements.txt 文件来安装 Stream Manager 开发工具包的依赖项。Replace ~/greengrass-components 替换为您用于本地开发的文件夹的路径。

    cp {stream_manager_sdk.zip,requirements.txt} ~/greengrass-components/artifacts/com.example.StreamManagerS3Python/1.0.0/
  4. 创建您的组件配方。在配方中,执行以下操作:

    1. stream_manager_sdk.ziprequirements.txt 定义为构件。

    2. 将 Python 应用程序定义为构件。

    3. 在安装生命周期中,从 安装 Stream Manager 开发工具包要求requirements.txt

    4. 在运行生命周期中,将 Stream Manager 开发工具包附加到 PYTHONPATH,然后运行您的 Python 应用程序。

    您的组件配方可能类似于以下示例。此组件运行 stream_manager_s3.py 示例。

    JSON
    { "RecipeFormatVersion": "2020-01-25", "ComponentName": "com.example.StreamManagerS3Python", "ComponentVersion": "1.0.0", "ComponentDescription": "Uses stream manager to upload a file to an S3 bucket.", "ComponentPublisher": "Amazon", "ComponentDependencies": { "aws.greengrass.StreamManager": { "VersionRequirement": "^2.0.0" } }, "Manifests": [ { "Platform": { "os": "linux" }, "Lifecycle": { "Install": "pip3 install --user -r {artifacts:path}/requirements.txt", "Run": "export PYTHONPATH=$PYTHONPATH:{artifacts:decompressedPath}/stream_manager_sdk; python3 {artifacts:path}/stream_manager_s3.py" }, "Artifacts": [ { "URI": "s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3Python/1.0.0/stream_manager_sdk.zip", "Unarchive": "ZIP" }, { "URI": "s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3Python/1.0.0/stream_manager_s3.py" }, { "URI": "s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3Python/1.0.0/requirements.txt" } ] } ] }
    YAML
    --- RecipeFormatVersion: '2020-01-25' ComponentName: com.example.StreamManagerS3Python ComponentVersion: 1.0.0 ComponentDescription: Uses stream manager to upload a file to an S3 bucket. ComponentPublisher: Amazon ComponentDependencies: aws.greengrass.StreamManager: VersionRequirement: "^2.0.0" Manifests: - Platform: os: linux Lifecycle: Install: pip3 install --user -r {artifacts:path}/requirements.txt Run: | export PYTHONPATH=$PYTHONPATH:{artifacts:decompressedPath}/stream_manager_sdk python3 {artifacts:path}/stream_manager_s3.py Artifacts: - URI: s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3Python/1.0.0/stream_manager_sdk.zip Unarchive: ZIP - URI: s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3Python/1.0.0/stream_manager_s3.py - URI: s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3Python/1.0.0/requirements.txt

    有关如何开发和测试组件的更多信息,请参阅创建自定义 AWS AWS IoT Greengrass 组件

适用于 JavaScript 的 Stream Manager 开发工具包作为源代码提供,您可以将其包含在组件中。创建 Stream Manager 开发工具包的 ZIP 文件,将 ZIP 文件定义为组件构件,然后在组件生命周期中安装开发工具包。

使用适用于 JavaScript 的 Stream Manager 开发工具包

  1. 克隆或下载 aws-greengrass-stream-manager-sdk-js 存储库。

    git clone git@github.com:aws-greengrass/aws-greengrass-stream-manager-sdk-js.git
  2. 创建一个包含 aws-greengrass-stream-manager-sdk 文件夹的 ZIP 文件,其中包含适用于 JavaScript 的 Stream Manager 开发工具包的源代码。您可以将此 ZIP 文件作为 AWS AWS IoT Greengrass 核心软件在安装组件时解压缩的组件构件提供。执行以下操作:

    1. 打开包含您在上一步中克隆或下载的存储库的文件夹。

      cd aws-greengrass-stream-manager-sdk-js
    2. aws-greengrass-stream-manager-sdk文件夹压缩到名为 的 ZIP 文件中stream-manager-sdk.zip

      zip -r stream-manager-sdk.zip aws-greengrass-stream-manager-sdk
    3. 验证 stream-manager-sdk.zip 文件是否包含 aws-greengrass-stream-manager-sdk 文件夹及其内容。运行以下命令以列出 ZIP 文件的内容。

      unzip -l stream-manager-sdk.zip

      该输出值应该类似于以下内容。

      Archive: stream-manager-sdk.zip Length Date Time Name --------- ---------- ----- ---- 0 02-24-2021 22:36 aws-greengrass-stream-manager-sdk/ 369 02-24-2021 22:36 aws-greengrass-stream-manager-sdk/package.json 1017 02-24-2021 22:36 aws-greengrass-stream-manager-sdk/util.js 8374 02-24-2021 22:36 aws-greengrass-stream-manager-sdk/utilInternal.js 1937 02-24-2021 22:36 aws-greengrass-stream-manager-sdk/exceptions.js 0 02-24-2021 22:36 aws-greengrass-stream-manager-sdk/data/ 353343 02-24-2021 22:36 aws-greengrass-stream-manager-sdk/data/index.js 22599 02-24-2021 22:36 aws-greengrass-stream-manager-sdk/client.js 216 02-24-2021 22:36 aws-greengrass-stream-manager-sdk/index.js --------- ------- 387855 9 files
  3. 将 Stream Manager 开发工具包构件复制到您的组件的构件文件夹中。Replace ~/greengrass-components 替换为您用于本地开发的文件夹的路径。

    cp stream-manager-sdk.zip ~/greengrass-components/artifacts/com.example.StreamManagerS3JS/1.0.0/
  4. 创建您的组件配方。在配方中,执行以下操作:

    1. stream-manager-sdk.zip 将 定义为构件。

    2. 将 JavaScript 应用程序定义为构件。

    3. 在安装生命周期中,从 stream-manager-sdk.zip 构件安装 Stream Manager 开发工具包。npm install 此命令将创建一个包含 Stream Manager 开发工具包及其依赖项的node_modules文件夹。

    4. 在运行生命周期中,将 node_modules 文件夹附加到 NODE_PATH,然后运行 JavaScript 应用程序。

    您的组件配方可能类似于以下示例。此组件运行 StreamManagerS3 示例。

    JSON
    { "RecipeFormatVersion": "2020-01-25", "ComponentName": "com.example.StreamManagerS3JS", "ComponentVersion": "1.0.0", "ComponentDescription": "Uses stream manager to upload a file to an S3 bucket.", "ComponentPublisher": "Amazon", "ComponentDependencies": { "aws.greengrass.StreamManager": { "VersionRequirement": "^2.0.0" } }, "Manifests": [ { "Platform": { "os": "linux" }, "Lifecycle": { "Install": "npm install {artifacts:decompressedPath}/stream-manager-sdk/aws-greengrass-stream-manager-sdk", "Run": "export NODE_PATH=$NODE_PATH:{work:path}/node_modules; node {artifacts:path}/index.js" }, "Artifacts": [ { "URI": "s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3JS/1.0.0/stream-manager-sdk.zip", "Unarchive": "ZIP" }, { "URI": "s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3JS/1.0.0/index.js" } ] } ] }
    YAML
    --- RecipeFormatVersion: '2020-01-25' ComponentName: com.example.StreamManagerS3JS ComponentVersion: 1.0.0 ComponentDescription: Uses stream manager to upload a file to an S3 bucket. ComponentPublisher: Amazon ComponentDependencies: aws.greengrass.StreamManager: VersionRequirement: "^2.0.0" Manifests: - Platform: os: linux Lifecycle: Install: npm install {artifacts:decompressedPath}/stream-manager-sdk/aws-greengrass-stream-manager-sdk Run: | export NODE_PATH=$NODE_PATH:{work:path}/node_modules node {artifacts:path}/index.js Artifacts: - URI: s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3JS/1.0.0/stream-manager-sdk.zip Unarchive: ZIP - URI: s3://DOC-EXAMPLE-BUCKET/artifacts/com.example.StreamManagerS3JS/1.0.0/index.js

    有关如何开发和测试组件的更多信息,请参阅创建自定义 AWS AWS IoT Greengrass 组件

在应用程序代码中连接到流管理器

要在应用程序中连接到流管理器StreamManagerClient,请从 Stream Manager 开发工具包创建 的实例。此客户端将连接到其默认端口 8088 上的流管理器组件或您指定的端口。有关如何在创建实例StreamManagerClient后使用 的更多信息,请参阅使用 StreamManagerClient 处理流

例 示例:使用默认端口连接到流管理器

Java
import com.amazonaws.greengrass.streammanager.client.StreamManagerClient; public class MyStreamManagerComponent { void connectToStreamManagerWithDefaultPort() { StreamManagerClient client = StreamManagerClientFactory.standard().build(); // Use the client. } }
Python
from stream_manager import ( StreamManagerClient ) def connect_to_stream_manager_with_default_port(): client = StreamManagerClient() # Use the client.
JavaScript
const { StreamManagerClient } = require('aws-greengrass-stream-manager-sdk'); function connectToStreamManagerWithDefaultPort() { const client = new StreamManagerClient(); // Use the client. }

例 示例:使用非默认端口 (Java) 连接到流管理器

如果您使用默认端口以外的端口配置流管理器,则必须使用进程间通信从组件配置中检索端口。

注意

port 配置参数包含您在部署流管理器STREAM_MANAGER_SERVER_PORT时在 中指定的值。

void connectToStreamManagerWithCustomPort() { EventStreamRPCConnection eventStreamRpcConnection = IPCUtils.getEventStreamRpcConnection(); GreengrassCoreIPCClient greengrassCoreIPCClient = new GreengrassCoreIPCClient(eventStreamRpcConnection); List<String> keyPath = new ArrayList<>(); keyPath.add("port"); GetConfigurationRequest request = new GetConfigurationRequest(); request.setComponentName("aws.greengrass.StreamManager"); request.setKeyPath(keyPath); GetConfigurationResponse response = greengrassCoreIPCClient.getConfiguration(request, Optional.empty()).getResponse().get(); String port = response.getValue().get("port").toString(); System.out.print("Stream Manager is running on port: " + port); final StreamManagerClientConfig config = StreamManagerClientConfig.builder() .serverInfo(StreamManagerServerInfo.builder().port(Integer.parseInt(port)).build()).build(); StreamManagerClient client = StreamManagerClientFactory.standard().withClientConfig(config).build(); // Use the client. }