File Update.h

FileList > arduino > libraries > common > Update > Update.h

#include <Arduino.h>
#include <MD5.h>
#include <functional>
#include <uf2ota/uf2ota.h>

Classes

Type	Name
class	UpdateClass

Public Types

Type	Name
enum	UpdateCommand
enum	UpdateError

Public Attributes

Type	Name
UpdateClass	Update

Macros

Type	Name
define	ENCRYPTED_BLOCK_SIZE 16
define	UPDATE_SIZE_UNKNOWN 0xFFFFFFFF
define	UPDATE_TIMEOUT_MS 30 * 1000

Public Types Documentation

enum UpdateCommand

enum UpdateCommand {
    U_FLASH = 0,
    U_SPIFFS = 100,
    U_AUTH = 200
};

enum UpdateError

enum UpdateError {
    UPDATE_ERROR_OK = 0,
    UPDATE_ERROR_WRITE = 1,
    UPDATE_ERROR_ERASE = 2,
    UPDATE_ERROR_READ = 3,
    UPDATE_ERROR_SPACE = 4,
    UPDATE_ERROR_SIZE = 5,
    UPDATE_ERROR_STREAM = 6,
    UPDATE_ERROR_MD5 = 7,
    UPDATE_ERROR_MAGIC_BYTE = 8,
    UPDATE_ERROR_ACTIVATE = 9,
    UPDATE_ERROR_NO_PARTITION = 10,
    UPDATE_ERROR_BAD_ARGUMENT = 11,
    UPDATE_ERROR_ABORT = 12
};

Public Attributes Documentation

variable Update

UpdateClass Update;

Macro Definition Documentation

define ENCRYPTED_BLOCK_SIZE

#define ENCRYPTED_BLOCK_SIZE 16

define UPDATE_SIZE_UNKNOWN

#define UPDATE_SIZE_UNKNOWN 0xFFFFFFFF

define UPDATE_TIMEOUT_MS

#define UPDATE_TIMEOUT_MS 30 * 1000

The documentation for this class was generated from the following file cores/common/arduino/libraries/common/Update/Update.h