#include <ota_http_request.h>

Inheritance diagram for esphome::http_request::OtaHttpRequestComponent:

Public Member Functions
void	setup () override

void	dump_config () override

float	get_setup_priority () const override

void	set_md5_url (const std::string &md5_url)

void	set_md5 (const std::string &md5)

void	set_password (const std::string &password)

void	set_url (const std::string &url)

void	set_username (const std::string &username)

std::string	md5_computed ()

std::string	md5_expected ()

void	flash ()

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
virtual void	loop ()
	This method will be called repeatedly. More...

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...

Public Member Functions inherited from esphome::Parented< HttpRequestComponent >
	Parented ()

	Parented (HttpRequestComponent *parent)

HttpRequestComponent *	get_parent () const
	Get the parent of this object. More...

void	set_parent (HttpRequestComponent *parent)
	Set the parent of this object. More...

Protected Member Functions
void	cleanup_ (std::unique_ptr< ota::OTABackend > backend, const std::shared_ptr< HttpContainer > &container)

uint8_t	do_ota_ ()

std::string	get_url_with_auth_ (const std::string &url)

bool	http_get_md5_ ()

bool	validate_url_ (const std::string &url)

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	md5_computed_ {}

std::string	md5_expected_ {}

std::string	md5_url_ {}

std::string	password_ {}

std::string	username_ {}

std::string	url_ {}

int	status_ = -1

bool	update_started_ = false

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}

Protected Attributes inherited from esphome::Parented< HttpRequestComponent >
HttpRequestComponent *	parent_

Static Protected Attributes
static const uint16_t	HTTP_RECV_BUFFER = 256

Detailed Description

Definition at line 25 of file ota_http_request.h.

Member Function Documentation

◆ cleanup_()

void esphome::http_request::OtaHttpRequestComponent::cleanup_	(	std::unique_ptr< ota::OTABackend >	backend,
		const std::shared_ptr< HttpContainer > &	container
	)

protected

Definition at line 77 of file ota_http_request.cpp.

◆ do_ota_()

uint8_t esphome::http_request::OtaHttpRequestComponent::do_ota_ ( )

protected

Definition at line 87 of file ota_http_request.cpp.

◆ dump_config()

void esphome::http_request::OtaHttpRequestComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 26 of file ota_http_request.cpp.

◆ flash()

void esphome::http_request::OtaHttpRequestComponent::flash ( )

Definition at line 45 of file ota_http_request.cpp.

◆ get_setup_priority()

float esphome::http_request::OtaHttpRequestComponent::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file ota_http_request.h.

◆ get_url_with_auth_()

std::string esphome::http_request::OtaHttpRequestComponent::get_url_with_auth_ ( const std::string & url )

protected

Definition at line 200 of file ota_http_request.cpp.

◆ http_get_md5_()

bool esphome::http_request::OtaHttpRequestComponent::http_get_md5_ ( )

protected

Definition at line 219 of file ota_http_request.cpp.

◆ md5_computed()

std::string esphome::http_request::OtaHttpRequestComponent::md5_computed ( )

inline

Definition at line 37 of file ota_http_request.h.

◆ md5_expected()

std::string esphome::http_request::OtaHttpRequestComponent::md5_expected ( )

inline

Definition at line 38 of file ota_http_request.h.

◆ set_md5()

void esphome::http_request::OtaHttpRequestComponent::set_md5 ( const std::string & md5 )

inline

Definition at line 32 of file ota_http_request.h.

◆ set_md5_url()

void esphome::http_request::OtaHttpRequestComponent::set_md5_url ( const std::string & md5_url )

Definition at line 28 of file ota_http_request.cpp.

◆ set_password()

void esphome::http_request::OtaHttpRequestComponent::set_password ( const std::string & password )

inline

Definition at line 33 of file ota_http_request.h.

◆ set_url()

void esphome::http_request::OtaHttpRequestComponent::set_url ( const std::string & url )

Definition at line 37 of file ota_http_request.cpp.

◆ set_username()

void esphome::http_request::OtaHttpRequestComponent::set_username ( const std::string & username )

inline

Definition at line 35 of file ota_http_request.h.

◆ setup()

void esphome::http_request::OtaHttpRequestComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file ota_http_request.cpp.

◆ validate_url_()

bool esphome::http_request::OtaHttpRequestComponent::validate_url_ ( const std::string & url )

protected

Definition at line 260 of file ota_http_request.cpp.

Field Documentation

◆ HTTP_RECV_BUFFER

const uint16_t esphome::http_request::OtaHttpRequestComponent::HTTP_RECV_BUFFER = 256

staticprotected

Definition at line 57 of file ota_http_request.h.

◆ md5_computed_

std::string esphome::http_request::OtaHttpRequestComponent::md5_computed_ {}

protected

Definition at line 49 of file ota_http_request.h.

◆ md5_expected_

std::string esphome::http_request::OtaHttpRequestComponent::md5_expected_ {}

protected

Definition at line 50 of file ota_http_request.h.

◆ md5_url_

std::string esphome::http_request::OtaHttpRequestComponent::md5_url_ {}

protected

Definition at line 51 of file ota_http_request.h.

◆ password_

std::string esphome::http_request::OtaHttpRequestComponent::password_ {}

protected

Definition at line 52 of file ota_http_request.h.

◆ status_

int esphome::http_request::OtaHttpRequestComponent::status_ = -1

protected

Definition at line 55 of file ota_http_request.h.

◆ update_started_

bool esphome::http_request::OtaHttpRequestComponent::update_started_ = false

protected

Definition at line 56 of file ota_http_request.h.

◆ url_

std::string esphome::http_request::OtaHttpRequestComponent::url_ {}

protected

Definition at line 54 of file ota_http_request.h.

◆ username_

std::string esphome::http_request::OtaHttpRequestComponent::username_ {}

protected

Definition at line 53 of file ota_http_request.h.

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

/opt/build/esphome/esphome/components/http_request/ota/ota_http_request.h
/opt/build/esphome/esphome/components/http_request/ota/ota_http_request.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ cleanup_()

◆ do_ota_()

◆ dump_config()

◆ flash()

◆ get_setup_priority()

◆ get_url_with_auth_()

◆ http_get_md5_()

◆ md5_computed()

◆ md5_expected()

◆ set_md5()

◆ set_md5_url()

◆ set_password()

◆ set_url()

◆ set_username()

◆ setup()

◆ validate_url_()

Field Documentation

◆ HTTP_RECV_BUFFER

◆ md5_computed_

◆ md5_expected_

◆ md5_url_

◆ password_

◆ status_

◆ update_started_

◆ url_

◆ username_