Data Structures
class	ArduinoLibreTinyOTABackend

class	ArduinoRP2040OTABackend

class	ESP8266OTABackend
	OTA backend for ESP8266 using native SDK functions. More...

class	HostOTABackend
	Host OTA backend: stages new binary to `<exe>.ota.new`, validates ELF/Mach-O matches the running arch, renames over `<exe>`, and arms execv via arch_restart(). More...

class	IDFOTABackend

class	OTAComponent

class	OTAErrorTrigger

class	OTAGlobalCallback
	Global callback that aggregates OTA state from all OTA components. More...

class	OTAGlobalStateListener
	Listener interface for global OTA state changes (includes OTA component pointer). More...

class	OTAProgressTrigger

class	OTAStateChangeTrigger

class	OTAStateListener
	Listener interface for OTA state changes. More...

class	OTAStateTrigger

struct	StubOTABackend

Typedefs
using	OTAStartTrigger = OTAStateTrigger<OTA_STARTED>

using	OTAEndTrigger = OTAStateTrigger<OTA_COMPLETED>

using	OTAAbortTrigger = OTAStateTrigger<OTA_ABORT>

using	OTABackendPtr = decltype(make_ota_backend())

Enumerations
enum	OTAResponseTypes { OTA_RESPONSE_OK = 0x00 , OTA_RESPONSE_REQUEST_AUTH = 0x01 , OTA_RESPONSE_REQUEST_SHA256_AUTH = 0x02 , OTA_RESPONSE_HEADER_OK = 0x40 , OTA_RESPONSE_AUTH_OK = 0x41 , OTA_RESPONSE_UPDATE_PREPARE_OK = 0x42 , OTA_RESPONSE_BIN_MD5_OK = 0x43 , OTA_RESPONSE_RECEIVE_OK = 0x44 , OTA_RESPONSE_UPDATE_END_OK = 0x45 , OTA_RESPONSE_SUPPORTS_COMPRESSION = 0x46 , OTA_RESPONSE_CHUNK_OK = 0x47 , OTA_RESPONSE_FEATURE_FLAGS = 0x48 , OTA_RESPONSE_ERROR_MAGIC = 0x80 , OTA_RESPONSE_ERROR_UPDATE_PREPARE = 0x81 , OTA_RESPONSE_ERROR_AUTH_INVALID = 0x82 , OTA_RESPONSE_ERROR_WRITING_FLASH = 0x83 , OTA_RESPONSE_ERROR_UPDATE_END = 0x84 , OTA_RESPONSE_ERROR_INVALID_BOOTSTRAPPING = 0x85 , OTA_RESPONSE_ERROR_WRONG_CURRENT_FLASH_CONFIG = 0x86 , OTA_RESPONSE_ERROR_WRONG_NEW_FLASH_CONFIG = 0x87 , OTA_RESPONSE_ERROR_ESP8266_NOT_ENOUGH_SPACE = 0x88 , OTA_RESPONSE_ERROR_ESP32_NOT_ENOUGH_SPACE = 0x89 , OTA_RESPONSE_ERROR_NO_UPDATE_PARTITION = 0x8A , OTA_RESPONSE_ERROR_MD5_MISMATCH = 0x8B , OTA_RESPONSE_ERROR_RP2040_NOT_ENOUGH_SPACE = 0x8C , OTA_RESPONSE_ERROR_SIGNATURE_INVALID = 0x8D , OTA_RESPONSE_ERROR_UNSUPPORTED_OTA_TYPE = 0x8E , OTA_RESPONSE_ERROR_PARTITION_TABLE_VERIFY = 0x8F , OTA_RESPONSE_ERROR_PARTITION_TABLE_UPDATE = 0x90 , OTA_RESPONSE_ERROR_BOOTLOADER_VERIFY = 0x91 , OTA_RESPONSE_ERROR_BOOTLOADER_UPDATE = 0x92 , OTA_RESPONSE_ERROR_UNKNOWN = 0xFF }

enum	OTAState { OTA_COMPLETED = 0 , OTA_STARTED , OTA_IN_PROGRESS , OTA_ABORT , OTA_ERROR }

enum	OTAType : uint8_t { OTA_TYPE_UPDATE_APP = 0x00 , OTA_TYPE_UPDATE_PARTITION_TABLE = 0x01 , OTA_TYPE_UPDATE_BOOTLOADER = 0x02 }

Functions
OTAGlobalCallback *	get_global_ota_callback ()

std::unique_ptr< ArduinoLibreTinyOTABackend >	make_ota_backend ()

