AWS IoT Over-the-air Update  v2.0.0 (Release Candidate)
Client library for AWS IoT OTA
OtaAgentContext Struct Reference

The OTA agent is a singleton today. The structure keeps it nice and organized. More...

#include <ota.h>

Data Fields

OtaState_t state
uint8_t pThingName [otaconfigMAX_THINGNAME_LEN+1U]
OtaFileContext_t fileContext
uint32_t fileIndex
uint32_t serverFileID
uint8_t pActiveJobName [OTA_JOB_ID_MAX_SIZE]
uint8_t * pClientTokenFromJob
uint32_t timestampFromJob
OtaImageState_t imageState
uint32_t numOfBlocksToReceive
OtaAgentStatistics_t statistics
uint32_t requestMomentum
OtaInterfaces_t * pOtaInterface
OtaAppCallback_t OtaAppCallback
OtaCustomJobCallback_t customJobCallback

Detailed Description

The OTA agent is a singleton today. The structure keeps it nice and organized.

Field Documentation

◆ state

OtaState_t OtaAgentContext::state

State of the OTA agent.

◆ pThingName

uint8_t OtaAgentContext::pThingName[otaconfigMAX_THINGNAME_LEN+1U]

Thing name + zero terminator.

◆ fileContext

OtaFileContext_t OtaAgentContext::fileContext

Static array of OTA file structures.

◆ fileIndex

uint32_t OtaAgentContext::fileIndex

Index of current file in the array.

◆ serverFileID

uint32_t OtaAgentContext::serverFileID

Variable to store current file ID passed down

◆ pActiveJobName

uint8_t OtaAgentContext::pActiveJobName[OTA_JOB_ID_MAX_SIZE]

The currently active job name. We only allow one at a time.

◆ pClientTokenFromJob

uint8_t* OtaAgentContext::pClientTokenFromJob

The clientToken field from the latest update job.

◆ timestampFromJob

uint32_t OtaAgentContext::timestampFromJob

Timestamp received from the latest job document.

◆ imageState

OtaImageState_t OtaAgentContext::imageState

The current application image state.

◆ numOfBlocksToReceive

uint32_t OtaAgentContext::numOfBlocksToReceive

Number of data blocks to receive per data request.

◆ statistics

OtaAgentStatistics_t OtaAgentContext::statistics

The OTA agent statistics block.

◆ requestMomentum

uint32_t OtaAgentContext::requestMomentum

The number of requests sent before a response was received.

◆ pOtaInterface

OtaInterfaces_t* OtaAgentContext::pOtaInterface

Collection of all interfaces used by the agent.

◆ OtaAppCallback

OtaAppCallback_t OtaAgentContext::OtaAppCallback

OTA App callback.

◆ customJobCallback

OtaCustomJobCallback_t OtaAgentContext::customJobCallback

Custom job callback.

The documentation for this struct was generated from the following file: