Paso 4: Desarrollo y prueba de un componente en su dispositivo

Un componente es un módulo de software que se ejecuta en los dispositivos principales de AWS IoT Greengrass. Los componentes le permiten crear y administrar aplicaciones complejas como bloques de compilación discretos que puede reutilizar de un dispositivo principal de Greengrass a otro. Cada componente incluye 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, dependencias del componente, ciclo de vida y compatibilidad de plataforma del componente. El ciclo de vida del componente define los comandos que instalan, ejecutan y apagan el componente. Para obtener más información, consulte Referencia de receta del componente de AWS IoT Greengrass.

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 utilice un componente. Los componentes también pueden utilizar 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 principal de Greengrass sin interactuar con la nube de AWS. Cuando complete su componente local, podrá usar la receta y los artefactos del componente para crear ese componente en el servicio de AWS IoT Greengrass en la nube de AWS y, a continuación, implementarlo en todos sus dispositivos principales de Greengrass. Para obtener más información sobre los componentes, consulte Desarrollo de componentes de AWS IoT Greengrass.

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

Desarrollo de un componente de Hello World en su dispositivo

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. Reemplace ~/greengrassv2 o %USERPROFILE%\greengrassv2 por la ruta a la carpeta que se usará 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
```
Use un editor de texto para crear un archivo de recetas que define los metadatos, parámetros, dependencias, ciclo de vida y capacidad de 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. Puede elegir el formato YAML o JSON para su receta.

Por ejemplo, en un sistema basado en Linux, puede ejecutar el siguiente comando para usar GNU nano a fin de 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 el primer lanzamiento principal de un componente. Para obtener más información, consulte la especificación semántica de la versión.

Pegue la siguiente receta en el archivo.

La receta de la sección ComponentConfiguration define un parámetro, Message, cuyo valor predeterminado es world. La sección Manifests 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 sección Lifecycle indica al dispositivo principal de Greengrass que ejecute el script Hello World con el valor del parámetro Message como un argumento.

Ejecute el siguiente comando para crear una carpeta para los artefactos del componente.
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 usar 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/
```
Use 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 a fin de 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)
```
Use la CLI de AWS IoT Greengrass local para administrar los componentes de su dispositivo principal de Greengrass.

Ejecute el siguiente comando para implementar los componentes en el núcleo de AWS IoT Greengrass. Reemplace /greengrass/v2 o C:\greengrass\v2 por su carpeta raíz de AWS IoT Greengrass V2 y reemplace ~/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 agrega el componente que usa la receta en recipes y el script de Python en artifacts. La opción --merge agrega o actualiza el componente y la versión que especifique.
El software AWS IoT Greengrass Core guarda stdout del proceso del componente para los archivos de registro en la carpeta logs. Ejecute el siguiente comando para comprobar que el componente Hello World ejecuta e imprime 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 comando type 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 al 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 la implementación haya fallado. Esto puede ocurrir si la receta no es válida, por ejemplo. Ejecute el siguiente comando para ver el archivo de registro principal de AWS IoT Greengrass. Este archivo incluye registros del servicio de implementación 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 comando type 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
Modifique el componente local para iterar y probar el código. Abra hello_world.py en un editor de texto y agregue el siguiente código en la línea 4 para editar el mensaje que registra el núcleo de AWS IoT Greengrass.
```
message += " Greetings from your first Greengrass component."
```
Ahora, el script hello_world.py debería tener los siguientes contenidos.
```
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)
```

Ejecute el siguiente comando para actualizar el componente con los cambios.

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

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

Vuelva a comprobar el registro para verificar 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 comando type 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 al del siguiente ejemplo.
```
Hello, world! Greetings from your first Greengrass component.
```
Puede actualizar los parámetros de configuración del componente para probar diferentes configuraciones. Al implementar un componente, puede especificar una actualización de configuración, que defina cómo modificar la configuración del componente en el dispositivo principal. Puede especificar qué valores de configuración desea restablecer a los valores predeterminados y los nuevos valores de configuración que se van a fusionar en el dispositivo principal. Para obtener más información, consulte Actualización de las configuraciones de los componentes.

Haga lo siguiente:
1. Use un editor de texto para crear un archivo llamado hello-world-config-update.json para contener la actualización de configuración
  
  Por ejemplo, en un sistema basado en Linux, puede ejecutar el siguiente comando para usar GNU nano a fin de crear el archivo.
```
nano hello-world-config-update.json
```
2. Copie y pegue el siguiente objeto JSON en el archivo. Este objeto JSON define una actualización de configuración que combina el valor friend con el parámetro Message 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 parámetro Message porque la actualización de la 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 comando type 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 al del siguiente ejemplo.
```
Hello, friend! Greetings from your first Greengrass component.
```
Cuando termine de probar el componente, retírelo 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 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 componente com.example.HelloWorld no aparezca 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 en la nube de AWS IoT Greengrass. A continuación, puede implementar el componente en los dispositivos principales de Greengrass.

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

Verificación de la instalación de la CLI de Greengrass en el dispositivo

Paso 5: Crear un componente en el servicio de AWS IoT Greengrass

Paso 4: Desarrollo y prueba de un componente en su dispositivo

Desarrollo de un componente de Hello World en su dispositivo

nota

importante

nota

importante