ESPHome  2023.8.3
Data Structures | Enumerations | Functions | Variables
esphome::ota Namespace Reference

Data Structures

class  ArduinoESP32OTABackend
 
class  ArduinoESP8266OTABackend
 
class  ArduinoRP2040OTABackend
 
class  IDFOTABackend
 
class  OTABackend
 
class  OTAComponent
 OTAComponent provides a simple way to integrate Over-the-Air updates into your app using ArduinoOTA. More...
 
class  OTAEndTrigger
 
class  OTAErrorTrigger
 
class  OTAProgressTrigger
 
class  OTAStartTrigger
 
class  OTAStateChangeTrigger
 

Enumerations

enum  OTAResponseTypes {
  OTA_RESPONSE_OK = 0, OTA_RESPONSE_REQUEST_AUTH = 1, OTA_RESPONSE_HEADER_OK = 64, OTA_RESPONSE_AUTH_OK = 65,
  OTA_RESPONSE_UPDATE_PREPARE_OK = 66, OTA_RESPONSE_BIN_MD5_OK = 67, OTA_RESPONSE_RECEIVE_OK = 68, OTA_RESPONSE_UPDATE_END_OK = 69,
  OTA_RESPONSE_SUPPORTS_COMPRESSION = 70, OTA_RESPONSE_ERROR_MAGIC = 128, OTA_RESPONSE_ERROR_UPDATE_PREPARE = 129, OTA_RESPONSE_ERROR_AUTH_INVALID = 130,
  OTA_RESPONSE_ERROR_WRITING_FLASH = 131, OTA_RESPONSE_ERROR_UPDATE_END = 132, OTA_RESPONSE_ERROR_INVALID_BOOTSTRAPPING = 133, OTA_RESPONSE_ERROR_WRONG_CURRENT_FLASH_CONFIG = 134,
  OTA_RESPONSE_ERROR_WRONG_NEW_FLASH_CONFIG = 135, OTA_RESPONSE_ERROR_ESP8266_NOT_ENOUGH_SPACE = 136, OTA_RESPONSE_ERROR_ESP32_NOT_ENOUGH_SPACE = 137, OTA_RESPONSE_ERROR_NO_UPDATE_PARTITION = 138,
  OTA_RESPONSE_ERROR_MD5_MISMATCH = 139, OTA_RESPONSE_ERROR_RP2040_NOT_ENOUGH_SPACE = 140, OTA_RESPONSE_ERROR_UNKNOWN = 255
}
 
enum  OTAState { OTA_COMPLETED = 0, OTA_STARTED, OTA_IN_PROGRESS, OTA_ERROR }
 

Functions

std::unique_ptr< OTABackendmake_ota_backend ()
 

Variables

OTAComponentglobal_ota_component = nullptr
 

Enumeration Type Documentation

◆ OTAResponseTypes

Enumerator
OTA_RESPONSE_OK 
OTA_RESPONSE_REQUEST_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_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_UNKNOWN 

Definition at line 12 of file ota_component.h.

◆ OTAState

Enumerator
OTA_COMPLETED 
OTA_STARTED 
OTA_IN_PROGRESS 
OTA_ERROR 

Definition at line 40 of file ota_component.h.

Function Documentation

◆ make_ota_backend()

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

Definition at line 27 of file ota_component.cpp.

Variable Documentation

◆ global_ota_component

OTAComponent * esphome::ota::global_ota_component = nullptr

Definition at line 25 of file ota_component.cpp.