Requisitos Parámetros Datos de entrada Datos de salida Ejemplo de uso Licencias Registro de cambios Véase también

AWS IoT Greengrass Version 1 entró en la fase de vida útil prolongada el 30 de junio de 2023. Para obtener más información, consulte la política de mantenimiento de AWS IoT Greengrass V1 Después de esta fecha, AWS IoT Greengrass V1 no se publicarán actualizaciones que proporcionen funciones, mejoras, correcciones de errores o parches de seguridad. Los dispositivos que se ejecuten AWS IoT Greengrass V1 no se verán afectados y seguirán funcionando y conectándose a la nube. Le recomendamos encarecidamente que migre a AWS IoT Greengrass Version 2, ya que añade importantes funciones nuevas y es compatible con plataformas adicionales.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Conector Serial Stream

aviso

Este conector ha pasado a la fase de vida útil prolongada y AWS IoT Greengrass no lanzará actualizaciones que proporcionen funciones, mejoras de las funciones existentes, parches de seguridad o correcciones de errores. Para obtener más información, consulte AWS IoT Greengrass Version 1política de mantenimiento.

El conector Serial Stream realiza las operaciones de lectura y escritura en un puerto de serie de un dispositivo de núcleo de AWS IoT Greengrass.

Este conector es compatible con dos modos de operación:

Lectura bajo demanda. Recibe las solicitudes de lectura y escritura en temas de MQTT y publica la respuesta de la operación de lectura o el estado de la operación de escritura.
Lectura de sondeo. Lee desde el puerto de serie a intervalos regulares. Este modo también admite las solicitudes de lectura bajo demanda.

nota

Las solicitudes de lectura se limitan a una longitud de lectura máxima de 63994 bytes. Las solicitudes de escritura se limitan a una longitud de datos máxima de 128000 bytes.

Este conector tiene las siguientes versiones.

