EFUpdate Class Reference

#include <EFUpdate.h>

Collaboration diagram for EFUpdate:

Classes
union	efuheader_t
union	efurecord_t

Public Member Functions
	EFUpdate ()
virtual	~EFUpdate ()
void	begin ()
bool	process (uint8_t *data, uint32_t len)
bool	hasError ()
uint8_t	getError (String &msg)
bool	end ()
void	GetDriverName (String &name)
bool	UpdateIsInProgress ()

Public Attributes
const uint32_t	EFU_ID = 0x00554645

Private Types
enum class	RecordType : uint16_t { NULL_RECORD , SKETCH_IMAGE , FS_IMAGE , EEPROM_IMAGE }
enum class	State : uint8_t {   HEADER , RECORD , DATA , FAIL ,   IDLE }

Private Member Functions
void	ConvertErrorToString ()

Private Attributes
State	_state = State::IDLE
uint32_t	_loc = 0
efuheader_t	_header
efurecord_t	_record
uint32_t	_maxSketchSpace = 0
uint8_t	_error = EFUPDATE_ERROR_OK
String	_errorMsg

Member Enumeration Documentation

RecordType

enum class EFUpdate::RecordType : uint16_t

strongprivate

Enumerator
NULL_RECORD
SKETCH_IMAGE
FS_IMAGE
EEPROM_IMAGE

State

enum class EFUpdate::State : uint8_t

strongprivate

Enumerator
HEADER
RECORD
DATA
FAIL
IDLE

Constructor & Destructor Documentation

EFUpdate()

EFUpdate::EFUpdate ( )

inline

~EFUpdate()

virtual EFUpdate::~EFUpdate ( )

inlinevirtual

Member Function Documentation

begin()

void EFUpdate::begin

(

)

Here is the caller graph for this function:

ConvertErrorToString()

void EFUpdate::ConvertErrorToString ( )

private

Here is the caller graph for this function:

end()

bool EFUpdate::end

(

)

Here is the caller graph for this function:

GetDriverName()

void EFUpdate::GetDriverName ( String & name )

inline

getError()

uint8_t EFUpdate::getError

(

String &

msg

)

Here is the caller graph for this function:

hasError()

bool EFUpdate::hasError

(

)

Here is the caller graph for this function:

process()

bool EFUpdate::process	(	uint8_t *	data,
		uint32_t	len )

DEBUG_V ("PASS");

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateIsInProgress()

bool EFUpdate::UpdateIsInProgress ( )

inline

Here is the caller graph for this function:

Member Data Documentation

_error

uint8_t EFUpdate::_error = EFUPDATE_ERROR_OK

private

_errorMsg

String EFUpdate::_errorMsg

private

_header

efuheader_t EFUpdate::_header

private

_loc

uint32_t EFUpdate::_loc = 0

private

_maxSketchSpace

uint32_t EFUpdate::_maxSketchSpace = 0

private

_record

efurecord_t EFUpdate::_record

private

_state

State EFUpdate::_state = State::IDLE

private

EFU_ID

const uint32_t EFUpdate::EFU_ID = 0x00554645

---

The documentation for this class was generated from the following files:

• /github/workspace/include/EFUpdate.h
• /github/workspace/src/EFUpdate.cpp