Data Structures
class	ArduinoLibreTinyOTABackend

class	ArduinoRP2OTABackend

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

Concepts
concept	OTABackendContract

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_VERSION_DOWNGRADE = 0x93 , OTA_RESPONSE_ERROR_ENCRYPTION_REQUIRED = 0x94 , 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
bool	version_is_older (const char candidate, const char reference)
	Compare two dotted-numeric version strings (such as "1.2.3").

OTAGlobalCallback *	get_global_ota_callback ()

constexpr size_t	next_erase_end (size_t write_end, size_t partition_size)
	Target erased watermark for lazy block erase-ahead.

std::unique_ptr< ArduinoLibreTinyOTABackend >	make_ota_backend ()

void	get_running_app_position (uint32_t &offset, size_t &size)

size_t	rsa_der_public_key (const uint8_t modulus_be, const uint8_t exponent_be, size_t exponent_len, uint8_t *out, size_t out_len)
	Wrap a raw RSA-3072 modulus and exponent as a DER RSAPublicKey.

Variables
OTAGlobalCallback *	global_ota_callback {nullptr}

constexpr size_t	RSA_3072_MODULUS_BYTES = 384

constexpr uint8_t	RSA_DER_MODULUS_PREFIX [] = {0x02, 0x82, 0x01, 0x81, 0x00}

constexpr size_t	RSA_DER_MODULUS_LEN = sizeof(RSA_DER_MODULUS_PREFIX) + RSA_3072_MODULUS_BYTES

constexpr size_t	RSA_DER_PUBKEY_MAX = 4 + RSA_DER_MODULUS_LEN + 7

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 35 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_VERSION_DOWNGRADE
OTA_RESPONSE_ERROR_ENCRYPTION_REQUIRED
OTA_RESPONSE_ERROR_UNKNOWN

Definition at line 17 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 83 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 91 of file ota_backend.h.

Function Documentation

◆ get_global_ota_callback()

OTAGlobalCallback * esphome::ota::get_global_ota_callback ( )

Definition at line 36 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.

◆ next_erase_end()

size_t esphome::ota::next_erase_end	(	size_t	write_end,
		size_t	partition_size )

constexpr

Target erased watermark for lazy block erase-ahead.

Rounds the write end offset up to a block boundary, clamped to the partition size. Platform-independent so the arithmetic is host-testable.

Definition at line 78 of file ota_backend.h.

◆ rsa_der_public_key()

size_t esphome::ota::rsa_der_public_key	(	const uint8_t *	modulus_be,
		const uint8_t *	exponent_be,
		size_t	exponent_len,
		uint8_t *	out,
		size_t	out_len )

inline

Wrap a raw RSA-3072 modulus and exponent as a DER RSAPublicKey.

Parameters

modulus_be	Big-endian modulus, RSA_3072_MODULUS_BYTES long.
exponent_be	Big-endian exponent, exponent_len bytes, leading zeros allowed. Rejected if the significant bytes would not fit a short-form length.

Returns: the encoded length, or 0 if the exponent is zero or the buffer is too small.

Definition at line 33 of file ota_rsa_der.h.

◆ version_is_older()

bool esphome::ota::version_is_older	(	const char *	candidate,
		const char *	reference )

Compare two dotted-numeric version strings (such as "1.2.3").

Returns true when candidate represents a strictly older (lower) firmware version than reference. Each dot-separated component is parsed as an integer and compared left-to-right; absent trailing components count as 0, so "1.2" and "1.2.0" are equal. Equal versions return false so that re-flashing the same version is permitted.

Used for software OTA downgrade protection. Inputs come from the project version embedded in the signed firmware image, which is validated to be dotted-numeric at config time. Non-digit characters terminate a component.

Definition at line 5 of file ota_backend.cpp.

Variable Documentation

◆ global_ota_callback

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

Definition at line 34 of file ota_backend.cpp.

◆ RSA_3072_MODULUS_BYTES

size_t esphome::ota::RSA_3072_MODULUS_BYTES = 384

constexpr

Definition at line 20 of file ota_rsa_der.h.

◆ RSA_DER_MODULUS_LEN

size_t esphome::ota::RSA_DER_MODULUS_LEN = sizeof(RSA_DER_MODULUS_PREFIX) + RSA_3072_MODULUS_BYTES

constexpr

Definition at line 22 of file ota_rsa_der.h.

◆ RSA_DER_MODULUS_PREFIX

uint8_t esphome::ota::RSA_DER_MODULUS_PREFIX[] = {0x02, 0x82, 0x01, 0x81, 0x00}

constexpr

Definition at line 21 of file ota_rsa_der.h.

◆ RSA_DER_PUBKEY_MAX

size_t esphome::ota::RSA_DER_PUBKEY_MAX = 4 + RSA_DER_MODULUS_LEN + 7

constexpr

Definition at line 25 of file ota_rsa_der.h.

Data Structures

Concepts

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ OTAAbortTrigger

◆ OTABackendPtr

◆ OTAEndTrigger

◆ OTAStartTrigger

Enumeration Type Documentation

◆ OTAResponseTypes

◆ OTAState

◆ OTAType

Function Documentation

◆ get_global_ota_callback()

◆ get_running_app_position()

◆ make_ota_backend()

◆ next_erase_end()

◆ rsa_der_public_key()

◆ version_is_older()

Variable Documentation

◆ global_ota_callback

◆ RSA_3072_MODULUS_BYTES

◆ RSA_DER_MODULUS_LEN

◆ RSA_DER_MODULUS_PREFIX

◆ RSA_DER_PUBKEY_MAX