AWS IoT Greengrass
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

Greengrass 连接器入门(控制台)

此功能适用于 AWS IoT Greengrass Core v1.7 及更高版本。

本教程介绍如何通过 AWS 管理控制台 使用连接器。

使用连接器可加快开发生命周期。连接器是预先构建、可重复使用的模块,可以更加轻松地与服务、协议和资源进行交互。它们可以帮助您将业务逻辑更快地部署到 Greengrass 设备。有关更多信息,请参阅 使用 Greengrass 连接器与服务和协议集成

在本教程中,您将配置和部署 Twilio 通知 连接器。连接器接收 Twilio 消息信息作为输入数据,然后触发 Twilio 文本消息。下图中将显示数据流。

从 Lambda 函数到 Twilio 通知 再到 Twilio 的数据流。

配置连接器后,您便可创建 Lambda 函数和订阅。

  • 该函数将评估来自温度传感器的模拟数据。它有条件地将 Twilio 消息信息发布到 MQTT 主题。这是连接器订阅的主题。

  • 该订阅允许函数发布到主题,并允许连接器接收来自该主题的数据。

Twilio 通知 连接器需要 Twilio 身份验证令牌,才能与 Twilio API 进行交互。令牌是在 AWS Secrets Manager 中创建且从组资源中引用的文本类型密钥。这样一来,AWS IoT Greengrass 便可在 Greengrass 核心上创建密钥的本地副本,在该核心中,此类副本经过加密且可供连接器使用。有关更多信息,请参阅将密钥部署到 AWS IoT Greengrass 核心

本教程包含以下概括步骤:

完成本教程大约需要 20 分钟。

先决条件

要完成此教程,需要:

  • Greengrass 组和 Greengrass 核心 (v1.7 or later)。要了解如何创建 Greengrass 组和核心,请参阅 AWS IoT Greengrass 入门。“入门”教程还包含用于安装 AWS IoT Greengrass 核心软件的步骤。

  • AWS IoT Greengrass 必须配置为支持本地密钥,如密钥要求中所述。

    注意

    其中包括允许访问您的 Secrets Manager 密钥。如果使用的是默认 Greengrass 服务角色,则Greengrass有权获得名称以 greengrass- 开头的密钥的值。

  • Twilio 账户 SID、身份验证令牌和支持 Twilio 的电话号码。创建 Twilio 项目后,项目控制面板上会显示这些值。

    注意

    您可以使用 Twilio 试用账户。如果您使用的是试用账户,则必须将非 Twilio 收件人电话号码添加到已验证电话号码列表中。 有关更多信息,请参阅如何使用您的免费 Twilio 试用账户

步骤 1:创建 Secrets Manager 密钥

在此步骤中,您将使用 AWS Secrets Manager 控制台为 Twilio 身份验证令牌创建一个文本类型密钥。

  1. 登录 AWS Secrets Manager 控制台

    注意

    有关该过程的更多信息,请参阅 AWS Secrets Manager 用户指南中的步骤 1:在 AWS Secrets Manager 中创建并存储密钥

  2. 选择存储新密钥

  3. Select secret type (选择密钥类型) 下,选择 Other type of secrets (其他密钥类型)

  4. Plaintext (纯文本) 选项卡的 Specify the key/value pairs to be stored for this secret (指定要为此密钥存储的键/值对) 下方,输入您的 Twilio 身份验证令牌。删除所有 JSON 格式设置,然后仅输入令牌值。

    
                在 Secrets Manager 控制台中指定密钥的值。
  5. 请确保为加密密钥保持选中 DefaultEncryptionKey,然后选择 Next (下一步)

    注意

    如果使用 Secrets Manager 在您的账户中创建的默认 AWS 托管密钥,AWS KMS 不会对您收费。

  6. 对于密钥名称,输入 greengrass-TwilioAuthToken,然后选择下一步

    注意

    默认情况下,Greengrass 服务角色允许 AWS IoT Greengrass 获得名称以 greengrass- 开头的密钥的值。有关更多信息,请参阅密钥要求。

  7. 本教程不需要轮换,因此,请选择 Disable automatic rotation (禁用自动轮换),然后选择 Next (下一步)

  8. Review (审核) 页上,审核您的设置,然后选择 Store (存储)

    接下来,在 Greengrass 组中创建一个引用该密钥的密钥资源。

步骤 2:将密钥资源添加到 Greengrass 组

