Skip to content

Commit

Permalink
Add jobs_structs group
Browse files Browse the repository at this point in the history
  • Loading branch information
bradleysmith23 committed Nov 10, 2023
1 parent a02cf26 commit 63f2956
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 13 deletions.
5 changes: 5 additions & 0 deletions docs/doxygen/pages.dox
Original file line number Diff line number Diff line change
Expand Up @@ -145,3 +145,8 @@ These configuration settings are C pre-processor constants they are set using a
@defgroup jobs_constants Constants
@brief Constants defined in the Jobs library
*/

/**
@defgroup jobs_structs Structs
@brief Structs defined in the Jobs Library
*/
27 changes: 14 additions & 13 deletions source/otaJobParser/include/job_parser.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,24 @@
#include <stdint.h>

/**
* @ingroup jobs_structs
* @brief struct containing the fields of an AFR OTA Job Document
*/
typedef struct
{
const char * signature; /**< Code Signing Signature */
size_t signatureLen; /**< Length of signature */
const char * filepath; /**< File path to store OTA Update on device */
size_t filepathLen; /**< Length of filepath */
const char * certfile; /**< Path to Code Signing Certificate on Device */
size_t certfileLen; /**< Length of certfile */
const char * authScheme; /**< Authentication Scheme for HTTP URL ( null for MQTT )*/
size_t authSchemeLen; /**< Length of authScheme */
const char * imageRef; /**< MQTT Stream or HTTP URL */
size_t imageRefLen; /**< Length of imageRef */
uint32_t fileId; /**< File ID */
uint32_t fileSize; /**< Size of the OTA Update */
uint32_t fileType; /**< FIle Type */
const char * signature; /**< @brief Code Signing Signature */
size_t signatureLen; /**< @brief Length of signature */
const char * filepath; /**< @brief File path to store OTA Update on device */
size_t filepathLen; /**< @brief Length of filepath */
const char * certfile; /**< @brief Path to Code Signing Certificate on Device */
size_t certfileLen; /**< @brief Length of certfile */
const char * authScheme; /**< @brief Authentication Scheme for HTTP URL ( null for MQTT )*/
size_t authSchemeLen; /**< @brief Length of authScheme */
const char * imageRef; /**< @brief MQTT Stream or HTTP URL */
size_t imageRefLen; /**< @brief Length of imageRef */
uint32_t fileId; /**< @brief File ID */
uint32_t fileSize; /**< @brief Size of the OTA Update */
uint32_t fileType; /**< @brief FIle Type */
} AfrOtaJobDocumentFields_t;

/**
Expand Down

0 comments on commit 63f2956

Please sign in to comment.