#include <openthread.h>

Inheritance diagram for esphome::openthread::OpenThreadSrpComponent:

Public Member Functions
void	set_mdns (esphome::mdns::MDNSComponent *mdns)

float	get_setup_priority () const override

void	setup () override

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

virtual void	dump_config ()

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

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=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Static Public Member Functions
static void	srp_callback (otError err, const otSrpClientHostInfo host_info, const otSrpClientService services, const otSrpClientService removed_services, void context)

static void	srp_start_callback (const otSockAddr server_socket_address, void context)

static void	srp_factory_reset_callback (otError err, const otSrpClientHostInfo host_info, const otSrpClientService services, const otSrpClientService removed_services, void context)

Protected Member Functions
void *	pool_alloc_ (size_t size)

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

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.

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.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes
esphome::mdns::MDNSComponent *	mdns_ {nullptr}

std::vector< std::unique_ptr< uint8_t[]> >	memory_pool_

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Detailed Description

Definition at line 60 of file openthread.h.

Member Function Documentation

◆ get_setup_priority()

float esphome::openthread::OpenThreadSrpComponent::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 64 of file openthread.h.

◆ pool_alloc_()

void * esphome::openthread::OpenThreadSrpComponent::pool_alloc_ ( size_t size )

protected

Definition at line 222 of file openthread.cpp.

◆ set_mdns()

void esphome::openthread::OpenThreadSrpComponent::set_mdns ( esphome::mdns::MDNSComponent * mdns )

Definition at line 228 of file openthread.cpp.

◆ setup()

void esphome::openthread::OpenThreadSrpComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 132 of file openthread.cpp.

◆ srp_callback()

void esphome::openthread::OpenThreadSrpComponent::srp_callback	(	otError	err,
		const otSrpClientHostInfo *	host_info,
		const otSrpClientService *	services,
		const otSrpClientService *	removed_services,
		void *	context )

static

Definition at line 100 of file openthread.cpp.

◆ srp_factory_reset_callback()

void esphome::openthread::OpenThreadSrpComponent::srp_factory_reset_callback	(	otError	err,
		const otSrpClientHostInfo *	host_info,
		const otSrpClientService *	services,
		const otSrpClientService *	removed_services,
		void *	context )

static

Definition at line 118 of file openthread.cpp.

◆ srp_start_callback()

void esphome::openthread::OpenThreadSrpComponent::srp_start_callback	(	const otSockAddr *	server_socket_address,
		void *	context )

static

Definition at line 114 of file openthread.cpp.

Field Documentation

◆ mdns_

esphome::mdns::MDNSComponent* esphome::openthread::OpenThreadSrpComponent::mdns_ {nullptr}

protected

Definition at line 74 of file openthread.h.

◆ memory_pool_

std::vector<std::unique_ptr<uint8_t[]> > esphome::openthread::OpenThreadSrpComponent::memory_pool_

protected

Definition at line 75 of file openthread.h.

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

esphome/components/openthread/openthread.h
esphome/components/openthread/openthread.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ get_setup_priority()

◆ pool_alloc_()

◆ set_mdns()

◆ setup()

◆ srp_callback()

◆ srp_factory_reset_callback()

◆ srp_start_callback()

Field Documentation

◆ mdns_

◆ memory_pool_