ステップ 4: デバイス上でコンポーネントを開発およびテストする

デバイスで Hello World コンポーネントを開発するには

1. recipe とアーティファクトのサブフォルダを含むコンポーネントのフォルダを作成します。Greengrass コアデバイスで次のコマンドを実行してこれらのフォルダを作成し、コンポーネントフォルダに変更します。~/greengrassv2 または %USERPROFILE%\greengrassv2 をローカル開発に使用するフォルダへのパスに置き換えます。

   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. テキストエディタを使用して、コンポーネントのメタデータ、パラメータ、依存関係、ライフサイクル、プラットフォーム機能を定義する recipe ファイルを作成します。recipe ファイル名にコンポーネントのバージョンを含めるようにして、どの recipe がどのコンポーネントバージョンを反映しているのかを特定できるようにします。recipe には YAML 形式または JSON 形式を選択できます。

   例えば、Linux ベースのシステムでは、次のコマンドを実行し、GNU nano を使用してファイルを作成できます。

   JSON

   nano recipes/com.example.HelloWorld-1.0.0.json

   YAML

   nano recipes/com.example.HelloWorld-1.0.0.yaml

   注記

   AWS IoT Greengrass はコンポーネントのセマンティックバージョンを使用します。セマンティックバージョンは、major.minor.patch といった番号システムに準拠します。例えば、バージョン 1.0.0 は、コンポーネントの最初のメジャーリリースを表しています。詳細については、「セマンティックバージョンの仕様」を参照してください。

3. ファイルに次の recipe を貼り付けます。

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

   この recipe の ComponentConfiguration セクションはパラメータである Message を定義しており、デフォルトでは world になります。Manifests セクションはマニフェストを定義しており、これは、プラットフォームのライフサイクル指示とアーティファクトのセットです。たとえば、複数のマニフェストを定義して、さまざまなプラットフォームに対して異なるインストール手順を指定することができます。マニフェストでは、Lifecycle セクションは、Greengrass コアデバイスに Message パラメータ値を引数として Hello World スクリプトを実行するように指示します。

4. 次のコマンドを実行して、コンポーネントアーティファクト用のフォルダを作成します。

   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

   重要

   アーティファクトフォルダのパスには、次のフォーマットを使用する必要があります。recipe で指定したコンポーネント名とバージョンを含めてください。

   artifacts/componentName/componentVersion/

5. テキストエディタを使用して、Hello World コンポーネントの Python スクリプトアーティファクトファイルを作成します。

   例えば、Linux ベースのシステムでは、次のコマンドを実行し、GNU nano を使用してファイルを作成できます。

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

   次の Python スクリプトをコピーしてファイルに貼り付けます。

   import sys
   
   message = "Hello, %s!" % sys.argv[1]
   
   # Print the message to stdout, which Greengrass saves in a log file.
   print(message)

6. ローカル AWS IoT Greengrass CLI を使用して Greengrass コアデバイスのコンポーネントを管理します。

   次のコマンドを実行して、AWS IoT Greengrass コアにコンポーネントをデプロイします。/greengrass/v2 または C:\greengrass\v2 をご使用の AWS IoT Greengrass V2 ルートフォルダと置き換えて、~/greengrassv2 または %USERPROFILE%\greengrassv2 をコンポーネント開発フォルダに置き換えます。

   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"

   このコマンドは、recipes では recipe 、artifacts では Python スクリプトを使用するコンポーネントを追加します。--merge オプションは指定したコンポーネントとバージョンを追加または更新します。