void	get_running_app_position (uint32_t &offset, size_t &size)

Variables
OTAGlobalCallback *	global_ota_callback {nullptr}

Typedef Documentation

◆ OTAAbortTrigger

using esphome::ota::OTAAbortTrigger = OTAStateTrigger<OTA_ABORT>

Definition at line 39 of file automation.h.

◆ OTABackendPtr

using esphome::ota::OTABackendPtr = decltype(make_ota_backend())

Definition at line 26 of file ota_backend_factory.h.

◆ OTAEndTrigger

using esphome::ota::OTAEndTrigger = OTAStateTrigger<OTA_COMPLETED>

Definition at line 38 of file automation.h.

◆ OTAStartTrigger

using esphome::ota::OTAStartTrigger = OTAStateTrigger<OTA_STARTED>

Definition at line 37 of file automation.h.

Enumeration Type Documentation

◆ OTAResponseTypes

enum esphome::ota::OTAResponseTypes

Enumerator
OTA_RESPONSE_OK
OTA_RESPONSE_REQUEST_AUTH
OTA_RESPONSE_REQUEST_SHA256_AUTH
OTA_RESPONSE_HEADER_OK
OTA_RESPONSE_AUTH_OK
OTA_RESPONSE_UPDATE_PREPARE_OK
OTA_RESPONSE_BIN_MD5_OK
OTA_RESPONSE_RECEIVE_OK
OTA_RESPONSE_UPDATE_END_OK
OTA_RESPONSE_SUPPORTS_COMPRESSION
OTA_RESPONSE_CHUNK_OK
OTA_RESPONSE_FEATURE_FLAGS
OTA_RESPONSE_ERROR_MAGIC
OTA_RESPONSE_ERROR_UPDATE_PREPARE
OTA_RESPONSE_ERROR_AUTH_INVALID
OTA_RESPONSE_ERROR_WRITING_FLASH
OTA_RESPONSE_ERROR_UPDATE_END
OTA_RESPONSE_ERROR_INVALID_BOOTSTRAPPING
OTA_RESPONSE_ERROR_WRONG_CURRENT_FLASH_CONFIG
OTA_RESPONSE_ERROR_WRONG_NEW_FLASH_CONFIG
OTA_RESPONSE_ERROR_ESP8266_NOT_ENOUGH_SPACE
OTA_RESPONSE_ERROR_ESP32_NOT_ENOUGH_SPACE
OTA_RESPONSE_ERROR_NO_UPDATE_PARTITION
OTA_RESPONSE_ERROR_MD5_MISMATCH
OTA_RESPONSE_ERROR_RP2040_NOT_ENOUGH_SPACE
OTA_RESPONSE_ERROR_SIGNATURE_INVALID
OTA_RESPONSE_ERROR_UNSUPPORTED_OTA_TYPE
OTA_RESPONSE_ERROR_PARTITION_TABLE_VERIFY
OTA_RESPONSE_ERROR_PARTITION_TABLE_UPDATE
OTA_RESPONSE_ERROR_BOOTLOADER_VERIFY
OTA_RESPONSE_ERROR_BOOTLOADER_UPDATE
OTA_RESPONSE_ERROR_UNKNOWN

Definition at line 15 of file ota_backend.h.

◆ OTAState

enum esphome::ota::OTAState

Enumerator
OTA_COMPLETED
OTA_STARTED
OTA_IN_PROGRESS
OTA_ABORT
OTA_ERROR

Definition at line 52 of file ota_backend.h.

◆ OTAType

enum esphome::ota::OTAType : uint8_t

Enumerator
OTA_TYPE_UPDATE_APP
OTA_TYPE_UPDATE_PARTITION_TABLE
OTA_TYPE_UPDATE_BOOTLOADER

Definition at line 60 of file ota_backend.h.

Function Documentation

◆ get_global_ota_callback()

OTAGlobalCallback * esphome::ota::get_global_ota_callback ( )

Definition at line 8 of file ota_backend.cpp.

◆ get_running_app_position()

void esphome::ota::get_running_app_position	(	uint32_t &	offset,
		size_t &	size )

Definition at line 308 of file ota_partitions_esp_idf.cpp.

◆ make_ota_backend()

std::unique_ptr< HostOTABackend > esphome::ota::make_ota_backend ( )

Definition at line 14 of file ota_backend_arduino_libretiny.cpp.

Variable Documentation

◆ global_ota_callback

OTAGlobalCallback* esphome::ota::global_ota_callback {nullptr}

Definition at line 6 of file ota_backend.cpp.

Data Structures

Typedefs

Enumerations

Functions

Variables