创建 Amazon IoT Greengrass 组件

如果尚未安装 GDK CLI，请在开发计算机上进行安装。有关更多信息，请参阅 安装或更新 Amazon IoT Greengrass 开发套件命令行界面。

更改为要在其中创建组件文件夹的文件夹。

选择要下载的组件模板或社区组件。GDK CLI 下载模板或社区组件，因此您可以从功能示例开始。使用 component list 命令检索可用模板或社区组件的列表。

• 要列出组件模板，请运行以下命令。响应中的每一行都包含模板的名称和编程语言。

  gdk component list --template

• 要列出社区组件，请运行以下命令。

  gdk component list --repository

创建并更改为供 GDK CLI 下载模板或社区组件的组件文件夹。HelloWorld替换为组件的名称或其他可帮助您识别此组件文件夹的名称。

将模板或社区组件下载到当前文件夹。使用 component init 命令。

• 要从模板创建组件文件夹，请运行以下命令。HelloWorld替换为模板的名称，然后python替换为编程语言的名称。

  gdk component init --template HelloWorld --language python

• 要从社区组件创建组件文件夹，请运行以下命令。ComponentName替换为社区组件的名称。

  gdk component init --repository ComponentName

GDK CLI 从名为 gdk-config.json 的 GDK CLI 配置文件中读取数据，以生成和发布组件。此配置文件存在于组件文件夹的根目录中。在上一步中，将为您创建此文件。在这一步中，使用组件的相关信息更新 gdk-config.json。执行以下操作：

1. 在文本编辑器中打开 gdk-config.json。

2. （可选）更改组件的名称。组件名称是 component 对象中的关键。

3. 更改组件的作者。

4. （可选）更改组件的版本。指定下列项之一：

   • NEXT_PATCH – 当您选择此选项时，GDK CLI 将在您发布组件时设置版本。GDK CLI 会查询 Amazon IoT Greengrass 服务以识别该组件的最新发布版本。然后，它将版本设置为该版本之后的下一个补丁版本。如果您之前没有发布过组件，GDK CLI 将使用版本 1.0.0。

     如果选择此选项，则无法使用 Greengrass CLI 在本地部署该组件并将其测试到运行 Core 软件的本地开发计算机上。 Amazon IoT Greengrass 要启用本地部署，您必须改为指定语义版本。

   • 语义版本，例如 1.0.0。语义版本使用 major.minor.patch 编号系统。有关更多信息，请参阅语义版本规范。

     如果在要为其部署和测试组件的 Greengrass 核心设备上开发组件，请选择此选项。您必须使用特定版本构建组件，才能通过 Greengrass CLI 创建本地部署。

5. （可选）更改组件的构建配置。构建配置定义了 GDK CLI 如何将组件的源代码构建到构件中。对于 build_system，您可以从以下选项中进行选择：

   • zip – 将组件的文件夹打包成 ZIP 文件以定义为该组件的唯一构件。为以下类型的组件选择此选项：

     • 使用解释型编程语言的组件，例如 Python 或 JavaScript。

     • 用于打包除代码之外的文件的组件，例如机器学习模型或其他资源。

     GDK CLI 将组件的文件夹压缩成与组件文件夹同名的 zip 文件。例如，如果组件文件夹的名称为 HelloWorld，则 GDK CLI 会创建名为 HelloWorld.zip 的 zip 文件。

     注意

     如果在 Windows 设备上使用 GDK CLI 版本 1.0.0，则组件文件夹名称和 zip 文件名称必须仅包含小写字母。

     当 GDK CLI 将组件的文件夹压缩成 zip 文件时，系统会跳过以下文件：

     • gdk-config.json 文件

     • 配方文件（recipe.json 或 recipe.yaml）

     • 构建文件夹，例如 greengrass-build

   • maven – 运行 mvn clean package 命令以将组件的源代码构建为构件。对于使用 Maven 的组件（例如 Java 组件），请选择此选项。

     在 Windows 设备上，此功能适用于 GDK CLI v1.1.0 及更高版本。

   • gradle – 运行 gradle build 命令以将组件的源代码构建为构件。对于使用 Gradle 的组件，请选择此选项。此功能适用于 GDK CLI v1.1.0 及更高版本。

     gradle 构建系统支持 Kotlin DSL 作为构建文件。此功能适用于 GDK CLI v1.2.0 及更高版本。

   • gradlew – 运行 gradlew 命令以将组件的源代码构建为构件。对于使用 Gradle Wrapper 的组件，请选择此选项。

     此功能适用于 GDK CLI v1.2.0 及更高版本。

   • custom – 运行自定义命令，将组件的源代码构建为配方和构件。在 custom_build_command 参数中指定自定义命令。