在此步骤中,您将一个密钥资源 添加到 Greengrass 组。该资源是对上一步中创建的密钥的引用。

  1. 在 AWS IoT 控制台中,选择 Greengrass,然后选择 Groups (组)

  2. 选择要将密钥资源添加到的组。

  3. 在组配置页面上,选择 Resources (资源),然后选择 Secret (密钥)。此选项卡显示属于该组的密钥资源。您可以从此选项卡添加、编辑和删除密钥资源。

    
                组的“Resources (资源)”页面上的“Secret (密钥)”选项卡。

    注意

    或者,控制台允许您在配置连接器或 Lambda 函数时创建密钥和密钥资源。您可以从连接器的 Configure parameters (配置参数) 页面或 Lambda 函数的 Resources (资源) 页面执行此操作。

  4. 选择 Add a secret resource (添加密钥资源)

  5. Add a secret resource to your group (向组中添加密钥资源) 页面上,选择 Select (选择),然后选择 greengrass-TwilioAuthToken

  6. Select labels (Optional) (选择标签 (可选)) 页面上,选择 Next (下一步)。AWSCURRENT 暂存标签表示最新版密钥。该标签始终包含在密钥资源中。

    注意

    本教程只需要 AWSCURRENT 标签。您可以视情况包括 Lambda 函数或连接器所需的标签。

  7. Name your secret resource (为密钥资源命名) 页面上,输入 MyTwilioAuthToken,然后选择 Save (保存)

步骤 3:将连接器添加到 Greengrass 组

在此步骤中,您将为 Twilio 通知 连接器配置参数,并将其添加到组。

  1. 在组配置页面上,选择 Connectors (连接器),然后选择 Add a connector (添加连接器)

    
                突出显示了“Add a connector (添加连接器)”的“Connectors (连接器)”页面。
  2. Select a connector (选择连接器) 页面上,选择 Twilio Notifications (Twilio 通知),然后选择 Next (下一步)

  3. Configure parameters (配置参数) 页面上,执行以下操作:

    • 对于 Twilio auth token resource (Twilio 身份验证令牌资源),选择 MyTwilioAuthToken。这是上一步中所创建的密钥资源。

      注意

      选择该资源时,将为您填充 ARN of Twilio auth token secret (Twilio 身份验证令牌密钥的 ARN) 属性。

    • 对于 Default from phone number (默认的来电号码),输入您的支持 Twilio 的电话号码。

    • 对于 Twilio account SID (Twilio 账户 SID),输入您的 Twilio 账户 SID。

  4. 选择 Add

步骤 4:创建 Lambda 函数部署程序包

要创建 Lambda 函数,您必须先创建一个包含函数代码和依赖项的 Lambda 函数部署程序包。Greengrass Lambda 函数需要 AWS IoT Greengrass Core 开发工具包来用于与核心环境中的 MQTT 消息进行通信和访问本地密钥等任务。本教程将创建一个 Python 函数,因此您可以在部署程序包中使用 Python 版本的开发工具包。

  1. AWS IoT Greengrass Core 开发工具包 下载 页面下载 适用于 Python 的 AWS IoT Greengrass Core 开发工具包。

  2. 解压缩下载的程序包以获取软件开发工具包。软件开发工具包是 greengrasssdk 文件夹。

  3. 将以下 Python 代码函数保存在名为 temp_monitor.py 的本地文件中。

    from __future__ import print_function import greengrasssdk import json import random client = greengrasssdk.client('iot-data') # publish to the Twilio Notifications connector through the twilio/txt topic def function_handler(event, context): temp = event['temperature'] # check the temperature # if greater than 30C, send a notification if temp > 30: data = build_request(event) client.publish(topic='twilio/txt', payload=json.dumps(data)) print('published:' + str(data)) print('temperature:' + str(temp)) return # build the Twilio request from the input data def build_request(event): to_name = event['to_name'] to_number = event['to_number'] temp_report = 'temperature:' + str(event['temperature']) return { "request": { "recipient": { "name": to_name, "phone_number": to_number, "message": temp_report } }, "id": "request_" + str(random.randint(1,101)) }
  4. 将以下项目压缩到名为 temp_monitor_python.zip 的文件中。在创建 ZIP 文件时,仅包含代码和依赖项,而不包含文件夹。

    • temp_monitor.py。应用程序逻辑。

    • greengrasssdk。发布 MQTT 消息的 Python Greengrass Lambda 函数所需的库。

    此即 Lambda 函数部署程序包。

