为 OTA 应用程序从版本 1 迁移到版本 3

OTA_State_t OTA_AgentShutdown( TickType_t xTicksToWait );

OtaState_t OTA_Shutdown( uint32_t ticksToWait,
                         uint8_t unsubscribeFlag ); 

等待 OTA 代理完成关闭过程的刻度数量。如果将其设置为零，该函数将立即返回，无需等待。实际状态将返回给调用方。代理暂时不会进入睡眠状态，而会用于繁忙的循环。

unsubscribeFlag -

用于指示在调用关闭时是否应从作业主题执行取消订阅操作的标记。如果该标记为 0，则不会为作业主题调用取消订阅操作。如果应用程序必须取消订阅作业主题，则在调用 OTA_Shutdown 时必须将此标记设置为 1。

OtaState_t -

重命名了 OTA 代理状态的枚举及其成员。请参阅 Amazon IoT 空中下载更新 v3.0.0。

OTA_State_t OTA_GetAgentState( void );

OtaState_t OTA_GetState( void );

OtaState_t -

重命名了 OTA 代理状态的枚举及其成员。请参阅 Amazon IoT 空中下载更新 v3.0.0。

uint32_t OTA_GetPacketsReceived( void );
uint32_t OTA_GetPacketsQueued( void );
uint32_t OTA_GetPacketsProcessed( void );
uint32_t OTA_GetPacketsDropped( void ); 

OtaErr_t OTA_GetStatistics( OtaAgentStatistics_t * pStatistics );

统计数据的输入/输出参数，例如，为当前作业接收、丢弃、排队和处理的数据包。

OTA 错误代码。

OtaAgentStatistics_t otaStatistics = { 0 };
OTA_GetStatistics( &otaStatistics );
LogInfo( ( " Received: %u   Queued: %u   Processed: %u   Dropped: %u",
                           otaStatistics.otaPacketsReceived,
                           otaStatistics.otaPacketsQueued,
                           otaStatistics.otaPacketsProcessed,
                           otaStatistics.otaPacketsDropped ) ); 

OTA_Err_t OTA_ActivateNewImage( void ); 

OtaErr_t OTA_ActivateNewImage( void );

更改了返回的 OTA 错误代码枚举，并添加了新的错误代码。请参阅 Amazon IoT空中下载更新 v3.0.0：OtaErr_t。

 OtaErr_t otaErr = OtaErrNone;
 otaErr = OTA_ActivateNewImage();
 /* Handle error */ 

OTA_Err_t OTA_SetImageState( OTA_ImageState_t eState ); 

OtaErr_t OTA_SetImageState( OtaImageState_t state ); 

输入参数已重命名为 OtaImageState_t。请参阅 Amazon IoT 空中下载更新 v3.0.0。

更改了返回的 OTA 错误代码枚举，并添加了新的错误代码。请参阅 Amazon IoT 空中下载更新 v3.0.0 / OtaErr_t。

  OtaErr_t otaErr = OtaErrNone;
  otaErr = OTA_SetImageState( OtaImageStateAccepted );
  /* Handle error */ 

OTA_ImageState_t OTA_GetImageState( void ); 

OtaImageState_t OTA_GetImageState( void ); 

返回枚举已重命名为 OtaImageState_t。请参阅 Amazon IoT 空中下载更新 v3.0.0：OtaImageState_t。

 OtaImageState_t imageState;
 imageState = OTA_GetImageState(); 

OTA_Err_t OTA_Suspend( void ); 

OtaErr_t OTA_Suspend( void ); 

更改了返回的 OTA 错误代码枚举，并添加了新的错误代码。请参阅 Amazon IoT空中下载更新 v3.0.0：OtaErr_t。

OtaErr_t xOtaError = OtaErrUninitialized;
xOtaError = OTA_Suspend();
/* Handle error */ 

OTA_Err_t OTA_Resume( void * pxConnection ); 

OtaErr_t OTA_Resume( void ); 

更改了返回的 OTA 错误代码枚举，并添加了新的错误代码。请参阅 Amazon IoT空中下载更新 v3.0.0：OtaErr_t。

OtaErr_t xOtaError = OtaErrUninitialized;
xOtaError = OTA_Resume();
/* Handle error */ 

OTA_Err_t OTA_CheckForUpdate( void ); 

OtaErr_t OTA_CheckForUpdate( void ) 

更改了返回的 OTA 错误代码枚举，并添加了新的错误代码。请参阅 Amazon IoT空中下载更新 v3.0.0：OtaErr_t。

void OTA_EventProcessingTask( void * pUnused ); 

/* Create FreeRTOS task*/
xTaskCreate( prvOTAAgentTask,
             "OTA Agent Task",
             otaexampleAGENT_TASK_STACK_SIZE,
             NULL,
             otaexampleAGENT_TASK_PRIORITY,
             NULL );
   
/* Call OTA_EventProcessingTask from the task */                        
static void prvOTAAgentTask( void * pParam )
{
    /* Calling OTA agent task. */
    OTA_EventProcessingTask( pParam );
    LogInfo( ( "OTA Agent stopped." ) );

    /* Delete the task as it is no longer required. */
    vTaskDelete( NULL );
} 

/* Create posix thread.*/
if( pthread_create( &threadHandle, NULL, otaThread, NULL ) != 0 )
{
    LogError( ( "Failed to create OTA thread: "
                ",errno=%s",
                strerror( errno ) ) );

   /* Handle error. */
}
   
/* Call OTA_EventProcessingTask from the thread.*/                        
static void * otaThread( void * pParam )
{
    /* Calling OTA agent task. */
    OTA_EventProcessingTask( pParam );
    LogInfo( ( "OTA Agent stopped." ) );
    
    return NULL;
} 

bool OTA_SignalEvent( const OtaEventMsg_t * const pEventMsg ); 

OtaEventMsg_t xEventMsg = { 0 };
xEventMsg.eventId = OtaAgentEventStart;
( void ) OTA_SignalEvent( &xEventMsg );