6. 如果您为 build_system 指定 custom，请将 custom_build_command 添加到 build 对象中。在 custom_build_command 中，指定单个字符串或字符串列表，其中每个字符串都是命令中的一个单词。例如，要为 C++ 组件运行自定义构建命令，可以指定 ["cmake", "--build", "build", "--config", "Release"]。

7. 如果您使用的是 GDK CLI v1.1.0 或更高版本，则可以指定 --bucket 参数来指定供 GDK CLI 上传组件构件的 S3 存储桶。如果您不指定此参数，GDK CLI 会上传到名称为bucket-region-accountId、其中bucket和是您在中指定的值gdk-config.json，并且region是您的 ID accountId 的 S3 存储桶。 Amazon Web Services 账户 如果存储桶不存在，GDK CLI 将创建该存储桶。

   更改组件的发布配置。执行以下操作：

   1. 指定用于托管组件构件的 S3 存储桶的名称。

   2. 指定 GDK CLI 发布组件 Amazon Web Services 区域 的位置。

这一步完成后，gdk-config.json 文件可能类似于以下示例。

{
  "component": {
    "com.example.PythonHelloWorld": {
      "author": "Amazon",
      "version": "NEXT_PATCH",
      "build": {
        "build_system" : "zip"
      },
      "publish": {
        "bucket": "greengrass-component-artifacts",
        "region": "us-west-2"
      }
    }
  },
  "gdk_version": "1.0.0"
}

更新名为 recipe.yaml 或 recipe.json 的组件配方文件。执行以下操作：

1. 如果您下载了使用 zip 构建系统的模板或社区组件，请检查 zip 构件名称是否与组件文件夹的名称相匹配。GDK CLI 将组件文件夹压缩成与组件文件夹同名的 ZIP 文件。配方在组件构件列表和使用 zip 构件中文件的生命周期脚本中包含 zip 构件名称。更新 Artifacts 和 Lifecycle 定义，使 zip 文件名与组件文件夹的名称相匹配。以下部分配方示例突出显示了 Artifacts 和 Lifecycle 定义中的 zip 文件名。

   JSON

   {
     ...
     "Manifests": [
       {
         "Platform": {
           "os": "all"
         },
         "Artifacts": [
           {
             "URI": "s3://{COMPONENT_NAME}/{COMPONENT_VERSION}/HelloWorld.zip",
             "Unarchive": "ZIP"
           }
         ],
         "Lifecycle": {
           "Run": "python3 -u {artifacts:decompressedPath}/HelloWorld/main.py {configuration:/Message}"
         }
       }
     ]
   }

   YAML

   ---
   ...
   Manifests:
     - Platform:
         os: all
       Artifacts:
         - URI: "s3://BUCKET_NAME/COMPONENT_NAME/COMPONENT_VERSION/HelloWorld.zip"
           Unarchive: ZIP
       Lifecycle:
         Run: "python3 -u {artifacts:decompressedPath}/HelloWorld/main.py {configuration:/Message}"

2. （可选）更新组件描述、默认配置、构件、生命周期脚本和平台支持。有关更多信息，请参阅 Amazon IoT Greengrass 组件配方参考。

这一步完成后，配方文件可能类似于以下示例。

开发和构建 Greengrass 组件。component build 命令在组件文件夹的 greengrass-build 文件夹中生成配方和构件。运行以下命令。

gdk component build

为您的组件创建一个文件夹，其中包含用于存放配方和构件的子文件夹。在 Greengrass 核心设备上运行以下命令来创建这些文件夹并更改为组件文件夹。将~/greengrassv2或%USERPROFILE%\greengrassv2替换为用于本地开发的文件夹的路径。

使用文本编辑器创建配方文件，在该配方文件中定义组件的元数据、参数、依赖关系、生命周期和平台功能。在配方文件名中包含组件版本，以便您可以识别哪个配方对应哪个组件版本。您可以为配方选择 YAML 或 JSON 格式。

例如，在基于 Linux 的系统上，您可以运行以下命令来使用 GNU nano 创建该文件。

为您的组件定义配方。有关更多信息，请参阅 Amazon IoT Greengrass 组件配方参考。

您的配方可能类似于以下 Hello World 示例配方。

此配方运行 Hello World Python 脚本，该脚本可能类似于以下示例脚本。

import sys

message = "Hello, %s!" % sys.argv[1]

# Print the message to stdout, which Greengrass saves in a log file.
print(message)

为要开发的组件版本创建文件夹。建议您为每个组件版本的构件使用单独的文件夹，以便您可以识别每个组件版本对应的构件。运行以下命令。

artifacts/componentName/componentVersion/

在上一步中创建的文件夹中为组件创建构件。构件可以包括软件、图像和组件使用的任何其他二进制文件。

组件准备就绪后，请测试组件。