Paso 4: Desarrolle y pruebe un componente en su dispositivo - AWS IoT Greengrass

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.

Paso 4: Desarrolle y pruebe un componente en su dispositivo

Un componente es un módulo de software que se ejecuta en los dispositivos AWS IoT Greengrass principales. Los componentes le permiten crear y administrar aplicaciones complejas como bloques de construcción discretos que puede reutilizar de un dispositivo principal de Greengrass a otro. Cada componente se compone de una receta y artefactos.

  • Recetas

    Cada componente contiene un archivo de recetas, que define sus metadatos. La receta también especifica los parámetros de configuración del componente, las dependencias de los componentes, el ciclo de vida y la compatibilidad de la plataforma. El ciclo de vida del componente define los comandos que instalan, ejecutan y apagan el componente. Para obtener más información, consulte AWS IoT Greengrass referencia de recetas de componentes.

    Puede definir recetas en formato JSON o YAML.

  • Artefactos

    Los componentes pueden tener cualquier número de artefactos, que son componentes binarios. Los artefactos pueden incluir scripts, código compilado, recursos estáticos y cualquier otro archivo que consuma un componente. Los componentes también pueden consumir artefactos de las dependencias de los componentes.

Con AWS IoT Greengrass, puede usar la CLI de Greengrass para desarrollar y probar componentes localmente en un dispositivo central de Greengrass sin interactuar con la nube. AWS Cuando complete su componente local, podrá usar la receta y los artefactos del componente para crear ese componente en el AWS IoT Greengrass servicio en la AWS nube y, a continuación, implementarlo en todos sus dispositivos principales de Greengrass. Para obtener más información sobre los componentes, consulte Desarrolle AWS IoT Greengrass componentes.

En esta sección, aprenderá a crear y ejecutar un componente básico de Hello World de forma local en su dispositivo principal.

