OTA_Init

OTA Agent initialization function.

OtaErr_t OTA_Init( OtaAppBuffer_t * pOtaBuffer,
                   const OtaInterfaces_t * pOtaInterfaces,
                   const uint8_t * pThingName,
                   OtaAppCallback_t OtaAppCallback );

Initialize the OTA engine by starting the OTA Agent ("OTA Task") in the system. This function must be called with the connection client context before calling OTA_CheckForUpdate. Only one OTA Agent may exist.

Parameters

[in]	pOtaBuffer	Buffers used by the agent to store different params.
[in]	pOtaInterfaces	A pointer to the OS context.
[in]	pThingName	A pointer to a C string holding the Thing name.
[in]	OtaAppCallback	Static callback function for when an OTA job is complete. This function will have input of the state of the OTA image after download and during self-test.

Returns

OtaErr_t The state of the OTA Agent upon return from the OtaState_t enum. If the agent was successfully initialized and ready to operate, the state will be OtaAgentStateReady. Otherwise, it will be one of the other OtaState_t enum values.

Example

// Application callback when the OTA agent has completed the job
// or is in self test mode. For example see [demos](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/ota)
void otaAppCallback( OtaJobEvent_t event,
                     const void * pData );
 
// Optional: User buffer to pass down to the OTA Agent. These
// buffers are assumed to be initialized previously, example:
// uint8_t updateFilePath[ OTA_MAX_FILE_PATH_SIZE ];
OtaAppBuffer_t otaBuffer =
{
    .pUpdateFilePath    = updateFilePath,
    .updateFilePathsize = OTA_MAX_FILE_PATH_SIZE,
    .pCertFilePath      = certFilePath,
    .certFilePathSize   = OTA_MAX_FILE_PATH_SIZE,
    .pDecodeMemory      = decodeMem,
    .decodeMemorySize   = otaconfigFILE_BLOCK_SIZE,
    .pFileBitmap        = bitmap,
    .fileBitmapSize     = OTA_MAX_BLOCK_BITMAP_SIZE,
    .pUrl               = updateUrl,
    .urlSize            = OTA_MAX_URL_SIZE,
    .pAuthScheme        = authScheme,
    .authSchemeSize     = OTA_MAX_AUTH_SCHEME_SIZE
};
 
// OTA interface context required for library interface functions
// The functions set by these interfaces are assumed to be defined
// For more information see [demos](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/ota)
OtaInterfaces_t pOtaInterfaces =
{
    // Initialize OTA library OS Interface.
    .os.event.init = Posix_OtaInitEvent;
    .os.event.send = Posix_OtaSendEvent;
    ...
    // Initialize the OTA library MQTT Interface.
    .mqtt.subscribe = mqttSubscribe;
    .mqtt.publish = mqttPublish;
    .mqtt.unsubscribe = mqttUnsubscribe;
    // Initialize the OTA library HTTP Interface.
    .http.init = httpInit;
    .http.request = httpRequest;
    .http.deinit = httpDeinit;
    // Initialize the OTA library PAL Interface.
    .pal.getPlatformImageState = otaPal_GetPlatformImageState;
    .pal.setPlatformImageState = otaPal_SetPlatformImageState;
}
 
// OTA library error status.
OtaErr_t otaErr = OtaErrNone;
 
// Unique client identifier
char * pClientIdentifier = "uniqueClientID";
 
otaErr = OTA_Init( &otaBuffer,
                   &otaInterfaces,
                   ( const uint8_t * ) pClientIdentifier,
                   otaAppCallback ) ) != OtaErrNone )
         if( otaErr == OtaErrNone )
{
    // Do something with the OTA agent.
}