Versión	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`

Para obtener información sobre los cambios de versión, consulte el Registro de cambios.

Requisitos

Este conector exige los siguientes requisitos:

Parámetros de conector

Este conector proporciona los siguientes parámetros:

BaudRate

La velocidad en baudios de la conexión de serie.

Nombre que mostrar en la consola AWS IoT: Velocidad en baudios

Obligatorio: true

Escriba: string

Valores válidos: 110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 56000, 57600, 115200, 230400

Patrón válido: ^110$|^300$|^600$|^1200$|^2400$|^4800$|^9600$|^14400$|^19200$|^28800$|^38400$|^56000$|^57600$|^115200$|^230400$

Timeout

El tiempo de espera (en segundos) para una operación de lectura.

Nombre que mostrar en la consola AWS IoT: Tiempo de espera

Obligatorio: true

Escriba: string

Valores válidos: 1 - 59

Patrón válido: ^([1-9]|[1-5][0-9])$

SerialPort

La ruta absoluta al puerto de serie físico del dispositivo. Esta es la ruta de origen que haya especificado para el recurso de dispositivo local.

Nombre que mostrar en la consola AWS IoT: Puerto de serie

Obligatorio: true

Escriba: string

Patrón válido: [/a-zA-Z0-9_-]+

SerialPort-ResourceId

El ID del recurso de dispositivo local que representa el puerto de serie físico.

nota

A este conector se le concede acceso de lectura y escritura al recurso.

Nombre para mostrar en la consola AWS IoT: Recurso de puerto de serie

Obligatorio: true

Escriba: string

Patrón válido: [a-zA-Z0-9_-]+

PollingRead

Establece el modo de lectura: lectura de sondeo o lectura bajo demanda.

Para el modo de lectura de sondeo, especifique true. En este modo, se necesitan las propiedades PollingInterval, PollingReadType y PollingReadLength.
Para el modo de lectura bajo demanda, especifique false. En este modo, los valores de tipo y longitud se especifican en la solicitud de lectura.

Nombre que mostrar en la consola AWS IoT: Modo de lectura

Obligatorio: true

Escriba: string

Valores válidos: true, false

Patrón válido: ^([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$

PollingReadLength

La longitud de los datos (en bytes) que se leen en cada operación de lectura de sondeo. Esto se aplica únicamente cuando se utiliza de modo de lectura de sondeo.

Nombre para mostrar en la consola AWS IoT: Longitud de lectura del sondeo

Obligatorio: false. Esta propiedad es obligatoria cuando PollingRead es true.

Escriba: string

Patrón válido: ^(|[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

El intervalo (en segundos) en el que tiene lugar la lectura de sondeo. Esto se aplica únicamente cuando se utiliza de modo de lectura de sondeo.

Nombre para mostrar en la consola AWS IoT: Intervalo de lectura del sondeo

Obligatorio: false. Esta propiedad es obligatoria cuando PollingRead es true.

Escriba: string

Valores válidos: 1 - 999

Patrón válido: ^(|[1-9]|[1-9][0-9]|[1-9][0-9][0-9])$

PollingReadType

El tipo de datos que el subproceso de sondeo lee. Esto se aplica únicamente cuando se utiliza de modo de lectura de sondeo.

Nombre para mostrar en la consola AWS IoT: Tipo de lectura de sondeo

Obligatorio: false. Esta propiedad es obligatoria cuando PollingRead es true.

Escriba: string

Valores válidos: ascii, hex

Patrón válido: ^(|[Aa][Ss][Cc][Ii][Ii]|[Hh][Ee][Xx])$

RtsCts

Indica si se debe habilitar el control de flujo RTS/CTS. El valor predeterminado es false. Para obtener más información, consulte RTS, CTS, and RTR.

Nombre para mostrar en la consola AWS IoT: Control de flujo RTS/CTS

Obligatorio: false

Escriba: string

Valores válidos: true, false

Patrón válido: ^(|[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$

XonXoff

Indica si se debe habilitar el control de flujo de software. El valor predeterminado es false. Para obtener más información, consulte Software flow control.

Nombre para mostrar en la consola AWS IoT: Control de flujo de software

Obligatorio: false

Escriba: string

Valores válidos: true, false

Patrón válido: ^(|[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee])$

Parity

La paridad del puerto de serie. El valor predeterminado es N. Para obtener más información, consulte Parity.

Nombre para mostrar en la consola AWS IoT: Paridad de puerto serie

Obligatorio: false

Escriba: string

Valores válidos: N, E, O, S, M

Patrón válido: ^(|[NEOSMneosm])$

Ejemplo de creación de conector (AWS CLI)

El siguiente comando de la CLI crea una ConnectorDefinition con una versión inicial que contiene el conector Serial Stream. Configura el conector para el modo de lectura de sondeo.


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"
            }
        }
    ]
}'

En la consola AWS IoT Greengrass, puede añadir un conector desde la página de conectores del grupo. Para obtener más información, consulte Introducción a los conectores de Greengrass (consola).

Datos de entrada

Este conector acepta las solicitudes de lectura o escritura para los puertos de serie en dos temas de MQTT. Los mensajes de entrada deben tener un formato JSON válido.

Solicitudes de lectura en el tema serial/+/read/#.
Solicitudes de escritura en el tema serial/+/write/#.

Para publicar en estos temas, sustituya el comodín + con el nombre de cosa de núcleo y el comodín # con la ruta al puerto de serie. Por ejemplo:


serial/core-thing-name/read/dev/serial-port

Filtro de temas: serial/+/read/#

Consulte este tema para enviar las solicitudes de lectura bajo demanda a un pin de serie. Las solicitudes de lectura se limitan a una longitud de lectura máxima de 63994 bytes.

Propiedades de mensajes

readLength

La longitud de los datos para leer desde el puerto de serie.

Obligatorio: true

Escriba: string

Patrón válido: ^[1-9][0-9]*$

type

El tipo de datos para leer.

Obligatorio: true

Escriba: string

Valores válidos: ascii, hex

Patrón válido: (?i)^(ascii|hex)$

id

Un ID arbitrario para la solicitud. Esta propiedad se usa para asignar una solicitud de entrada a una respuesta de salida.

Obligatorio: false

Escriba: string

Patrón válido: .+

Ejemplo de entrada


{
    "readLength": "30",
    "type": "ascii",
    "id": "abc123"
}

Filtro de temas: serial/+/write/#

Use este tema para enviar solicitudes de escritura a un pin de serie. Las solicitudes de escritura se limitan a una longitud de datos máxima de 128000 bytes.

Propiedades de mensajes

data

La cadena para escribir en el puerto de serie.

Obligatorio: true

Escriba: string

Patrón válido: ^[1-9][0-9]*$

type

El tipo de datos para leer.

Obligatorio: true

Escriba: string

Valores válidos: ascii, hex

Patrón válido: ^(ascii|hex|ASCII|HEX)$

id

Un ID arbitrario para la solicitud. Esta propiedad se usa para asignar una solicitud de entrada a una respuesta de salida.

Obligatorio: false

Escriba: string

Patrón válido: .+

Ejemplo entrada: solicitud ASCII


{
    "data": "random serial data",
    "type": "ascii",
    "id": "abc123"
}

Ejemplo entrada: solicitud hex


{
    "data": "base64 encoded data",
    "type": "hex",
    "id": "abc123"
}

Datos de salida

El conector publica los datos de salida en dos temas:

La información del estado del conector en el tema serial/+/status/#.
Las respuestas de solicitudes de lectura en el tema serial/+/read_response/#.

Al publicar en este tema, el conector sustituye el comodín + con el nombre de cosa de núcleo y el comodín # con la ruta al puerto de serie. Por ejemplo:


serial/core-thing-name/status/dev/serial-port

Filtro de temas: serial/+/status/#

Consulte este tema para escuchar el estado de las solicitudes de lectura y escritura. Si una propiedad id está incluida en la solicitud, se devuelve en la respuesta.

Ejemplo de salida: Correcto


{
    "response": {
        "status": "success"
    },
    "id": "abc123"
}

Ejemplo de salida: Error

Una respuesta de error incluye una propiedad error_message que describe el error o el tiempo de espera que se produce cuando se realiza la operación de lectura o escritura.


{
    "response": {
        "status": "fail",
        "error_message": "Could not write to port"
    },
    "id": "abc123"
}

Filtro de temas: serial/+/read_response/#

Utilice este tema para recibir los datos de respuesta de una operación de lectura. Los datos de respuesta son Base64 codificados si el tipo es hex.

Ejemplo de salida


{
    "data": "output of serial read operation"
    "id": "abc123"
}

Ejemplo de uso

Utilice los siguientes pasos de alto nivel para configurar una función de Lambda de Python 3.7 de ejemplo que puede utilizar para probar el conector.

nota

Si usa otros tiempos de ejecución de Python, puede crear un enlace simbólico de Python3.x a Python 3.7.
Los temas Introducción a los conectores (consola) y Introducción a los conectores (CLI) contienen pasos detallados que muestran cómo configurar e implementar un conector de notificaciones Twilio de ejemplo.

Asegúrese de cumplir los requisitos para el conector.
Cree y publique una función de Lambda que envíe datos de entrada al conector.

Guarde el código de ejemplo como un archivo PY. Descargue y descomprima el SDK de Core AWS IoT Greengrass para Python. A continuación, cree un paquete zip que contenga el archivo PY y la carpeta greengrasssdk en el nivel raíz. Este paquete zip es el paquete de implementación que se carga en AWS Lambda.

Después de crear la función de Lambda de Python 3.7, publique una versión de característica y cree un alias.
Configuración del grupo de Greengrass.
1. Agregue la función de Lambda por su alias (recomendado). Configure el ciclo de vida de Lambda como de larga duración (o "Pinned": true en la CLI).
2. Agregue el recurso de dispositivo local requerido y conceda acceso de lectura/escritura a la función de Lambda.
3. Agregue el conector a su grupo y configure sus parámetros.
4. Agregue suscripciones al grupo que permitan que el conector reciba datos de entrada y envíe datos de salida en filtros de tema compatibles.
  - Establezca la función de Lambda como fuente, el conector como destino y utilice un filtro de tema de entrada compatible.
  - Establezca el conector como origen, AWS IoT Core como destino y utilice un filtro de tema de salida compatible. Utilice esta suscripción para ver los mensajes de estado en la consola de AWS IoT.
Implemente el grupo.
En la consola de AWS IoT, en la página Prueba suscríbase al tema de datos de salida para ver los mensajes de estado del conector. La función de Lambda de ejemplo es de larga duración y comienza a enviar mensajes inmediatamente después de implementar el grupo.

Cuando haya terminado de probar, puede establecer el ciclo de vida de Lambda en Bajo demanda (o "Pinned": false en la CLI) e implementar el grupo. Esto impide que la característica envíe mensajes.

Ejemplo

El siguiente ejemplo de función de Lambda envía un mensaje de entrada al conector.


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

Licencias

El conector Serial Stream incluye el siguiente software/licencia de terceros:

pyserial/BSD

Este conector se publica bajo el contrato de licencia de software de Greengrass Core.

Registro de cambios

La siguiente tabla describe los cambios en cada versión del conector.

Versión	Cambios
3	Se actualizó el tiempo de ejecución de Lambda a Python 3.7, lo que cambia el requisito de tiempo de ejecución.
2	Se actualizó el conector ARN para el soporte de Región de AWS.
1	Versión inicial.

Un grupo de Greengrass solo puede contener una versión del conector a la vez. Para obtener información sobre cómo actualizar una versión de conector, consulte Actualización de versiones de los conectores.

Véase también

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Raspberry Pi GPIO

Integración de MetricBase de ServiceNow