串行流连接器 - Amazon IoT Greengrass
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

您正在查看Amazon IoT Greengrass Version 1.Amazon IoT Greengrass Version 2是最新的主要版本Amazon IoT Greengrass. 有关使用Amazon IoT Greengrass V2,请参阅Amazon IoT Greengrass Version 2开发人员指南.

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

串行流连接器

串行流连接器读取和写入Amazon IoT Greengrass核心设备。

此连接器支持两种操作模式:

  • 按需读取。接收关于 MQTT 主题的读取和写入请求,并发布读取操作的响应或写入操作的状态。

  • 轮询读取。定期从串行端口读取。该模式还支持“按需读取”请求。

注意

读取请求的限制为最多 63994 字节的读取长度。写入请求的限制为最多 128000 字节的数据长度。

此连接器具有以下版本。

Version

ARN

3

arn:aws:greengrass:region::/connectors/SerialStream/versions/3

2

arn:aws:greengrass:region::/connectors/SerialStream/versions/2

1

arn:aws:greengrass:region::/connectors/SerialStream/versions/1

有关版本更改的信息,请参阅更改日志

Requirements

此连接器具有以下要求:

Version 3
  • Amazon IoT Greengrass Core 软件 v1.9.3 版或更高版本。

  • Python版本 3.7 或 3.8 安装在核心设备上并添加到 PATH 环境变量中。

    注意

    要使用 Python 3.8,请运行以下命令以创建从默认 Python 3.7 安装文件夹到已安装的 Python 3.8 二进制文件的符号链接。

    sudo ln -s path-to-python-3.8/python3.8 /usr/bin/python3.7

    这会将设备配置为满足 Amazon IoT Greengrass 的 Python 要求。

  • A本地设备资源Greengrass 组中一个指向目标串行端口的。

    注意

    建议先设置串行端口并验证可读取和写入此串行端口,然后部署此连接器。

Versions 1 - 2
  • Amazon IoT Greengrass核心软件版本 v1.7 或更高版本。

  • Python安装在核心设备上并添加到 PATH 环境变量中。

  • A本地设备资源Greengrass 组中一个指向目标串行端口的。

    注意

    建议先设置串行端口并验证可读取和写入此串行端口,然后部署此连接器。

Connector of

该连接器提供以下参数:

BaudRate

串行连接的波特率。

在Amazon IoT控制台:波特率

:必需true

类型:string

有效值:110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 56000, 57600, 115200, 230400

有效模式:^110$|^300$|^600$|^1200$|^2400$|^4800$|^9600$|^14400$|^19200$|^28800$|^38400$|^56000$|^57600$|^115200$|^230400$

Timeout

读取操作的超时(以秒为单位)。

在Amazon IoT控制台:Timeout

:必需true

类型:string

有效值:1 - 59

有效模式:^([1-9]|[1-5][0-9])$

SerialPort

设备上的物理串行端口的绝对路径。这是为本地设备资源指定的源路径。

在Amazon IoT控制台:串行端口

:必需true

类型:string

有效模式:[/a-zA-Z0-9_-]+

SerialPort-ResourceId

表示物理串行端口的本地设备资源的 ID。

注意

连接器被授予对该资源的读写访问权限。

在Amazon IoT控制台:串行端口资源

:必需true

类型:string

有效模式:[a-zA-Z0-9_-]+

PollingRead

设置读取模式:轮询读取或按需读取。

  • 对于“轮询读取”模式,请指定 true。在该模式下,PollingIntervalPollingReadTypePollingReadLength 属性是必需属性。

  • 对于“按需读取”模式,请指定 false。在该模式下,将在读取请求中指定类型和长度值。

在Amazon IoT控制台:阅读更多

:必需true

类型:string

有效值:true, false

