Crea AWS IoT Greengrass componenti

Se non l'hai già fatto, installa la CLI GDK sul tuo computer di sviluppo. Per ulteriori informazioni, consulta Installare o aggiornare l'interfaccia a riga di comando del AWS IoT Greengrass Development Kit.

Passa alla cartella in cui desideri creare le cartelle dei componenti.

Scegliete un modello di componente o un componente della community da scaricare. La CLI di GDK scarica il modello o il componente della community, quindi puoi iniziare da un esempio funzionale. Utilizzate il comando component list per recuperare l'elenco dei modelli disponibili o dei componenti della community.

• Per elencare i modelli dei componenti, esegui il comando seguente. Ogni riga della risposta include il nome e il linguaggio di programmazione di un modello.

  gdk component list --template

• Per elencare i componenti della community, esegui il comando seguente.

  gdk component list --repository

Crea e passa a una cartella di componenti in cui la CLI di GDK scarica il modello o il componente della community. Sostituisci HelloWorldcon il nome del componente o un altro nome che ti aiuti a identificare la cartella del componente.

Scarica il modello o il componente della community nella cartella corrente. Usa il comando component init.

• Per creare una cartella di componenti da un modello, esegui il comando seguente. Sostituisci HelloWorldcon il nome del modello e sostituisci python con il nome del linguaggio di programmazione.

  gdk component init --template HelloWorld --language python

• Per creare una cartella di componenti da un componente della comunità, esegui il comando seguente. Sostituisci ComponentNamecon il nome del componente della community.

  gdk component init --repository ComponentName

La CLI GDK legge dal file di configurazione GDK CLI, gdk-config.json denominato, per creare e pubblicare componenti. Questo file di configurazione esiste nella radice della cartella del componente. Il passaggio precedente crea questo file automaticamente. In questo passaggio, si aggiorna gdk-config.json con le informazioni sul componente. Esegui questa operazione:

1. Aprire gdk-config.json in un editor di testo.

2. (Facoltativo) Modifica il nome del componente. Il nome del componente è la chiave dell'componentoggetto.

3. Cambia l'autore del componente.

4. (Facoltativo) Modifica la versione del componente. Specifica una delle seguenti proprietà:

   • NEXT_PATCH— Quando scegliete questa opzione, la CLI di GDK imposta la versione quando pubblicate il componente. La CLI GDK interroga AWS IoT Greengrass il servizio per identificare l'ultima versione pubblicata del componente. Quindi, imposta la versione alla versione della patch successiva a quella versione. Se non hai mai pubblicato il componente prima, la CLI di GDK utilizza la versione. 1.0.0

     Se scegli questa opzione, non puoi utilizzare la CLI di Greengrass per distribuire e testare localmente il componente sul tuo computer di sviluppo locale che esegue il software Core. AWS IoT Greengrass Per abilitare le distribuzioni locali, devi invece specificare una versione semantica.

   • Una versione semantica, ad esempio. 1.0.0 Le versioni semantiche utilizzano un major. minore. sistema di numerazione delle patch. Per ulteriori informazioni, consulta la specifica della versione semantica.

     Se sviluppate componenti su un dispositivo Greengrass core su cui desiderate distribuire e testare il componente, scegliete questa opzione. È necessario creare il componente con una versione specifica per creare distribuzioni locali con la Greengrass CLI.

5. (Facoltativo) Modificate la configurazione di compilazione per il componente. La configurazione di build definisce come la CLI di GDK crea il sorgente del componente in artefatti. Scegliete tra le seguenti opzioni per: build_system

   • zip— Impacchetta la cartella del componente in un file ZIP da definire come unico elemento del componente. Scegliete questa opzione per i seguenti tipi di componenti:

     • Componenti che utilizzano linguaggi di programmazione interpretati, come Python o. JavaScript

     • Componenti che impacchettano file diversi dal codice, come modelli di apprendimento automatico o altre risorse.

     La CLI GDK comprime la cartella del componente in un file zip con lo stesso nome della cartella del componente. Ad esempio, se il nome della cartella del componente èHelloWorld, la CLI GDK crea un file zip denominato. HelloWorld.zip

     Nota

     Se si utilizza la versione 1.0.0 della CLI di GDK su un dispositivo Windows, i nomi delle cartelle dei componenti e dei file zip devono contenere solo lettere minuscole.

     Quando la CLI di GDK comprime la cartella del componente in un file zip, salta i seguenti file:

     • Il file gdk-config.json

     • Il file della ricetta (o) recipe.json recipe.yaml

     • Crea cartelle, come greengrass-build

   • maven— Esegue il mvn clean package comando per creare il codice sorgente del componente in artefatti. Scegli questa opzione per i componenti che utilizzano Maven, come i componenti Java.

     Sui dispositivi Windows, questa funzionalità è disponibile per GDK CLI v1.1.0 e versioni successive.

   • gradle— Esegue il gradle build comando per creare il codice sorgente del componente in artefatti. Scegliete questa opzione per i componenti che utilizzano Gradle. Questa funzionalità è disponibile per GDK CLI v1.1.0 e versioni successive.

     Il sistema di gradle build supporta Kotlin DSL come file di build. Questa funzionalità è disponibile per GDK CLI v1.2.0 e versioni successive.

   • gradlew— Esegue il gradlew comando per creare il codice sorgente del componente in artefatti. Scegliete questa opzione per i componenti che utilizzano il Gradle Wrapper.

     Questa funzionalità è disponibile per GDK CLI v1.2.0 e versioni successive.

   • custom— Esegue un comando personalizzato per creare il codice sorgente del componente in una ricetta e in artefatti. Specificate il comando personalizzato nel custom_build_command parametro.