7. AWS IoT Greengrass Core ソフトウェアは、コンポーネントプロセスからの標準出力を logs フォルダのログファイルに保存します。Hello World コンポーネントが実行され、メッセージが表示されることを確認するには、次のコマンドを実行します。

   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

   type コマンドは、ファイルのコンテンツを端末に書き込みます。このコマンドを複数回実行して、ファイル内の変更を確認してください。

   PowerShell

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

   次の例に示すようなメッセージが表示されます。

   Hello, world!

   注記

   ファイルが存在しない場合、ローカルデプロイがまだ完了していない可能性があります。ファイルが 15 秒以内に表示されない場合は、デプロイが失敗している可能性があります。これは、recipe が有効でない場合などに発生します。次のコマンドを実行して、AWS IoT Greengrass コアのログファイルを確認します。このファイルは、Greengrass コアデバイスのデプロイサービスからのログが含まれます。

   Linux or Unix

   sudo tail -f /greengrass/v2/logs/greengrass.log

   Windows Command Prompt (CMD)

   type C:\greengrass\v2\logs\greengrass.log

   type コマンドは、ファイルのコンテンツを端末に書き込みます。このコマンドを複数回実行して、ファイル内の変更を確認してください。

   PowerShell

   gc C:\greengrass\v2\logs\greengrass.log -Tail 10 -Wait

8. ローカルコンポーネントを変更して、コードを繰り返してテストします。テキストエディタで hello_world.py を開き、4 行目に次のコードを追加して、AWS IoT Greengrass コアがログするメッセージを編集します。

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

   hello_world.py スクリプトには次の内容が表示されるはずです。

   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. 次のコマンドを実行して、変更内容でコンポーネントを更新します。

   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"

   このコマンドは、最新の Hello World アーティファクトで com.example.HelloWorld コンポーネントを更新します。

10. 次のコマンドを実行して、コンポーネントを再起動します。コンポーネントを再起動すると、コアデバイスは最新の変更を使用します。

    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. ログをもう一度確認して、Hello World コンポーネントが新しいメッセージを出力することか確認してください。

    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

    type コマンドは、ファイルのコンテンツを端末に書き込みます。このコマンドを複数回実行して、ファイル内の変更を確認してください。

    PowerShell

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

    次の例に示すようなメッセージが表示されます。

    Hello, world! Greetings from your first Greengrass component.

12. コンポーネントの設定パラメータを更新して、さまざまな設定をテストできます。コンポーネントをデプロイするときに、設定の更新を指定して、コアデバイス上のコンポーネントの設定を変更する方法を定義することができます。デフォルト値にリセットする設定値と、コアデバイスにマージする新しい設定値を指定することができます。詳細については、「コンポーネント設定の更新」を参照してください。

    以下の操作を実行します。

    1. テキストエディタを使用して、hello-world-config-update.json という名前のファイルを作成し、設定の更新を含めます。

       例えば、Linux ベースのシステムでは、次のコマンドを実行し、GNU nano を使用してファイルを作成できます。

       nano hello-world-config-update.json

    2. 次の JSON オブジェクトをファイルにコピーして貼り付けます。この JSON オブジェクトは、friend の値を Message パラメータにマージして、その値を更新する設定更新を定義しています。この設定更新では、リセットする値は指定されていません。マージの更新によって既存の値が置き換えられるため、Message パラメータをリセットする必要はありません。

       {
         "com.example.HelloWorld": {
           "MERGE": {
             "Message": "friend"
           }
         }
       }

    3. 次のコマンドを実行して、設定の更新を 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. ログをもう一度確認して、Hello World コンポーネントが新しいメッセージを出力することか確認してください。

       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

       type コマンドは、ファイルのコンテンツを端末に書き込みます。このコマンドを複数回実行して、ファイル内の変更を確認してください。

       PowerShell

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

       次の例に示すようなメッセージが表示されます。

       Hello, friend! Greetings from your first Greengrass component.

13. コンポーネントのテストが完了したら、コアデバイスから削除します。以下のコマンドを実行します。

    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"

    重要

    この手順は、コンポーネントを AWS IoT Greengrass にアップロードした後、コアデバイスにコンポーネントをデプロイし直すために必要です。そうしなかった場合、ローカルデプロイはコンポーネントの異なるバージョンを指定しているため、デプロイがバージョンの互換性エラーで失敗します。

    次のコマンドを実行して、com.example.HelloWorld コンポーネントが、デバイス上のコンポーネントリストに表示されないことを確認します。

    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