现在,创建一个使用部署程序包的 Lambda 函数。

步骤 5:在 AWS Lambda 控制台中创建 Lambda 函数

在该步骤中,您使用 AWS Lambda 控制台创建 Lambda 函数,然后将其配置为使用您的部署程序包。接着,发布函数版本并创建别名。

  1. 首先,创建 Lambda 函数。

    1. 在 AWS 管理控制台中,选择 Services (服务),然后打开 AWS Lambda 控制台。

    2. 选择 Create function,然后选择 Author from scratch

    3. Basic information (基本信息) 部分中,使用以下值:

      • 对于 Function name (函数名称),输入 TempMonitor

      • 对于 Runtime (运行时),选择 Python 2.7

      • 对于权限,请保留默认设置。这将创建一个授予基本 Lambda 权限的执行角色。(此角色未由 AWS IoT Greengrass 使用。)

    4. 在页面底部,选择 Create function

  2. 接下来,注册处理程序并上传您的 Lambda 函数部署程序包。

    1. 在 TempMonitor 函数的 Configuration (配置) 选项卡上,在 Function code (函数代码) 中使用以下值:

      • 对于 代码输入种类,选择上传 .zip 文件

      • 对于 Runtime (运行时),选择 Python 2.7

      • 对于 Handler (处理程序),输入 temp_monitor.function_handler

    2. 选择 Upload

    3. 选择您的 temp_monitor_python.zip 部署程序包。

    4. 选择 Save

      注意

      AWS Lambda 控制台上的测试键不可与该函数一同使用。AWS IoT Greengrass 核心 SDK 不包含在 AWS Lambda 控制台中独立运行 Greengrass Lambda 函数所需的模块。这些模块(例如 greengrass_common)会在被部署到您的 Greengrass 核心之后提供给这些函数。

      提示

      代码输入种类菜单中选择编辑内联代码,即可在函数代码部分中查看您的代码。

  3. 现在,发布 Lambda 函数的第一个版本并创建此版本的别名

    注意

    Greengrass 组可以按别名 (推荐) 或版本引用 Lambda 函数。通过使用别名,可以更轻松地管理代码更新,因为您在更新函数代码时无需更改订阅表或组定义。相反,您只是将别名指向新的函数版本。

    1. Actions 菜单上,选择 Publish new version

    2. 对于 Version description (版本描述),输入 First version,然后选择 Publish (发布)

    3. TempMonitor: 1 配置页面上,从 Actions (操作) 菜单中选择 Create alias (创建别名)

    4. 创建新别名页面上,使用以下值:

      • 对于名称,输入 GG_TempMonitor

      • 对于 Version (版本),选择 1

      注意

      AWS IoT Greengrass 不支持 $LATEST 版本的 Lambda 别名。

    5. 选择 Create

现在,您已准备就绪,可以将 Lambda 函数添加到 Greengrass 组。

步骤 6:将 Lambda 函数添加到 Greengrass 组

在该步骤中,您将 Lambda 函数添加到该组,然后配置其生命周期和环境变量。有关更多信息,请参阅使用组特定配置控制 Greengrass Lambda 函数的执行

  1. 在组配置页面上,选择 Lambdas,然后选择 Add Lambda

    
                突出显示“Lambdas”和“Add Lambda (添加 Lambda)”的组页面。
  2. Add a Lambda to your Greengrass Group (将 Lambda 添加到 Greengrass 组) 页面上,选择 Use existing Lambda

    
                突出显示“Use existing Lambda (使用现有 Lambda)”的“Add a Lambda to your Greengrass Group (将 Lambda 添加到 Greengrass 组)”页面。
  3. Use existing Lambda (使用现有 Lambda) 页面上,选择 TempMonitor,然后选择 Next

  4. Select a Lambda version (选择 Lambda 版本) 页面上,选择 Alias:GG_TempMonitor,然后选择 Finish

步骤 7:将订阅添加到 Greengrass 组

在该步骤中,您将添加一个订阅,使 Lambda 函数将输入数据发送到连接器。此连接器定义它订阅的 MQTT 主题,因此该订阅使用其中一个主题。这与示例函数发布到的主题相同。