Para desarrollar un componente de Hello World en tu dispositivo
  1. Cree una carpeta para sus componentes con subcarpetas para recetas y artefactos. Ejecute los siguientes comandos en su dispositivo principal de Greengrass para crear estas carpetas y cambiarlas a la carpeta de componentes. Sustituya ~/greengrassv2 o %USERPROFILE%\ greengrassv2 por la ruta a la carpeta que se utilizará para el desarrollo local.

    Linux or Unix
    mkdir -p ~/greengrassv2/{recipes,artifacts} cd ~/greengrassv2
    Windows Command Prompt (CMD)
    mkdir %USERPROFILE%\greengrassv2\\recipes, %USERPROFILE%\greengrassv2\\artifacts cd %USERPROFILE%\greengrassv2
    PowerShell
    mkdir ~/greengrassv2/recipes, ~/greengrassv2/artifacts cd ~/greengrassv2
  2. Utilice un editor de texto para crear un archivo de recetas que defina los metadatos, los parámetros, las dependencias, el ciclo de vida y la capacidad de la plataforma de su componente. Incluya la versión del componente en el nombre del archivo de recetas para poder identificar qué receta refleja qué versión del componente. Puedes elegir el formato YAML o JSON para tu receta.

    Por ejemplo, en un sistema basado en Linux, puede ejecutar el siguiente comando para usar GNU nano para crear el archivo.

    JSON
    nano recipes/com.example.HelloWorld-1.0.0.json
    YAML
    nano recipes/com.example.HelloWorld-1.0.0.yaml
    nota

    AWS IoT Greengrass usa versiones semánticas para los componentes. Las versiones semánticas siguen un sistema de números de principal.secundario.parche. Por ejemplo, la versión 1.0.0 representa la primera versión principal de un componente. Para obtener más información, consulte la especificación de la versión semántica.

  3. Pegue la siguiente receta en el archivo.

    JSON
    { "RecipeFormatVersion": "2020-01-25", "ComponentName": "com.example.HelloWorld", "ComponentVersion": "1.0.0", "ComponentDescription": "My first AWS IoT Greengrass component.", "ComponentPublisher": "Amazon", "ComponentConfiguration": { "DefaultConfiguration": { "Message": "world" } }, "Manifests": [ { "Platform": { "os": "linux" }, "Lifecycle": { "run": "python3 -u {artifacts:path}/hello_world.py {configuration:/Message}" } }, { "Platform": { "os": "windows" }, "Lifecycle": { "run": "py -3 -u {artifacts:path}/hello_world.py {configuration:/Message}" } } ] }
    YAML
    --- RecipeFormatVersion: '2020-01-25' ComponentName: com.example.HelloWorld ComponentVersion: '1.0.0' ComponentDescription: My first AWS IoT Greengrass component. ComponentPublisher: Amazon ComponentConfiguration: DefaultConfiguration: Message: world Manifests: - Platform: os: linux Lifecycle: run: | python3 -u {artifacts:path}/hello_world.py "{configuration:/Message}" - Platform: os: windows Lifecycle: run: | py -3 -u {artifacts:path}/hello_world.py "{configuration:/Message}"

    La ComponentConfiguration sección de esta receta define un parámetro,Message, que por defecto es. world La Manifests sección define un manifiesto, que es un conjunto de instrucciones y artefactos del ciclo de vida de una plataforma. Puede definir varios manifiestos para especificar diferentes instrucciones de instalación para distintas plataformas, por ejemplo. En el manifiesto, la Lifecycle sección indica al dispositivo principal de Greengrass que ejecute el script Hello World con Message el valor del parámetro como argumento.

  4. Ejecute el siguiente comando para crear una carpeta para los artefactos componentes.

    Linux or Unix
    mkdir -p artifacts/com.example.HelloWorld/1.0.0
    Windows Command Prompt (CMD)
    mkdir artifacts\com.example.HelloWorld\1.0.0
    PowerShell
    mkdir artifacts\com.example.HelloWorld\1.0.0
    importante

    Debe utilizar el siguiente formato para la ruta de la carpeta de artefactos. Incluya el nombre y la versión del componente que especifique en la receta.

    artifacts/componentName/componentVersion/
  5. Utilice un editor de texto para crear un archivo de artefactos de script de Python para su componente Hello World.

    Por ejemplo, en un sistema basado en Linux, puede ejecutar el siguiente comando para usar GNU nano para crear el archivo.

    nano artifacts/com.example.HelloWorld/1.0.0/hello_world.py

    Copie y pegue el siguiente script de Python en el archivo.

    import sys message = "Hello, %s!" % sys.argv[1] # Print the message to stdout, which Greengrass saves in a log file. print(message)
  6. Utilice la AWS IoT Greengrass CLI local para gestionar los componentes de su dispositivo principal de Greengrass.

    Ejecute el siguiente comando para implementar el componente en el AWS IoT Greengrass núcleo. Sustituya /greengrass/v2 o C:\greengrass\v2 por la carpeta AWS IoT Greengrass V2 raíz y sustituya ~/greengrassv2 o %USERPROFILE%\ greengrassv2 por la carpeta de desarrollo de componentes.

    Linux or Unix
    sudo /greengrass/v2/bin/greengrass-cli deployment create \ --recipeDir ~/greengrassv2/recipes \ --artifactDir ~/greengrassv2/artifacts \ --merge "com.example.HelloWorld=1.0.0"
    Windows Command Prompt (CMD)
    C:\greengrass\v2\bin\greengrass-cli deployment create ^ --recipeDir %USERPROFILE%\greengrassv2\recipes ^ --artifactDir %USERPROFILE%\greengrassv2\artifacts ^ --merge "com.example.HelloWorld=1.0.0"
    PowerShell
    C:\greengrass\v2\bin\greengrass-cli deployment create ` --recipeDir ~/greengrassv2/recipes ` --artifactDir ~/greengrassv2/artifacts ` --merge "com.example.HelloWorld=1.0.0"

    Este comando añade el componente que utiliza la receta en recipes y el script de Python enartifacts. La --merge opción añade o actualiza el componente y la versión que especifique.

  7. El software AWS IoT Greengrass Core guarda la salida estándar del proceso del componente en los archivos de registro de la logs carpeta. Ejecute el siguiente comando para comprobar que el componente Hello World se ejecuta e imprime los mensajes.

    Linux or Unix
    sudo tail -f /greengrass/v2/logs/com.example.HelloWorld.log
    Windows Command Prompt (CMD)
    type C:\greengrass\v2\logs\com.example.HelloWorld.log

    El type comando escribe el contenido del archivo en la terminal. Ejecute este comando varias veces para observar los cambios en el archivo.

    PowerShell
    gc C:\greengrass\v2\logs\com.example.HelloWorld.log -Tail 10 -Wait

    Debería ver mensajes similares a los del siguiente ejemplo.

    Hello, world!
    nota

    Si el archivo no existe, es posible que la implementación local aún no esté completa. Si el archivo no existe en 15 segundos, es probable que se haya producido un error en la implementación. Esto puede ocurrir si la receta no es válida, por ejemplo. Ejecute el siguiente comando para ver el archivo de registro AWS IoT Greengrass principal. Este archivo incluye registros del servicio de despliegue del dispositivo principal de Greengrass.

    Linux or Unix
    sudo tail -f /greengrass/v2/logs/greengrass.log
    Windows Command Prompt (CMD)
    type C:\greengrass\v2\logs\greengrass.log

    El type comando escribe el contenido del archivo en la terminal. Ejecute este comando varias veces para observar los cambios en el archivo.

    PowerShell
    gc C:\greengrass\v2\logs\greengrass.log -Tail 10 -Wait
  8. Modifique el componente local para iterar y probar el código. Ábrelo hello_world.py en un editor de texto y añade el siguiente código en la línea 4 para editar el mensaje que registra el AWS IoT Greengrass núcleo.

    message += " Greetings from your first Greengrass component."

    El hello_world.py script debería tener ahora el siguiente contenido.

    import sys message = "Hello, %s!" % sys.argv[1] message += " Greetings from your first Greengrass component." # Print the message to stdout, which Greengrass saves in a log file. print(message)
  9. Ejecute el siguiente comando para actualizar el componente con los cambios.

    Linux or Unix
    sudo /greengrass/v2/bin/greengrass-cli deployment create \ --recipeDir ~/greengrassv2/recipes \ --artifactDir ~/greengrassv2/artifacts \ --merge "com.example.HelloWorld=1.0.0"
    Windows Command Prompt (CMD)
    C:\greengrass\v2\bin\greengrass-cli deployment create ^ --recipeDir %USERPROFILE%\greengrassv2\recipes ^ --artifactDir %USERPROFILE%\greengrassv2\artifacts ^ --merge "com.example.HelloWorld=1.0.0"
    PowerShell
    C:\greengrass\v2\bin\greengrass-cli deployment create ` --recipeDir ~/greengrassv2/recipes ` --artifactDir ~/greengrassv2/artifacts ` --merge "com.example.HelloWorld=1.0.0"

    Este comando actualiza el com.example.HelloWorld componente con el último artefacto de Hello World.

  10. Ejecute el siguiente comando para reiniciar el componente. Al reiniciar un componente, el dispositivo principal utiliza los cambios más recientes.

    Linux or Unix
    sudo /greengrass/v2/bin/greengrass-cli component restart \ --names "com.example.HelloWorld"
    Windows Command Prompt (CMD)
    C:\greengrass\v2\bin\greengrass-cli component restart ^ --names "com.example.HelloWorld"
    PowerShell
    C:\greengrass\v2\bin\greengrass-cli component restart ` --names "com.example.HelloWorld"
  11. Vuelva a comprobar el registro para comprobar que el componente Hello World imprime el nuevo mensaje.

    Linux or Unix
    sudo tail -f /greengrass/v2/logs/com.example.HelloWorld.log
    Windows Command Prompt (CMD)
    type C:\greengrass\v2\logs\com.example.HelloWorld.log

    El type comando escribe el contenido del archivo en la terminal. Ejecute este comando varias veces para observar los cambios en el archivo.

    PowerShell
    gc C:\greengrass\v2\logs\com.example.HelloWorld.log -Tail 10 -Wait

    Debería ver mensajes similares a los del siguiente ejemplo.

    Hello, world! Greetings from your first Greengrass component.
  12. Puede actualizar los parámetros de configuración del componente para probar diferentes configuraciones. Al implementar un componente, puede especificar una actualización de la configuración, que defina cómo modificar la configuración del componente en el dispositivo principal. Puede especificar los valores de configuración que desea restablecer a los valores predeterminados y los nuevos valores de configuración que se van a combinar en el dispositivo principal. Para obtener más información, consulte Actualizar las configuraciones de los componentes.

    Haga lo siguiente:

    1. Utilice un editor de texto para crear un archivo llamado hello-world-config-update.json a contener la actualización de la configuración

      Por ejemplo, en un sistema basado en Linux, puede ejecutar el siguiente comando para usar GNU nano para crear el archivo.

      nano hello-world-config-update.json
    2. Copia y pega el siguiente objeto JSON en el archivo. Este objeto JSON define una actualización de configuración que fusiona el valor friend con el Message parámetro para actualizar su valor. Esta actualización de configuración no especifica ningún valor que se vaya a restablecer. No es necesario restablecer el Message parámetro porque la actualización de combinación reemplaza el valor existente.

      { "com.example.HelloWorld": { "MERGE": { "Message": "friend" } } }
    3. Ejecute el siguiente comando para implementar la actualización de configuración en el componente Hello World.

      Linux or Unix
      sudo /greengrass/v2/bin/greengrass-cli deployment create \ --merge "com.example.HelloWorld=1.0.0" \ --update-config hello-world-config-update.json
      Windows Command Prompt (CMD)
      C:\greengrass\v2\bin\greengrass-cli deployment create ^ --merge "com.example.HelloWorld=1.0.0" ^ --update-config hello-world-config-update.json
      PowerShell
      C:\greengrass\v2\bin\greengrass-cli deployment create ` --merge "com.example.HelloWorld=1.0.0" ` --update-config hello-world-config-update.json
    4. Vuelva a comprobar el registro para comprobar que el componente Hello World genera el nuevo mensaje.

      Linux or Unix
      sudo tail -f /greengrass/v2/logs/com.example.HelloWorld.log
      Windows Command Prompt (CMD)
      type C:\greengrass\v2\logs\com.example.HelloWorld.log

      El type comando escribe el contenido del archivo en la terminal. Ejecute este comando varias veces para observar los cambios en el archivo.

      PowerShell
      gc C:\greengrass\v2\logs\com.example.HelloWorld.log -Tail 10 -Wait

      Debería ver mensajes similares a los del siguiente ejemplo.

      Hello, friend! Greetings from your first Greengrass component.
  13. Cuando termines de probar el componente, retíralo del dispositivo principal. Ejecute el siguiente comando de la .

    Linux or Unix
    sudo /greengrass/v2/bin/greengrass-cli deployment create --remove="com.example.HelloWorld"
    Windows Command Prompt (CMD)
    C:\greengrass\v2\bin\greengrass-cli deployment create --remove="com.example.HelloWorld"
    PowerShell
    C:\greengrass\v2\bin\greengrass-cli deployment create --remove="com.example.HelloWorld"
    importante

    Este paso es necesario para volver a implementar el componente en el dispositivo principal después de cargarlo en él AWS IoT Greengrass. De lo contrario, se produce un error en la implementación y se produce un error de compatibilidad de versiones porque la implementación local especifica una versión diferente del componente.

    Ejecute el siguiente comando y compruebe que el com.example.HelloWorld componente no aparece en la lista de componentes del dispositivo.

    Linux or Unix
    sudo /greengrass/v2/bin/greengrass-cli component list
    Windows Command Prompt (CMD)
    C:\greengrass\v2\bin\greengrass-cli component list
    PowerShell
    C:\greengrass\v2\bin\greengrass-cli component list

Su componente Hello World está completo y ahora puede subirlo al servicio AWS IoT Greengrass en la nube. A continuación, puede implementar el componente en los dispositivos principales de Greengrass.