#include <espnow_component.h>

Inheritance diagram for esphome::espnow::ESPNowComponent:

Public Member Functions
	ESPNowComponent ()

void	setup () override

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

void	add_peer (peer_address_t address)

esp_err_t	add_peer (const uint8_t *peer)

esp_err_t	del_peer (const uint8_t *peer)

void	set_wifi_channel (uint8_t channel)

void	apply_wifi_channel ()

uint8_t	get_wifi_channel ()

void	set_auto_add_peer (bool value)

void	enable ()

void	disable ()

bool	is_disabled () const

void	set_enable_on_boot (bool enable_on_boot)

bool	is_wifi_enabled ()

esp_err_t	send (const uint8_t *peer_address, const std::vector< uint8_t > &payload, const send_callback_t &callback=nullptr)
	Queue a packet to be sent to a specific peer address.

esp_err_t	send (const uint8_t peer_address, const uint8_t payload, size_t size, const send_callback_t &callback=nullptr)

void	register_received_handler (ESPNowReceivedPacketHandler *handler)

void	register_unknown_peer_handler (ESPNowUnknownPeerHandler *handler)

void	register_broadcasted_handler (ESPNowBroadcastedHandler *handler)

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

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.

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

const char *	get_component_source () const
	Get the integration where this component was declared as a string.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
void	enable_ ()

void	send_ ()

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
std::vector< ESPNowUnknownPeerHandler * >	unknown_peer_handlers_

std::vector< ESPNowReceivedPacketHandler * >	received_handlers_

std::vector< ESPNowBroadcastedHandler * >	broadcasted_handlers_

std::vector< ESPNowPeer >	peers_ {}

uint8_t	own_address_ [ESP_NOW_ETH_ALEN] {0}

LockFreeQueue< ESPNowPacket, MAX_ESP_NOW_RECEIVE_QUEUE_SIZE >	receive_packet_queue_ {}

EventPool< ESPNowPacket, MAX_ESP_NOW_RECEIVE_QUEUE_SIZE >	receive_packet_pool_ {}

LockFreeQueue< ESPNowSendPacket, MAX_ESP_NOW_SEND_QUEUE_SIZE >	send_packet_queue_ {}

EventPool< ESPNowSendPacket, MAX_ESP_NOW_SEND_QUEUE_SIZE >	send_packet_pool_ {}

ESPNowSendPacket *	current_send_packet_ {nullptr}

uint8_t	wifi_channel_ {0}

ESPNowState	state_ {ESPNOW_STATE_OFF}

bool	auto_add_peer_ {false}

bool	enable_on_boot_ {true}

Protected Attributes inherited from esphome::Component
const char *	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 91 of file espnow_component.h.

Constructor & Destructor Documentation

◆ ESPNowComponent()

esphome::espnow::ESPNowComponent::ESPNowComponent ( )

Definition at line 119 of file espnow_component.cpp.

Member Function Documentation

◆ add_peer() [1/2]

esp_err_t esphome::espnow::ESPNowComponent::add_peer ( const uint8_t * peer )

Definition at line 404 of file espnow_component.cpp.

◆ add_peer() [2/2]

void esphome::espnow::ESPNowComponent::add_peer ( peer_address_t address )

inline

Definition at line 101 of file espnow_component.h.

◆ apply_wifi_channel()

void esphome::espnow::ESPNowComponent::apply_wifi_channel ( )

Definition at line 234 of file espnow_component.cpp.

◆ del_peer()

esp_err_t esphome::espnow::ESPNowComponent::del_peer ( const uint8_t * peer )

Definition at line 444 of file espnow_component.cpp.

◆ disable()

void esphome::espnow::ESPNowComponent::disable ( )

Definition at line 218 of file espnow_component.cpp.

◆ dump_config()

void esphome::espnow::ESPNowComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 121 of file espnow_component.cpp.

◆ enable()

void esphome::espnow::ESPNowComponent::enable ( )

Definition at line 156 of file espnow_component.cpp.

◆ enable_()

void esphome::espnow::ESPNowComponent::enable_ ( )

protected

Definition at line 166 of file espnow_component.cpp.

◆ get_setup_priority()

float esphome::espnow::ESPNowComponent::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 98 of file espnow_component.h.

◆ get_wifi_channel()

uint8_t esphome::espnow::ESPNowComponent::get_wifi_channel ( )

Definition at line 340 of file espnow_component.cpp.

◆ is_disabled()

bool esphome::espnow::ESPNowComponent::is_disabled ( ) const

inline

Definition at line 119 of file espnow_component.h.

◆ is_wifi_enabled()

bool esphome::espnow::ESPNowComponent::is_wifi_enabled ( )

Definition at line 140 of file espnow_component.cpp.

◆ loop()

void esphome::espnow::ESPNowComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 253 of file espnow_component.cpp.

◆ register_broadcasted_handler()

void esphome::espnow::ESPNowComponent::register_broadcasted_handler ( ESPNowBroadcastedHandler * handler )

inline

Definition at line 143 of file espnow_component.h.

◆ register_received_handler()

void esphome::espnow::ESPNowComponent::register_received_handler ( ESPNowReceivedPacketHandler * handler )

inline

Definition at line 139 of file espnow_component.h.

◆ register_unknown_peer_handler()

void esphome::espnow::ESPNowComponent::register_unknown_peer_handler ( ESPNowUnknownPeerHandler * handler )

inline

Definition at line 140 of file espnow_component.h.

◆ send() [1/2]

esp_err_t esphome::espnow::ESPNowComponent::send	(	const uint8_t *	peer_address,
		const std::vector< uint8_t > &	payload,
		const send_callback_t &	callback = nullptr )

inline

