5 Replies Latest reply on Apr 21, 2020 2:32 AM by JuyoungJ_06

    Community Translation - Running Amazon FreeRTOS Code Examples - KBA228845

    MoTa_728816

      Hi,

       

      I'd like to try to translate this KBA228845 into Japanese.

       

      moto

       

      Original KBA: KBA228845

      Running Amazon FreeRTOS Code Examples - KBA228845

       

      Translated by: MoTa_728816

      ========================

      このナレッジベースドキュメントは Cypress GitHub repository より入手可能な ModusToolbox™ Amazon FreeRTOS SDK 用のサンプルコードに適用します。

       

      Amazon FreeRTOS に同梱されているデモアプリケーションに加えて、Cypress では CapSense® 等のように PSoC MCU のユニークな特徴をデモするようなサンプルコードを提供しています。これらのサンプルコードは Cypress GitHub repository から見つけることができます。

       

      これらのサンプルコードは3種類のビルドフローをサポートしています - ModusToolbox IDE、ModusToolbox コマンドラインインターフェース (CLI)、CMake です。

       

      必要なソフトウェア

       

      ツール

      説明

      Git

      Amazon FreeRTOS とサンプルコードのクローン(複製)を作成するために必要

      ModusToolbox

      サンプルコードを ModusToolbox IDE か CLI で、実行するために必要

      Cypress Programmer

      サンプルコードを CMake でビルドしている場合、ターゲットボードへの書込みに必要

      CMake

      サンプルコードを CMake でビルドする場合に必要

      Ninja

      CMake を Windows で使用している場合に必要

       

      ハードウェアの設定

       

      先ず始めにお使いのキットには最新の KitProg3 ファームウェアが書き込まれていることを確認してください。 KitProg3 のファームウェアをアップデートするのには以降の手順に従ってください。詳細な方法については firmware-loader の ページをご参照ください。

       

       1. 最新の firmware-loader ツールをダウンロードしてください。firmware-loader ツールは ModusToolbox IDE と合わせて下記にもインストールされています。

        <install_dir>/ModusToolbox/tools_x.x/fw-loader-x.x.

       

       2. キット上の KitProg USB コネクタをご使用のコンピュータに接続してください。

       

       3. firmware-loader のバイナリがあるディレクトリで下記のコマンドを実行してください。

        fw-loader --update-kp3

       

        注意: Linux では、fw-loader を最初に実行する前に、udev_rules/install_rules.sh を実行する必要があります。

       

       4. ModusToolbox IDE から書込みを行うためには、キットが KitProg3 モードになっていることを確認してください。

        琥珀色(アンバー)のステータス LED(LED2)が点灯しているか、1秒間隔で点滅しているはずです。

        そうでない場合には、モード選択ボタン SW3 を押して KitProg3 モードに切り替えてください。

       

       

      Amazon FreeRTOS と サンプルコードをクローン(複製)する

       

       1. GitHub から Amazon FreeRTOS をクローンして、その tag を使用して最新版をチェックアウトします。

        サンプルコードに含まれている README.md をみてサンプルコードがサポートしているリリースを確認します。

        下記のコマンドでも同様に全てのサブモジュールをクローン可能です。

       

           git clone https://github.com/cypresssemiconductorco/amazon-freertos.git -b <release-tag> --recurse-submodules

            注意:

            ・<amazon-freertos> はお使いのコンピュータ上での Amazon FreeRTOS のパスを指します。

            ・Microsoft Windows のファイルパスの最大長は 260文字です。Amazon FreeRTOS のディレクトリパスが長い場合にはビルドが失敗する可能性があります。

             <amazon-freertos>ディレクトリへのパスは 98文字未満になるようにしてください。

       

       2. <amazon-freertos>/projects/cypressfolder へ移動してください。

       

       3. サンプルコードをサブモジュールと合わせてクローンしてください。

           git clone <repo-url> --recurse-submodules

           例えば、afr-example-capsense をクローンする場合には下記のコマンドを実行します。

           git clone https://github.com/cypresssemiconductorco/afr-example-capsense.git --recurse-submodules

       

       4. キットを添付の USB ケーブルを使用して USB コネクタからお使いの PC に接続してください。

       

       5. ターミナルプログラムを起動して、KitPro3 の COMポートを選択します。

           シリアル通信の設定をボーレート 115200 の 8N1 (8bit、 パリティなし、ストップビット1) に設定してください。

       

      Amazon FreeRTOS の設定

       

       1. 始める前に、ご使用のデバイスを AWS クラウドに接続する為に AWS IoT の設定を行う必要があります。

       

        AWS IoT 接続の設定方法についてはFirst Steps” section of the Amazon FreeRTOS user guide をご参照ください。

        Cypress のキットと使用するためには、Amazon FreeRTOS は Cypress の GitHub repository からのヴァージョンを使用する必要がありますので

        Amazon FreeRTOS user guide に記載されている他の場所からダウンロードする方法は無視してください。

        一部のサンプルコードは AWS IoT との接続を必要としない場合があります。その場合、このステップは省略していただけます。

        サンプルコードが AWS IoT の設定を必要とするかについては、そのサンプルコード付属の README.md を読んでご判断ください。

       

       2. AWS IoT の設定が終了したら、Amazon FreeRTOS を設定する必要があります。

        厳密なコンフィグレーションはサンプルコード毎に異なる場合があります。

        サンプルコード付属の README.md をご参照ください。通常、以下の設定が必要になります。

        これらのファイルは <amazon-freertos>/demos/include ディレクトリの下に置かれています。

       

         ・Wi-Fi 設定 (SSID, パスワード) と aws_clientcredential.h 内の MQTT endpoint

         ・aws_clientcredential_keys.h 内の Client certificate と private key

       

      サンプルコードの実行

       

      ModusToolbox IDE を使用する場合

       

       1. ModusToolbox IDE を起動して、workspace を選択するか作成してください。

       2. メニューから File > Import を選択します。

       3. 表示されるウィンドウで、General フォルダを展開して、 Existing Projects into Workspace を選択し、Next をクリックする。

       001-pastedImage_30.png

       4. Import Projects のウィンドウの Select root directory の欄で、

        右側にある Browse をクリックして <amazon-freertos>/projects/cypress/<code_example_directory> を選択します。

        デフォルトでは <code_example> プロジェクトが選択されているはずです。

        Finish をクリックしてプロジェクトをワークスペースにインポートしてください。

       002-pastedImage_31.png

       5. Project Explorer 内の当該プロジェクトをクリックします。

        これで Quick Panel 内に build と program のアクションが表示されます。

       6. Quick Panel 内で、<code_example> Program (KitProg3) をクリックします。

        これでプロジェクトがビルドされ、キットにプログラムされます。

       7. サンプルコード付属の README.md の指示にしたがって実行結果を検分してください。

        サンプルコードが UART出力をサポートしている場合、シリアルターミナルを接続する必要があります。

       

      ModusToolbox IDE で異なるターゲットを使用する

       

      ターゲットボードはサンプルコードの Makefile 内の変数 TARGET で設定されています。

      IDE で異なるターゲットを使用する場合には下記の手順に従ってください:

       

       1. <amazon-freertos/projects/cypress/<code_example_directory>/.mtbLaunchConfigs ディレクトリ下のすべてのラウンチコンフィグレーションファイル (*.launch) を削除してください。

       2. Makefile 内の TARGET 変数を新しいターゲットに変更してください。例えば CY8CKIT-062-WIFI-BT。

        注意:Makefile 内のターゲット名はセパレータにアンダースコアの代わりにハイフォンを使用します。

       3. IDE の Project Explorer 内でサンプルコードを右クリックして Build Targets > Create を選択してください。

       4. 表示されるウィンドウ内で、Target Nameeclipse を入力して、OK をクリックします。

       003-pastedImage_36.png

        下記のように、プロジェクトの下に Build Targets が現れます。

       004-pastedImage_37.png

       5. Build Targets の下の eclipse をダブルクリックして新しいターゲット用のラウンチコンフィグレーションファイルが生成されるまで待ちます。

        進行状況は ビルドコンソールウィンドウ内に表示されます。

       6. 新しいターゲットへの書込みには、Project Explorer 内のプロジェクトをクリックして、

        Quick Panel から <code_example> Program (KitProg3) を選択してください。

       

       

      コマンドラインインターフェース (CLI) を使用する

       

      ModusToolbox コマンドラインインターフェース (CLI) は アプリケーションビルドを実行するための GNU make をベースとしたビルドシステムです。

      本節では CLI を使用してサンプルコードを実行する方法を説明します。詳細については Running ModusToolbox from the Command Lineをご参照ください。

      ModusToolbox IDE も同じビルドシステムを使用しています。そのため、CLI と IDE 間の切り替えは完全にサポートされています。

       

       1. CLI ターミナルを起動して、CE ディレクトリに移動してください。

       2. make  program コマンドを実行するとデフォルトツールチェーンを使用してプログラムをビルドし、デフォルトのターゲットに書込みを行います。

        ターゲットとツールチェーンは手動で指定可能です:

           make program TARGET=<BSP> TOOLCHAIN=<toolchain>

            例: make program TARGET=CY8CKIT-062-WIFI-BT TOOLCHAIN=GCC_ARM

           注意:make コマンド中のターゲット名はセパレータにハイフォンを使用します。

       3. サンプルコード付属の README.md の指示にしたがって実行結果検分してください

        サンプルコードが UART出力をサポートしている場合、シリアルターミナルを接続する必要があります。

       

      CMake を使用する

       

       1. <amazon-freertos> ディレクトリの下にビルドフォルダを作成してください。例えば, <amazon-freertos>/build/cmake_build。

       2. ビルドフォルダか下記のコマンドを実行してください。ボード名とサンプルコード名はお使いのボードと実行したいサンプルコード名に置き換えてください。

           cmake -G Ninja -S ../.. -B . -DVENDOR=cypress -DCOMPILER=arm-gcc -DBOARD=CY8CPROTO_062_4343W -DAPP=projects/cypress/afr-example-wifi-scan

           注意:

         ・ cmake コマンド内で使用するボード名はセパレータにアンダースコアを使用します。

         ・上記のコマンドはビルドツール Ninja 用のコンフィグレーションを生成します。

          “Unix Makefiles”のように CMake でサポートされている他のビルドツール用のものも生成することが可能です。

       3. CMake がコンフィグレーションを生成した後は、以下のコマンドどを実行してください。

      cmake --build .

      注意: 現在のディレクトリの指定はドット ( . ) を使用しています。

       4. <amazon-freertos>/build/cmake_build ディレクトリ下に生成された *.elf をターゲットに書込むのには Cypress Programmer を使用してください。

       5. サンプルコード付属の README.md の指示にしたがって実行結果を検分してください

        サンプルコードが UART出力をサポートしている場合、シリアルターミナルを接続する必要があります。

      ========================

       

      1-Apr-2020

      moto

        • 1. Re: Community Translation - Running Amazon FreeRTOS Code Examples - KBA228845
          JuyoungJ_06

          Hello, Tanaka-san

           

          We receive your translation, it will be published to KBA to Community.

          After upload, You will receive the points as the word of KBA.

           

          Please bear with me for the delayed the response,

           

          Thanks for your contribution to CDC!

          Will keep you update the status.

           

          Thanks,

          Jenna Jo

          • 2. Re: Community Translation - Running Amazon FreeRTOS Code Examples - KBA228845
            MoTa_728816

            Dear Jenna-san,

             

            Today I received a "You have been mentioned ..." notice and when I saw the following URL

            Running Amazon FreeRTOS Code Examples - KBA228845 - Community Translated (JA)

             

            Reviewing the published URL, I noticed a few things.

            Which is the almost last part of the document

            =================

            3. CMake がコンフィグレーションを⽣成した後は、以下のコマンドどを実⾏してください。

            cmake --build .

            注意︓ 現在のディレクトリの指定はドット ( . ) を使⽤しています。

            =================

            In the first line "コマンドど"  was typo of "コマンド"

            And also I'd like to have the 2nd line and 3rd line indented.

            So I hope this should look like

            =================

            3. CMake がコンフィグレーションを⽣成した後は、以下のコマンドを実⾏してください。

                cmake --build .

                注意︓ 現在のディレクトリの指定はドット ( . ) を使⽤しています。

            =================

             

            One more things.

            At this time of translation, I did not know about how to use block indentation of this web editor.

            If it is possible, I'd like to change the format like my reply below.

             

            Best Regards,

            20-Apr-2020

            Motoo Tanaka

            • 3. Re: Community Translation - Running Amazon FreeRTOS Code Examples - KBA228845
              MoTa_728816

              Community Translation - Running Amazon FreeRTOS Code Examples - KBA228845

               

              Hi,

               

              I'd like to try to translate this KBA228845 into Japanese.

               

              moto

               

              Original KBA: KBA228845

              Running Amazon FreeRTOS Code Examples - KBA228845

               

              Translated by: MoTa_728816

              ========================

              このナレッジベースドキュメントは Cypress GitHub repository より入手可能な ModusToolbox™ Amazon FreeRTOS SDK 用のサンプルコードに適用します。

               

              Amazon FreeRTOS に同梱されているデモアプリケーションに加えて、Cypress では CapSense® 等のように PSoC MCU のユニークな特徴をデモするようなサンプルコードを提供しています。これらのサンプルコードは Cypress GitHub repository から見つけることができます。

               

              これらのサンプルコードは3種類のビルドフローをサポートしています - ModusToolbox IDE、ModusToolbox コマンドラインインターフェース (CLI)、CMake です。

               

              必要なソフトウェア

               

              ツール

              説明

              Git

              Amazon FreeRTOS とサンプルコードのクローン(複製)を作成するために必要

              ModusToolbox

              サンプルコードを ModusToolbox IDE か CLI で、実行するために必要

              Cypress Programmer

              サンプルコードを CMake でビルドしている場合、ターゲットボードへの書込みに必要

              CMake

              サンプルコードを CMake でビルドする場合に必要

              Ninja

              CMake を Windows で使用している場合に必要

               

              ハードウェアの設定

               

              先ず始めにお使いのキットには最新の KitProg3 ファームウェアが書き込まれていることを確認してください。 KitProg3 のファームウェアをアップデートするのには以降の手順に従ってください。詳細な方法については firmware-loader の ページをご参照ください。

               

               1. 最新の firmware-loader ツールをダウンロードしてください。firmware-loader ツールは ModusToolbox IDE と合わせて下記にもインストールされています。

                <install_dir>/ModusToolbox/tools_x.x/fw-loader-x.x.

               

               2. キット上の KitProg USB コネクタをご使用のコンピュータに接続してください。

               

               3. firmware-loader のバイナリがあるディレクトリで下記のコマンドを実行してください。

                fw-loader --update-kp3

               

                注意: Linux では、fw-loader を最初に実行する前に、udev_rules/install_rules.sh を実行する必要があります。

               

               4. ModusToolbox IDE から書込みを行うためには、キットが KitProg3 モードになっていることを確認してください。

                琥珀色(アンバー)のステータス LED(LED2)が点灯しているか、1秒間隔で点滅しているはずです。

                そうでない場合には、モード選択ボタン SW3 を押して KitProg3 モードに切り替えてください。

               

               

              Amazon FreeRTOS と サンプルコードをクローン(複製)する

               

               1. GitHub から Amazon FreeRTOS をクローンして、その tag を使用して最新版をチェックアウトします。

                サンプルコードに含まれている README.md をみてサンプルコードがサポートしているリリースを確認します。

                下記のコマンドでも同様に全てのサブモジュールをクローン可能です。

               

                   git clone https://github.com/cypresssemiconductorco/amazon-freertos.git -b <release-tag> --recurse-submodules

                    注意:

                    ・<amazon-freertos> はお使いのコンピュータ上での Amazon FreeRTOS のパスを指します。

                    ・Microsoft Windows のファイルパスの最大長は 260文字です。Amazon FreeRTOS のディレクトリパスが長い場合にはビルドが失敗する可能性があります。

                     <amazon-freertos>ディレクトリへのパスは 98文字未満になるようにしてください。

               

               2. <amazon-freertos>/projects/cypressfolder へ移動してください。

               

               3. サンプルコードをサブモジュールと合わせてクローンしてください。

                   git clone <repo-url> --recurse-submodules

                   例えば、afr-example-capsense をクローンする場合には下記のコマンドを実行します。

                   git clone https://github.com/cypresssemiconductorco/afr-example-capsense.git --recurse-submodules

               

               4. キットを添付の USB ケーブルを使用して USB コネクタからお使いの PC に接続してください。

               

               5. ターミナルプログラムを起動して、KitPro3 の COMポートを選択します。

                   シリアル通信の設定をボーレート 115200 の 8N1 (8bit、 パリティなし、ストップビット1) に設定してください。

               

              Amazon FreeRTOS の設定

               

               1. 始める前に、ご使用のデバイスを AWS クラウドに接続する為に AWS IoT の設定を行う必要があります。

               

                AWS IoT 接続の設定方法についてはFirst Steps” section of the Amazon FreeRTOS user guide をご参照ください。

                Cypress のキットと使用するためには、Amazon FreeRTOS は Cypress の GitHub repository からのヴァージョンを使用する必要がありますので

                Amazon FreeRTOS user guide に記載されている他の場所からダウンロードする方法は無視してください。

                一部のサンプルコードは AWS IoT との接続を必要としない場合があります。その場合、このステップは省略していただけます。

                サンプルコードが AWS IoT の設定を必要とするかについては、そのサンプルコード付属の README.md を読んでご判断ください。

               

               2. AWS IoT の設定が終了したら、Amazon FreeRTOS を設定する必要があります。

                厳密なコンフィグレーションはサンプルコード毎に異なる場合があります。

                サンプルコード付属の README.md をご参照ください。通常、以下の設定が必要になります。

                これらのファイルは <amazon-freertos>/demos/include ディレクトリの下に置かれています。

               

                 ・Wi-Fi 設定 (SSID, パスワード) と aws_clientcredential.h 内の MQTT endpoint

                 ・aws_clientcredential_keys.h 内の Client certificate と private key

               

              サンプルコードの実行

               

              ModusToolbox IDE を使用する場合

               

               1. ModusToolbox IDE を起動して、workspace を選択するか作成してください。

               2. メニューから File > Import を選択します。

               3. 表示されるウィンドウで、General フォルダを展開して、 Existing Projects into Workspace を選択し、Next をクリックする。

               001-pastedImage_30.png

               4. Import Projects のウィンドウの Select root directory の欄で、

                右側にある Browse をクリックして <amazon-freertos>/projects/cypress/<code_example_directory> を選択します。

                デフォルトでは <code_example> プロジェクトが選択されているはずです。

                Finish をクリックしてプロジェクトをワークスペースにインポートしてください。

               002-pastedImage_31.png

               5. Project Explorer 内の当該プロジェクトをクリックします。

                これで Quick Panel 内に build と program のアクションが表示されます。

               6. Quick Panel 内で、<code_example> Program (KitProg3) をクリックします。

                これでプロジェクトがビルドされ、キットにプログラムされます。

               7. サンプルコード付属の README.md の指示にしたがって実行結果を検分してください。

                サンプルコードが UART出力をサポートしている場合、シリアルターミナルを接続する必要があります。

               

              ModusToolbox IDE で異なるターゲットを使用する

               

              ターゲットボードはサンプルコードの Makefile 内の変数 TARGET で設定されています。

              IDE で異なるターゲットを使用する場合には下記の手順に従ってください:

               

              1. <amazon-freertos/projects/cypress/<code_example_directory>/.mtbLaunchConfigs ディレクトリ下のすべてのラウンチコンフィグレーションファイル (*.launch) を削除してください。

              2. Makefile 内の TARGET 変数を新しいターゲットに変更してください。例えば CY8CKIT-062-WIFI-BT。

                注意:Makefile 内のターゲット名はセパレータにアンダースコアの代わりにハイフォンを使用します。

              3. IDE の Project Explorer 内でサンプルコードを右クリックして Build Targets > Create を選択してください。

              4. 表示されるウィンドウ内で、Target Nameeclipse を入力して、OK をクリックします。

               003-pastedImage_36.png

                下記のように、プロジェクトの下に Build Targets が現れます。

               004-pastedImage_37.png

              5. Build Targets の下の eclipse をダブルクリックして新しいターゲット用のラウンチコンフィグレーションファイルが生成されるまで待ちます。進行状況は ビルドコンソールウィンドウ内に表示されます。

              6. 新しいターゲットへの書込みには、Project Explorer 内のプロジェクトをクリックして、Quick Panel から <code_example> Program (KitProg3) を選択してください。

               

               

              コマンドラインインターフェース (CLI) を使用する

               

              ModusToolbox コマンドラインインターフェース (CLI) は アプリケーションビルドを実行するための GNU make をベースとしたビルドシステムです。

              本節では CLI を使用してサンプルコードを実行する方法を説明します。詳細については Running ModusToolbox from the Command Lineをご参照ください。

              ModusToolbox IDE も同じビルドシステムを使用しています。そのため、CLI と IDE 間の切り替えは完全にサポートされています。

               

               1. CLI ターミナルを起動して、CE ディレクトリに移動してください。

               2. make  program コマンドを実行するとデフォルトツールチェーンを使用してプログラムをビルドし、デフォルトのターゲットに書込みを行います。

                ターゲットとツールチェーンは手動で指定可能です:

                   make program TARGET=<BSP> TOOLCHAIN=<toolchain>

                    例: make program TARGET=CY8CKIT-062-WIFI-BT TOOLCHAIN=GCC_ARM

                   注意:make コマンド中のターゲット名はセパレータにハイフォンを使用します。

               3. サンプルコード付属の README.md の指示にしたがって実行結果検分してください

                サンプルコードが UART出力をサポートしている場合、シリアルターミナルを接続する必要があります。

               

              CMake を使用する

               

              1. <amazon-freertos> ディレクトリの下にビルドフォルダを作成してください。例えば, <amazon-freertos>/build/cmake_build。

              2. ビルドフォルダか下記のコマンドを実行してください。ボード名とサンプルコード名はお使いのボードと実行したいサンプルコード名に置き換えてください。

              cmake -G Ninja -S ../.. -B . -DVENDOR=cypress -DCOMPILER=arm-gcc -DBOARD=CY8CPROTO_062_4343W -DAPP=projects/cypress/afr-example-wifi-scan

              注意:

                 ・ cmake コマンド内で使用するボード名はセパレータにアンダースコアを使用します。

                 ・上記のコマンドはビルドツール Ninja 用のコンフィグレーションを生成します。

                  “Unix Makefiles”のように CMake でサポートされている他のビルドツール用のものも生成することが可能です。

              3. CMake がコンフィグレーションを生成した後は、以下のコマンドを実行してください

              cmake --build .

              注意: 現在のディレクトリの指定はドット ( . ) を使用しています。

              4. <amazon-freertos>/build/cmake_build ディレクトリ下に生成された *.elf をターゲットに書込むのには Cypress Programmer を使用してください。

              5. サンプルコード付属の README.md の指示にしたがって実行結果を検分してください

                サンプルコードが UART出力をサポートしている場合、シリアルターミナルを接続する必要があります。

              ========================

               

              20-Apr-2020

              moto

               

              > some format changed with indentation

              > 「コマンドど」changed to 「コマンド」

              • 4. Re: Community Translation - Running Amazon FreeRTOS Code Examples - KBA228845
                JuyoungJ_06

                Dear, Tanaka-san

                 

                I will request to change the content as your last updates.

                 

                Thanks for modification.

                 

                Regrads,

                Jenna