OTA_Firmware_Update.h File Reference

#include "Attribute_Request.h"
#include "Shared_Attribute_Update.h"
#include "OTA_Handler.h"
#include "IAPI_Implementation.h"

Include dependency graph for OTA_Firmware_Update.h:

Go to the source code of this file.

Classes
class	OTA_Firmware_Update< Logger >
	Handles the internal implementation of the ThingsBoard over the air firmware update API. See https://thingsboard.io/docs/user-guide/ota-updates/ for more information. More...

Variables
uint8_t constexpr	MAX_FW_TOPIC_SIZE = 33U
uint8_t constexpr	OTA_ATTRIBUTE_KEYS_AMOUNT = 5U
char constexpr	NO_FW_REQUEST_RESPONSE [] = "Did not receive requested shared attribute firmware keys. Ensure keys exist and device is connected"
char constexpr	FIRMWARE_RESPONSE_TOPIC [] = "v2/fw/response/%u/chunk/"
char constexpr	FIRMWARE_REQUEST_TOPIC [] = "v2/fw/request/%u/chunk/%u"
char constexpr	CURR_FW_TITLE_KEY [] = "current_fw_title"
char constexpr	CURR_FW_VER_KEY [] = "current_fw_version"
char constexpr	FW_ERROR_KEY [] = "fw_error"
char constexpr	FW_STATE_KEY [] = "fw_state"
char constexpr	FW_VER_KEY [] = "fw_version"
char constexpr	FW_TITLE_KEY [] = "fw_title"
char constexpr	FW_CHKS_KEY [] = "fw_checksum"
char constexpr	FW_CHKS_ALGO_KEY [] = "fw_checksum_algorithm"
char constexpr	FW_SIZE_KEY [] = "fw_size"
char constexpr	CHECKSUM_AGORITM_MD5 [] = "MD5"
char constexpr	CHECKSUM_AGORITM_SHA256 [] = "SHA256"
char constexpr	CHECKSUM_AGORITM_SHA384 [] = "SHA384"
char constexpr	CHECKSUM_AGORITM_SHA512 [] = "SHA512"
char constexpr	NUMBER_PRINTF [] = "%u"
char constexpr	NO_FW [] = "Missing shared attribute firmware keys. Ensure you assigned an OTA update with binary"
char constexpr	EMPTY_FW [] = "Received shared attribute firmware keys were NULL"
char constexpr	FW_NOT_FOR_US [] = "Received firmware title (%s) is different and not meant for this device (%s)"
char constexpr	FW_CHKS_ALGO_NOT_SUPPORTED [] = "Received checksum algorithm (%s) is not supported"
char constexpr	NOT_ENOUGH_RAM [] = "Temporary allocating more internal client buffer failed, decrease OTA chunk size or decrease overall heap usage"
char constexpr	RESETTING_FAILED [] = "Preparing for OTA firmware updates failed, attributes might be NULL"

Variable Documentation

CHECKSUM_AGORITM_MD5

char constexpr CHECKSUM_AGORITM_MD5[] = "MD5"

constexpr

CHECKSUM_AGORITM_SHA256

char constexpr CHECKSUM_AGORITM_SHA256[] = "SHA256"

constexpr

CHECKSUM_AGORITM_SHA384

char constexpr CHECKSUM_AGORITM_SHA384[] = "SHA384"

constexpr

CHECKSUM_AGORITM_SHA512

char constexpr CHECKSUM_AGORITM_SHA512[] = "SHA512"

constexpr

CURR_FW_TITLE_KEY

char constexpr CURR_FW_TITLE_KEY[] = "current_fw_title"

constexpr

CURR_FW_VER_KEY

char constexpr CURR_FW_VER_KEY[] = "current_fw_version"

constexpr

EMPTY_FW

char constexpr EMPTY_FW[] = "Received shared attribute firmware keys were NULL"

constexpr

FIRMWARE_REQUEST_TOPIC

char constexpr FIRMWARE_REQUEST_TOPIC[] = "v2/fw/request/%u/chunk/%u"

constexpr

FIRMWARE_RESPONSE_TOPIC

char constexpr FIRMWARE_RESPONSE_TOPIC[] = "v2/fw/response/%u/chunk/"

constexpr

FW_CHKS_ALGO_KEY

char constexpr FW_CHKS_ALGO_KEY[] = "fw_checksum_algorithm"

constexpr

FW_CHKS_ALGO_NOT_SUPPORTED

char constexpr FW_CHKS_ALGO_NOT_SUPPORTED[] = "Received checksum algorithm (%s) is not supported"

constexpr

FW_CHKS_KEY

char constexpr FW_CHKS_KEY[] = "fw_checksum"

constexpr

FW_ERROR_KEY

char constexpr FW_ERROR_KEY[] = "fw_error"

constexpr

FW_NOT_FOR_US

char constexpr FW_NOT_FOR_US[] = "Received firmware title (%s) is different and not meant for this device (%s)"

constexpr

FW_SIZE_KEY

char constexpr FW_SIZE_KEY[] = "fw_size"

constexpr

FW_STATE_KEY

char constexpr FW_STATE_KEY[] = "fw_state"

constexpr

FW_TITLE_KEY

char constexpr FW_TITLE_KEY[] = "fw_title"

constexpr

FW_VER_KEY

char constexpr FW_VER_KEY[] = "fw_version"

constexpr

MAX_FW_TOPIC_SIZE

uint8_t constexpr MAX_FW_TOPIC_SIZE = 33U

constexpr

NO_FW

char constexpr NO_FW[] = "Missing shared attribute firmware keys. Ensure you assigned an OTA update with binary"

constexpr

NO_FW_REQUEST_RESPONSE

char constexpr NO_FW_REQUEST_RESPONSE[] = "Did not receive requested shared attribute firmware keys. Ensure keys exist and device is connected"

constexpr

NOT_ENOUGH_RAM

char constexpr NOT_ENOUGH_RAM[] = "Temporary allocating more internal client buffer failed, decrease OTA chunk size or decrease overall heap usage"

constexpr

NUMBER_PRINTF

char constexpr NUMBER_PRINTF[] = "%u"

constexpr

OTA_ATTRIBUTE_KEYS_AMOUNT

uint8_t constexpr OTA_ATTRIBUTE_KEYS_AMOUNT = 5U

constexpr

RESETTING_FAILED

char constexpr RESETTING_FAILED[] = "Preparing for OTA firmware updates failed, attributes might be NULL"

constexpr