6. Se specificate custom forbuild_system, aggiungete il custom_build_command all'buildoggetto. Incustom_build_command, specificate una singola stringa o un elenco di stringhe, dove ogni stringa è una parola nel comando. Ad esempio, per eseguire un comando di compilazione personalizzato per un componente C++, è possibile specificare. ["cmake", "--build", "build", "--config", "Release"]

7. Se utilizzi GDK CLI v1.1.0 o versione successiva, puoi specificare --bucket l'argomento per specificare il bucket S3 in cui la CLI di GDK carica gli artefatti del componente. Se non specifichi questo argomento, la CLI di GDK viene caricata nel bucket S3 il cui nome bucket-region-accountId è, dove bucket e region sono i valori specificati e AccountID è il tuo IDgdk-config.json. Account AWS La CLI GDK crea il bucket se non esiste.

   Modifica la configurazione di pubblicazione per il componente. Esegui questa operazione:

   1. Specificate il nome del bucket S3 da utilizzare per ospitare gli artefatti dei componenti.

   2. Specificate Regione AWS dove la CLI di GDK pubblica il componente.

Al termine di questo passaggio, il gdk-config.json file potrebbe essere simile all'esempio seguente.

{
  "component": {
    "com.example.PythonHelloWorld": {
      "author": "Amazon",
      "version": "NEXT_PATCH",
      "build": {
        "build_system" : "zip"
      },
      "publish": {
        "bucket": "greengrass-component-artifacts",
        "region": "us-west-2"
      }
    }
  },
  "gdk_version": "1.0.0"
}

Aggiornate il file di ricetta del componente, denominato recipe.yaml orecipe.json. Esegui questa operazione:

1. Se hai scaricato un modello o un componente della community che utilizza il sistema di zip compilazione, verifica che il nome dell'artefatto zip corrisponda al nome della cartella del componente. La CLI GDK comprime la cartella del componente in un file zip con lo stesso nome della cartella del componente. La ricetta contiene il nome dell'artefatto zip nell'elenco degli artefatti dei componenti e negli script del ciclo di vita che utilizzano i file nell'elemento zip. Aggiorna le Lifecycle definizioni Artifacts e in modo che il nome del file zip corrisponda al nome della cartella del componente. I seguenti esempi di ricette parziali evidenziano il nome del file zip nelle Lifecycle definizioni Artifacts and.

   JSON

   {
     ...
     "Manifests": [
       {
         "Platform": {
           "os": "all"
         },
         "Artifacts": [
           {
             "URI": "s3://{COMPONENT_NAME}/{COMPONENT_VERSION}/HelloWorld.zip",
             "Unarchive": "ZIP"
           }
         ],
         "Lifecycle": {
           "run": "python3 -u {artifacts:decompressedPath}/HelloWorld/main.py {configuration:/Message}"
         }
       }
     ]
   }

   YAML

   ---
   ...
   Manifests:
     - Platform:
         os: all
       Artifacts:
         - URI: "s3://BUCKET_NAME/COMPONENT_NAME/COMPONENT_VERSION/HelloWorld.zip"
           Unarchive: ZIP
       Lifecycle:
         run: "python3 -u {artifacts:decompressedPath}/HelloWorld/main.py {configuration:/Message}"

2. (Facoltativo) Aggiornate la descrizione del componente, la configurazione predefinita, gli artefatti, gli script del ciclo di vita e il supporto della piattaforma. Per ulteriori informazioni, consulta AWS IoT Greengrass riferimento alla ricetta del componente.

Al termine di questo passaggio, il file delle ricette potrebbe essere simile ai seguenti esempi.

Sviluppa e costruisci il componente Greengrass. Il comando component build produce una ricetta e degli artefatti nella greengrass-build cartella della cartella del componente. Esegui il comando seguente.

gdk component build

Crea una cartella per i tuoi componenti con sottocartelle per ricette e artefatti. Esegui i seguenti comandi sul tuo dispositivo principale Greengrass per creare queste cartelle e passare alla cartella dei componenti. Sostituisci ~/greengrassv2 o %USERPROFILE%\ greengrassv2 con il percorso della cartella da utilizzare per lo sviluppo locale.

Usa un editor di testo per creare un file di ricette che definisca i metadati, i parametri, le dipendenze, il ciclo di vita e le funzionalità della piattaforma del componente. Includi la versione del componente nel nome del file di ricetta in modo da poter identificare quale ricetta riflette quale versione del componente. Puoi scegliere il formato YAML o JSON per la tua ricetta.

Ad esempio, su un sistema basato su Linux, è possibile eseguire il comando seguente per utilizzare GNU nano per creare il file.

Definite la ricetta per il componente. Per ulteriori informazioni, consulta AWS IoT Greengrass riferimento alla ricetta del componente.

La tua ricetta potrebbe essere simile alla seguente ricetta di esempio di Hello World.

Questa ricetta esegue uno script Hello World Python, che potrebbe essere simile allo script di esempio seguente.

import sys

message = "Hello, %s!" % sys.argv[1]

# Print the message to stdout, which Greengrass saves in a log file.
print(message)

Crea una cartella per lo sviluppo della versione del componente. Ti consigliamo di utilizzare una cartella separata per gli artefatti di ogni versione del componente in modo da poter identificare quali artefatti sono per ogni versione del componente. Esegui il comando seguente.

artifacts/componentName/componentVersion/

Create gli artefatti per il componente nella cartella creata nel passaggio precedente. Gli artefatti possono includere software, immagini e qualsiasi altro file binario utilizzato dal componente.

Quando il componente è pronto, testalo.