有效模式:^([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$

PollingReadLength

要在每个轮询读取操作中读取的数据长度(字节)。仅当使用“轮询读取”模式时才适用。

在Amazon IoT控制台:轮询读长度

:必需 false. 当前,该属性是必需属性。PollingReadtrue.

类型:string

有效模式:^(|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-2][0-9]{3}|63[0-8][0-9]{2}|639[0-8][0-9]|6399[0-4])$

PollingReadInterval

轮询读取的时间间隔(以秒为单位)。仅当使用“轮询读取”模式时才适用。

在Amazon IoT控制台:轮询读取时间间隔

:必需 false. 当前,该属性是必需属性。PollingReadtrue.

类型:string

有效值:999

有效模式:^(|[1-9]|[1-9][0-9]|[1-9][0-9][0-9])$

PollingReadType

轮询线程读取的数据类型。仅当使用“轮询读取”模式时才适用。

在Amazon IoT控制台:轮询读取类型

:必需 false. 当前,该属性是必需属性。PollingReadtrue.

类型:string

有效值:ascii, hex

有效模式:^(|[Aa][Ss][Cc][Ii][Ii]|[Hh][Ee][Xx])$

RtsCts

指示是否启用 RTS/CTS 流控制。默认值为 false。有关更多信息,请参阅 RTS、CTS 和 RTR

在Amazon IoT控制台:RTS/CTS 流控制

:必需false

类型:string

有效值:true, false

有效模式:^(|[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$

XonXoff

指示是否启用软件流控制。默认值为 false。有关更多信息,请参阅软件流控制

在Amazon IoT控制台:软件流控制

:必需false

类型:string

有效值:true, false

有效模式:^(|[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$

Parity

串行端口的奇偶校验。默认值为 N。有关更多信息,请参阅奇偶校验

在Amazon IoT控制台:串行端口奇偶校验

:必需false

类型:string

有效值:N, E, O, S, M

有效模式:^(|[NEOSMneosm])$

创建连接器示例 (Amazon CLI)

以下 CLI 命令将创建的ConnectorDefinition,其初始版本包含串行流连接器。它将连接器配置为“轮询读取”模式。

aws greengrass create-connector-definition --name MyGreengrassConnectors --initial-version '{ "Connectors": [ { "Id": "MySerialStreamConnector", "ConnectorArn": "arn:aws:greengrass:region::/connectors/SerialStream/versions/3", "Parameters": { "BaudRate" : "9600", "Timeout" : "25", "SerialPort" : "/dev/serial1", "SerialPort-ResourceId" : "my-serial-port-resource", "PollingRead" : "true", "PollingReadLength" : "30", "PollingReadInterval" : "30", "PollingReadType" : "hex" } } ] }'

在Amazon IoT Greengrass控制台中添加连接器,您可以从组的连接器页. 有关更多信息,请参阅Greengrass 连接器入门(控制台)

输入数据

此连接器接受关于两个 MQTT 主题的串行端口读取或写入请求。输入消息必须采用 JSON 格式。

  • 读取请求位于serial/+/read/# 主题上。

  • 写入请求位于 serial/+/write/# 主题上。

要发布到这些主题,请将 + 通配符替换为核心事物名称,将 # 通配符替换为串行端口的路径。例如:

serial/core-thing-name/read/dev/serial-port
主题筛选条件:serial/+/read/#

使用此主题向串行引脚发送按需读取请求。读取请求的限制为最多 63994 字节的读取长度。

消息属性
readLength

要从串行端口读取的数据长度。

:必需true

类型:string

有效模式:^[1-9][0-9]*$

type

要读取的数据的类型。

:必需true

类型:string

有效值:ascii, hex

有效模式:(?i)^(ascii|hex)$

id

请求的任意 ID。此属性用于将输入请求映射到输出响应。

:必需false

类型:string

有效模式:.+

示例输入
{ "readLength": "30", "type": "ascii", "id": "abc123" }
主题筛选条件:serial/+/write/#

使用此主题向串行引脚发送写入请求。写入请求的限制为最多 128000 字节的数据长度。

消息属性
data

要写入到该串行端口的字符串。

:必需true

类型:string

有效模式:^[1-9][0-9]*$

type

要读取的数据的类型。

:必需true

类型:string

有效值:ascii, hex

有效模式:^(ascii|hex|ASCII|HEX)$

id

请求的任意 ID。此属性用于将输入请求映射到输出响应。

:必需false

类型:string

有效模式:.+

示例输入:ASCII 请求
{ "data": "random serial data", "type": "ascii", "id": "abc123" }
示例输入:十六进制请求
{ "data": "base64 encoded data", "type": "hex", "id": "abc123" }

输出数据

连接器发布关于两个主题的输出数据:

  • 来自连接器的关于 serial/+/status/# 主题的状态信息。

  • 来自读取请求的响应(关于 serial/+/read_response/# 主题)。

当发布到此主题时,连接器会将 + 通配符替换为核心事物名称,并将 # 通配符替换为串行端口的路径。例如:

serial/core-thing-name/status/dev/serial-port
主题筛选条件:serial/+/status/#

使用此主题侦听读取和写入请求的状态。如果请求包含 id 属性,则该属性将在响应中返回。

输出示例:成功
{ "response": { "status": "success" }, "id": "abc123" }
输出示例:失败

失败响应包含一个 error_message 属性,用于描述在执行读取或写入操作时遇到的错误或超时。

{ "response": { "status": "fail", "error_message": "Could not write to port" }, "id": "abc123" }
主题筛选条件:serial/+/read_response/#

使用此主题接收来自读取操作的响应数据。如果类型为 hex,则响应数据经过 Base64 编码。

输出示例
{ "data": "output of serial read operation" "id": "abc123" }

用法示例

使用以下概括步骤设置可用于尝试连接器的示例 Python 3.7 Lambda 函数。

注意
  1. 确保满足连接器的要求

  2. 创建并发布将输入数据发送到连接器的 Lambda 函数。

    示例代码保存为 PY 文件。下载并解压缩Amazon IoT Greengrass适用于 Python 的核心开发工具. 然后,创建一个 zip 包,其中在根级别包含 PY 文件和 greengrasssdk 文件夹。此 zip 包是您上传到的部署包Amazon Lambda.

    创建 Python 3.7 Lambda 函数后,发布函数版本并创建别名。

  3. 配置 Greengrass 组。

    1. 通过函数的别名添加 Lambda(推荐)。将 Lambda 生命周期配置为长时间生存(或"Pinned": true)。

    2. 添加所需的本地设备资源并授予对 Lambda 函数的读/写访问权限。

    3. 将连接器添加到组并配置其参数

    4. 向组添加允许连接器接收输入数据并针对支持的主题筛选条件发送输出数据的订阅。

      • 将 Lambda 函数设置为源,将连接器设置为目标,并使用支持的输入主题筛选条件。

      • 将连接器设置为源,将 Amazon IoT Core 设置为目标,并使用支持的输出主题筛选条件。您可以使用此订阅查看中的状态消息。Amazon IoT控制台。

  4. 部署组。

  5. 在Amazon IoT控制台、测试页面上,订阅输出数据主题以查看连接器中的状态消息。示例 Lambda 函数是长时间生存的,并且在部署组后立即开始发送消息。

    完成测试后,您可以将 Lambda 生命周期设置为按需(或"Pinned": false)并部署组。这会阻止函数发送消息。

Example

以下示例 Lambda 函数将输入消息发送到连接器。

import greengrasssdk import json TOPIC_REQUEST = 'serial/CORE_THING_NAME/write/dev/serial1' # Creating a greengrass core sdk client iot_client = greengrasssdk.client('iot-data') def create_serial_stream_request(): request = { "data": "TEST", "type": "ascii", "id": "abc123" } return request def publish_basic_request(): iot_client.publish(payload=json.dumps(create_serial_stream_request()), topic=TOPIC_REQUEST) publish_basic_request() def lambda_handler(event, context): return

Licenses

串行流连接器包含以下第三方软件/许可:

此连接器在Greengrass 核心软件许可协议.

Changelog

下表介绍每一版的连接器中的更改。

Version

更改

3

已将 Lambda 运行时升级到 Python 3.7,这会更改运行时要求。

2

用于已更新的连接器 ARN Amazon Web Services 区域 支持。

1

首次发布。

Greengrass 组每次只能包含一个连接器版本。有关升级连接器版本的信息,请参阅升级连接器版本

另请参阅