Queue a packet to be sent to a specific peer address.

This method will add the packet to the internal queue and call the callback when the packet is sent. Only one packet will be sent at any given time and the next one will not be sent until the previous one has been acknowledged or failed.

Parameters

peer_address	MAC address of the peer to send the packet to
payload	Data payload to send
callback	Callback to call when the send operation is complete

Returns: ESP_OK on success, or an error code on failure

Definition at line 132 of file espnow_component.h.

◆ send() [2/2]

esp_err_t esphome::espnow::ESPNowComponent::send	(	const uint8_t *	peer_address,
		const uint8_t *	payload,
		size_t	size,
		const send_callback_t &	callback = nullptr )

Definition at line 346 of file espnow_component.cpp.

◆ send_()

void esphome::espnow::ESPNowComponent::send_ ( )

protected

Definition at line 383 of file espnow_component.cpp.

◆ set_auto_add_peer()

void esphome::espnow::ESPNowComponent::set_auto_add_peer ( bool value )

inline

Definition at line 115 of file espnow_component.h.

◆ set_enable_on_boot()

void esphome::espnow::ESPNowComponent::set_enable_on_boot ( bool enable_on_boot )

inline

Definition at line 120 of file espnow_component.h.

◆ set_wifi_channel()

void esphome::espnow::ESPNowComponent::set_wifi_channel ( uint8_t channel )

inline

Definition at line 111 of file espnow_component.h.

◆ setup()

void esphome::espnow::ESPNowComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 148 of file espnow_component.cpp.

Field Documentation

◆ auto_add_peer_

bool esphome::espnow::ESPNowComponent::auto_add_peer_ {false}

protected

Definition at line 175 of file espnow_component.h.

◆ broadcasted_handlers_

std::vector<ESPNowBroadcastedHandler *> esphome::espnow::ESPNowComponent::broadcasted_handlers_

protected

Definition at line 160 of file espnow_component.h.

◆ current_send_packet_

ESPNowSendPacket* esphome::espnow::ESPNowComponent::current_send_packet_ {nullptr}

protected

Definition at line 170 of file espnow_component.h.

◆ enable_on_boot_

bool esphome::espnow::ESPNowComponent::enable_on_boot_ {true}

protected

Definition at line 176 of file espnow_component.h.

◆ own_address_

uint8_t esphome::espnow::ESPNowComponent::own_address_[ESP_NOW_ETH_ALEN] {0}

protected

Definition at line 164 of file espnow_component.h.

◆ peers_

std::vector<ESPNowPeer> esphome::espnow::ESPNowComponent::peers_ {}

protected

Definition at line 162 of file espnow_component.h.

◆ receive_packet_pool_

EventPool<ESPNowPacket, MAX_ESP_NOW_RECEIVE_QUEUE_SIZE> esphome::espnow::ESPNowComponent::receive_packet_pool_ {}

protected

Definition at line 166 of file espnow_component.h.

◆ receive_packet_queue_

LockFreeQueue<ESPNowPacket, MAX_ESP_NOW_RECEIVE_QUEUE_SIZE> esphome::espnow::ESPNowComponent::receive_packet_queue_ {}

protected

Definition at line 165 of file espnow_component.h.

◆ received_handlers_

std::vector<ESPNowReceivedPacketHandler *> esphome::espnow::ESPNowComponent::received_handlers_

protected

Definition at line 159 of file espnow_component.h.

◆ send_packet_pool_

EventPool<ESPNowSendPacket, MAX_ESP_NOW_SEND_QUEUE_SIZE> esphome::espnow::ESPNowComponent::send_packet_pool_ {}

protected

Definition at line 169 of file espnow_component.h.

◆ send_packet_queue_

LockFreeQueue<ESPNowSendPacket, MAX_ESP_NOW_SEND_QUEUE_SIZE> esphome::espnow::ESPNowComponent::send_packet_queue_ {}

protected

Definition at line 168 of file espnow_component.h.

◆ state_

ESPNowState esphome::espnow::ESPNowComponent::state_ {ESPNOW_STATE_OFF}

protected

Definition at line 173 of file espnow_component.h.

◆ unknown_peer_handlers_

std::vector<ESPNowUnknownPeerHandler *> esphome::espnow::ESPNowComponent::unknown_peer_handlers_

protected

Definition at line 158 of file espnow_component.h.

◆ wifi_channel_

uint8_t esphome::espnow::ESPNowComponent::wifi_channel_ {0}

protected

Definition at line 172 of file espnow_component.h.

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

esphome/components/espnow/espnow_component.h
esphome/components/espnow/espnow_component.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ESPNowComponent()

Member Function Documentation

◆ add_peer() [1/2]

◆ add_peer() [2/2]

◆ apply_wifi_channel()

◆ del_peer()

◆ disable()

◆ dump_config()

◆ enable()

◆ enable_()

◆ get_setup_priority()

◆ get_wifi_channel()

◆ is_disabled()

◆ is_wifi_enabled()

◆ loop()

◆ register_broadcasted_handler()

◆ register_received_handler()

◆ register_unknown_peer_handler()

◆ send() [1/2]

◆ send() [2/2]

◆ send_()

◆ set_auto_add_peer()

◆ set_enable_on_boot()

◆ set_wifi_channel()

◆ setup()

Field Documentation

◆ auto_add_peer_

◆ broadcasted_handlers_

◆ current_send_packet_

◆ enable_on_boot_

◆ own_address_

◆ peers_

◆ receive_packet_pool_

◆ receive_packet_queue_

◆ received_handlers_

◆ send_packet_pool_

◆ send_packet_queue_

◆ state_

◆ unknown_peer_handlers_

◆ wifi_channel_