JSON document model to store the details of parameters expected in the job document. More...

#include <ota_private.h>

Data Fields
void *	contextBase
	More...

uint32_t	contextSize
	More...

const JsonDocParam_t *	pBodyDef
	More...

uint16_t	numModelParams
	More...

uint32_t	paramsReceivedBitmap
	More...

uint32_t	paramsRequiredBitmap
	More...

Detailed Description

JSON document model to store the details of parameters expected in the job document.

The document model is currently limited to 32 parameters per the implementation, although it may be easily expanded to more in the future by simply expanding the parameter bitmap.

The document model is used to control what JSON parameters are expected from a document and where to store the parameters, if desired, in a destination context. We currently only store parameters into an OtaFileContext_t but it could be used for any structure since we don't use a type pointer.

Field Documentation

◆ contextBase

void* JsonDocModel_t::contextBase

The base address of the destination OTA context structure.

◆ contextSize

uint32_t JsonDocModel_t::contextSize

The size, in bytes, of the destination context structure.

◆ pBodyDef

const JsonDocParam_t* JsonDocModel_t::pBodyDef

Pointer to the document model body definition.

◆ numModelParams

uint16_t JsonDocModel_t::numModelParams

The number of entries in the document model (limited to 32).

◆ paramsReceivedBitmap

uint32_t JsonDocModel_t::paramsReceivedBitmap

Bitmap of the parameters received based on the model.

◆ paramsRequiredBitmap

uint32_t JsonDocModel_t::paramsRequiredBitmap

Bitmap of the parameters required from the model.

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

ota_private.h

Data Fields