翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
OTA PAL 移植のバージョン 1 からバージョン 3 への移行
無線通信経由の更新ライブラリによって、フォルダ構造に加え、ライブラリとデモアプリケーションに必要な設定の配置にいくつかの変更が加えられました。v1.2.0 と連携するよう設計された OTA アプリケーションをライブラリの v3.0.0 に移行させるには、この移行ガイドに従って、PAL 移植機能の署名を更新し、複数の設定ファイルを追加する必要があります。
OTA PAL への変更
-
OTA PAL 移植のディレクトリ名は、
otaからota_pal_for_awsに更新されました。このフォルダには、ota_pal.cとota_pal.hの 2 つのファイルが含まれている必要があります。PAL のヘッダーファイルlibraries/freertos_plus/aws/ota/src/aws_iot_ota_pal.hは OTA ライブラリから削除されているため、ポート内で定義する必要があります。 -
リターンコード (
OTA_Err_t) は、列挙型OTAMainStatus_tに変換されます。変換後のリターンコードについては、ota_platform_interface.hを参照してください。また、ヘルパーマクロ も用意されているので、 OtaPalMainStatusとOtaPalSubStatusのコードをマージしたり、OtaMainStatusをOtaPalStatusなどから抽出したりする際に活用できます。 -
PAL でのログ記録
-
DEFINE_OTA_METHOD_NAMEマクロを削除。 -
以前:
OTA_LOG_L1( "[%s] Receive file created.\r\n", OTA_METHOD_NAME ); -
更新後:
LogInfo(( "Receive file created."));(目的のログを取得する際は、LogDebug、LogWarn、LogErrorを使用すること)
-
-
変数
cOTA_JSON_FileSignatureKeyをOTA_JsonFileSignatureKeyに変更。
関数
関数の署名は ota_pal.h で定義され、プレフィックスは prvPAL ではなく otaPal を使用します。
注記
PAL の正確な名前は、技術的には自由に設定できますが、資格認定テストに対応させるためには、以下に示す名前と一致させる必要があります。
|
バージョン 1 |
バージョン 3 |
メモ |
|---|---|---|
|
|
|
まとまった受信データを格納する新しい受信ファイルを作成します。 |
|
|
|
指定されたファイルに、指定されたオフセットでデータのブロックを書き込みます。 |
|
|
|
OTA 経由で受信した最新の MCU イメージをアクティブ化します。 |
|
|
|
デバイスをリセットします。 |
|
|
|
指定された OTA コンテキストの基盤となっている受信ファイルを認証し、閉じます。 |
|
|
|
OTA 転送を停止します。 |
|
|
|
OTA 更新イメージの状態の設定を実施します。 |
|
|
|
OTA 更新イメージの状態を取得します。 |
-
バージョン 1:
OTA_Err_t prvPAL_CreateFileForRx( OTA_FileContext_t * const *C* );バージョン 3:
OtaPalStatus_t otaPal_CreateFileForRx( OtaFileContext_t * const *pFileContext* );注: まとまった受信データを格納する新しい受信ファイルを作成します。
-
バージョン 1:
int16_t prvPAL_WriteBlock( OTA_FileContext_t * const C, uint32_t ulOffset, uint8_t * const pcData, uint32_t ulBlockSize );バージョン 3:
int16_t otaPal_WriteBlock( OtaFileContext_t * const pFileContext, uint32_t ulOffset, uint8_t * const pData, uint32_t ulBlockSize );注: 指定されたファイルに、指定されたオフセットでデータブロックを書き込みます。
-
バージョン 1:
OTA_Err_t prvPAL_ActivateNewImage( void );バージョン 3:
OtaPalStatus_t otaPal_ActivateNewImage( OtaFileContext_t * const *pFileContext* );注: OTA 経由で受信した最新の MCU イメージをアクティブ化します。
-
バージョン 1:
OTA_Err_t prvPAL_ResetDevice( void );バージョン 3:
OtaPalStatus_t otaPal_ResetDevice( OtaFileContext_t * const *pFileContext* );注: デバイスをリセットします。
-
バージョン 1:
OTA_Err_t prvPAL_CloseFile( OTA_FileContext_t * const *C* );バージョン 3:
OtaPalStatus_t otaPal_CloseFile( OtaFileContext_t * const *pFileContext* );注: 指定された OTA コンテキストの基盤となっている受信ファイルを認証し、閉じます。
-
バージョン 1:
OTA_Err_t prvPAL_Abort( OTA_FileContext_t * const *C* );バージョン 3:
OtaPalStatus_t otaPal_Abort( OtaFileContext_t * const *pFileContext* );注: OTA 転送を停止します。
-
バージョン 1:
OTA_Err_t prvPAL_SetPlatformImageState( OTA_ImageState_t *eState* );バージョン 3:
OtaPalStatus_t otaPal_SetPlatformImageState( OtaFileContext_t * const pFileContext, OtaImageState_t eState );注: OTA 更新イメージの状態の設定を実施します。
-
バージョン 1:
OTA_PAL_ImageState_t prvPAL_GetPlatformImageState( void );バージョン 3:
OtaPalImageState_t otaPal_GetPlatformImageState( OtaFileContext_t * const *pFileContext* );注: OTA 更新イメージの状態を取得します。
データ型
|
バージョン 1 |
File |
バージョン 3 |
File |
メモ |
|---|---|---|---|---|
|
|
|
|
|
プラットフォームの実装によって設定されたイメージの状態。 |
|
|
|
|
|
v1: 符号のない 32 個の整数を定義するマクロ。 v3: エラーの種類を表す特殊な列挙型であり、エラーコードに関連付けられた型。 |
|
|
|
|
|
v1: データの列挙型とバッファを含む。 v3: 追加のデータ長変数を含む。 |
|
|
|
|
|
OTA イメージの状態 |
-
バージョン 1:
OTA_PAL_ImageState_tファイル:
aws_iot_ota_agent.hバージョン 3:
OtaPalImageState_tファイル:
ota_private.h注: プラットフォームの実装によって設定されたイメージの状態。
-
バージョン 1:
OTA_Err_tファイル:
aws_iot_ota_agent.hバージョン 3:
OtaErr_t OtaPalStatus_t (combination of OtaPalMainStatus_t and OtaPalSubStatus_t)ファイル:
ota.h、ota_platform_interface.h注: v1: 符号のない 32 個の整数を定義するマクロ。v3: エラーの種類を表す特殊な列挙型であり、エラーコードに関連付けられた型。
-
バージョン 1:
OTA_FileContext_tファイル:
aws_iot_ota_agent.hバージョン 3:
OtaFileContext_tファイル:
ota_private.h注: v1: データの列挙型とバッファを含む。v3: 追加のデータ長変数を含む。
-
バージョン 1:
OTA_ImageState_tファイル:
aws_iot_ota_agent.hバージョン 3:
OtaImageState_tファイル:
ota_private.h注: OTA イメージの状態
設定変更
ファイル aws_ota_agent_config.h の名前が ota_config.h_AWS_OTA_AGENT_CONFIG_H_ から OTA_CONFIG_H_ に変更されます。
-
ファイル
aws_ota_codesigner_certificate.hは、削除されました。 -
デバッグメッセージを印刷するための新しいログ記録スタックが追加されました。
/**************************************************/ /******* DO NOT CHANGE the following order ********/ /**************************************************/ /* Logging related header files are required to be included in the following order: * 1. Include the header file "logging_levels.h". * 2. Define LIBRARY_LOG_NAME and LIBRARY_LOG_LEVEL. * 3. Include the header file "logging_stack.h". */ /* Include header that defines log levels. */ #include "logging_levels.h" /* Configure name and log level for the OTA library. */ #ifndef LIBRARY_LOG_NAME #define LIBRARY_LOG_NAME "OTA" #endif #ifndef LIBRARY_LOG_LEVEL #define LIBRARY_LOG_LEVEL LOG_INFO #endif #include "logging_stack.h" /************ End of logging configuration ****************/ -
定数設定が追加されました。
/** * @brief Size of the file data block message (excluding the header). */ #define otaconfigFILE_BLOCK_SIZE ( 1UL << otaconfigLOG2_FILE_BLOCK_SIZE )
新規ファイル: ota_demo_config.h
-
demos/include/aws_ota_codesigner_certificate.hで定義されたsigningcredentialSIGNING_CERTIFICATE_PEMは、otapalconfigCODE_SIGNING_CERTIFICATEとしてota_demo_config.hに移動しました。なお、次のように指定すると PAL ファイルからアクセスできます。static const char codeSigningCertificatePEM[] = otapalconfigCODE_SIGNING_CERTIFICATE;ファイル
aws_ota_codesigner_certificate.hは、削除されました。 -
APP_VERSION_BUILD、APP_VERSION_MINOR、APP_VERSION_MAJORのマクロがota_demo_config.hに追加されました。バージョン情報を含むtests/include/aws_application_version.h、libraries/c_sdk/standard/common/include/iot_appversion32.h、demos/demo_runner/aws_demo_version.cなどの古いファイルは、削除されました。
OTA PAL テストの変更点
-
「Full_OTA_AGENT」テストグループとそのすべての関連ファイルを削除しました。従来、このテストグループは資格に必要でした。これらのテストは OTA ライブラリ用であり、OTA PAL 移植に特有のものではありません。現在の OTA ライブラリは、OTA リポジトリでホストされるテストをすべて網羅しているため、このテストグループは不要となりました。
-
「Full_OTA_CBOR」と「Quarantine_OTA_CBOR」テストグループを削除し、そのすべての関連ファイルも削除しました。これらのテストは、資格認定テストに含まれていませんでした。削除されたテストの対象だった機能については、OTA リポジトリでテストされています。
-
テストファイルをライブラリディレクトリから
tests/integration_tests/ota_palディレクトリに移動させました。 -
OTA ライブラリ API の v3.0.0 を使用するよう、OTA PAL 資格認定テストを更新しました。
-
OTA PAL テストが、テスト用のコード署名の証明書にアクセスする方法を更新しました。以前は、コード署名の認証情報専用のヘッダーファイルが存在しましたが、新しいバージョンのライブラリは、その点が変更されています。テストコードでは、この変数が
ota_pal.cで定義されることを想定しています。その値は、プラットフォーム固有の OTA 設定ファイルで定義されたマクロに割り当てられます。
チェックリスト
このチェックリストを使用して、移行に必要な手順を実行していることを確認します。
-
OTA PAL 移植フォルダの名前を
otaからota_pal_for_awsに更新します。 -
上記の機能を含んだファイル
ota_pal.hを追加します。ota_pal.hファイルの例については、GitHubを参照してください。 -
設定ファイルを追加します。
-
ファイル名を
aws_ota_agent_config.hからota_config.hに変更するか、新しく という名前のファイルを作成します。-
追加:
otaconfigFILE_BLOCK_SIZE ( 1UL << otaconfigLOG2_FILE_BLOCK_SIZE ) -
インクルード:
#include "ota_demo_config.h"
-
-
上記のファイルを
aws_test configフォルダにコピーし、ota_demo_config.hに含まれているものをすべてaws_test_ota_config.hに置き換えます。 -
ota_demo_config.hファイルを追加します。 -
aws_test_ota_config.hファイルを追加します。
-
-
ota_pal.cに以下の変更を加えます。-
インクルードを最新の OTA ライブラリファイル名に更新します。
-
DEFINE_OTA_METHOD_NAMEマクロを削除します。 -
OTA PAL 関数の署名を更新します。
-
ファイルコンテキスト変数の名前を
CからpFileContextに更新します。 -
OTA_FileContext_t構造体とそれに関連するすべての変数を更新します。 -
cOTA_JSON_FileSignatureKeyをOTA_JsonFileSignatureKeyに更新します。 -
OTA_PAL_ImageState_tとOta_ImageState_tのタイプを更新します。 -
エラータイプとエラー値を更新します。
-
印刷マクロを更新し、ログ記録スタックを使用するようにします。
-
otapalconfigCODE_SIGNING_CERTIFICATEになるようsigningcredentialSIGNING_CERTIFICATE_PEMを更新します。 -
otaPal_CheckFileSignatureとotaPal_ReadAndAssumeCertificateの関数のコメントを更新します。
-
-
CMakeLists.txtファイルを更新します。 -
IDE プロジェクトを更新します。