对于本教程,您还可以创建订阅,以允许函数从 AWS IoT 接收模拟温度读数,并允许 AWS IoT 从连接器接收状态信息。

  1. 在组配置页面上,选择 Subscriptions (订阅),然后选择 Add Subscription

    
                突出显示“Subscriptions (订阅)”和“Add Subscription (添加订阅)”的组页面。
  2. 选择您的源和目标页面,配置源和目标,如下所示:

    1. 对于选择源,选择 Lambda,然后选择 TempMonitor

    2. 对于 Select a target (选择目标),选择 Connectors (连接器),然后选择 Twilio 通知

    3. 选择 Next

  3. Filter your data with a topic (利用主题筛选您的数据) 页面上,对于 Required topic syntax (要求的主题语法),选择 twilio/txt,然后选择 Next

  4. 选择 Finish

  5. 重复步骤 1 至 4,以创建允许 AWS IoT 将消息发布到该函数的订阅。

    1. 对于选择源,选择服务,然后选择 IoT Cloud

    2. 对于选择目标,选择 Lambda,然后选择 TempMonitor

    3. 对于 Topic filter (主题筛选条件),输入 temperature/input

  6. 重复步骤 1 至 4,以创建允许连接器将消息发布到 AWS IoT 的订阅。

    1. 对于 Select a source (选择源),选择 Connectors (连接器),然后选择 Twilio 通知

    2. 对于选择目标,选择服务,然后选择 IoT Cloud

    3. 对于主题筛选条件,已为您输入 twilio/message/status。这是连接器发布到的预定义主题。

步骤 8:部署 Greengrass 组

将组部署到核心设备。

  1. 确保 AWS IoT Greengrass Core正在运行。根据需要在您的 Raspberry Pi 终端中运行以下命令。

    1. 要检查守护程序是否正在运行,请执行以下操作:

      ps aux | grep -E 'greengrass.*daemon'

      如果输出包含 root/greengrass/ggc/packages/ggc-version/bin/daemon 条目,则表示守护程序正在运行。

      注意

      路径中的版本取决于您的核心设备上安装的 AWS IoT Greengrass 核心软件版本。

    2. 要启动守护程序,请执行以下操作:

      cd /greengrass/ggc/core/ sudo ./greengrassd start
  2. 在组配置页面上,选择部署,然后从操作菜单中,选择部署

    
                突出显示“Deployments (部署)”和“Deploy (部署)”的组页面。
  3. Configure how devices discover your core (配置设备搜索您的核心的方式) 页面上,选择 Automatic detection

    这使得设备可以自动获取核心的连接信息,例如 IP 地址、DNS 和端口号。建议使用自动检测,不过 AWS IoT Greengrass 也支持手动指定的终端节点。只有在首次部署组时,系统才会提示您选择搜索方法。

    
                突出显示“Automatic detection (自动检测)”的“Configure how devices discover your core (配置设备搜索您的核心的方式)”页面。

    注意

    在系统提示时,授予权限以创建Greengrass 服务角色,并将该角色与您在当前 AWS 区域中的 AWS 账户关联。该角色允许 AWS IoT Greengrass 访问您 AWS 服务中的资源。

    Deployments (部署) 页面显示了部署时间戳、版本 ID 和状态。完成后,部署的状态应显示为 Successfully completed (成功完成)

    有关问题排查帮助,请参阅AWS IoT Greengrass 问题排查

测试解决方案

  1. 在 AWS IoT 控制台主页上,选择 Test (测试)

    
                AWS IoT 控制台的左侧窗格,突出显示了“Test (测试)”。
  2. 对于订阅,请使用以下值,然后选择 Subscribe to topic。Twilio 通知 连接器向此主题发布状态信息。

    属性

    订阅主题

    twilio/message/status

    MQTT 负载显示

    将负载显示为字符串

  3. 对于 Publish (发布),请使用以下值,然后选择 Publish to topic (发布到主题) 来调用函数。

    属性

    主题

    temperature/input

    消息

    recipient-name 替换为文本消息收件人的姓名,将 recipient-phone-number 替换为文本消息收件人的电话号码。示例:+12345000000

    { "to_name": "recipient-name", "to_number": "recipient-phone-number", "temperature": 31 }

    如果您使用的是试用账户,则必须将非 Twilio 收件人电话号码添加到已验证电话号码列表中。 有关更多信息,请参阅 验证您的个人电话号码

    如果成功,则收件人会收到文本消息,并且控制台会在输出数据中显示 success 状态。

    现在,将输入消息中的 temperature 更改为 29 并发布。由于温度小于 30,因此 TempMonitor 函数不会触发 Twilio 消息。

另请参阅