ESPHome  2024.9.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::ESPHomeOTAComponent Class Reference

ESPHomeOTAComponent provides a simple way to integrate Over-the-Air updates into your app using ArduinoOTA. More...

#include <ota_esphome.h>

Inheritance diagram for esphome::ESPHomeOTAComponent:
esphome::ota::OTAComponent esphome::Component

Public Member Functions

void set_auth_password (const std::string &password)
 
void set_port (uint16_t port)
 Manually set the port OTA should listen on. More...
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void loop () override
 
uint16_t get_port () const
 
- Public Member Functions inherited from esphome::ota::OTAComponent
void add_on_state_callback (std::function< void(ota::OTAState, float, uint8_t)> &&callback)
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Member Functions

void handle_ ()
 
bool readall_ (uint8_t *buf, size_t len)
 
bool writeall_ (const uint8_t *buf, size_t len)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

std::string password_
 
uint16_t port_
 
std::unique_ptr< socket::Socketserver_
 
std::unique_ptr< socket::Socketclient_
 
- Protected Attributes inherited from esphome::ota::OTAComponent
CallbackManager< void(ota::OTAState, float, uint8_t)> state_callback_ {}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Detailed Description

ESPHomeOTAComponent provides a simple way to integrate Over-the-Air updates into your app using ArduinoOTA.

Definition at line 13 of file ota_esphome.h.

Member Function Documentation

◆ dump_config()

void esphome::ESPHomeOTAComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 72 of file ota_esphome.cpp.

◆ get_port()

uint16_t esphome::ESPHomeOTAComponent::get_port ( ) const

Definition at line 410 of file ota_esphome.cpp.

◆ get_setup_priority()

float esphome::ESPHomeOTAComponent::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 409 of file ota_esphome.cpp.

◆ handle_()

void esphome::ESPHomeOTAComponent::handle_ ( )
protected

Definition at line 87 of file ota_esphome.cpp.

◆ loop()

void esphome::ESPHomeOTAComponent::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 83 of file ota_esphome.cpp.

◆ readall_()

bool esphome::ESPHomeOTAComponent::readall_ ( uint8_t *  buf,
size_t  len 
)
protected

Definition at line 350 of file ota_esphome.cpp.

◆ set_auth_password()

void esphome::ESPHomeOTAComponent::set_auth_password ( const std::string &  password)
inline

Definition at line 16 of file ota_esphome.h.

◆ set_port()

void esphome::ESPHomeOTAComponent::set_port ( uint16_t  port)

Manually set the port OTA should listen on.

Definition at line 411 of file ota_esphome.cpp.

◆ setup()

void esphome::ESPHomeOTAComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 24 of file ota_esphome.cpp.

◆ writeall_()

bool esphome::ESPHomeOTAComponent::writeall_ ( const uint8_t *  buf,
size_t  len 
)
protected

Definition at line 381 of file ota_esphome.cpp.

Field Documentation

◆ client_

std::unique_ptr<socket::Socket> esphome::ESPHomeOTAComponent::client_
protected

Definition at line 41 of file ota_esphome.h.

◆ password_

std::string esphome::ESPHomeOTAComponent::password_
protected

Definition at line 35 of file ota_esphome.h.

◆ port_

uint16_t esphome::ESPHomeOTAComponent::port_
protected

Definition at line 38 of file ota_esphome.h.

◆ server_

std::unique_ptr<socket::Socket> esphome::ESPHomeOTAComponent::server_
protected

Definition at line 40 of file ota_esphome.h.


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