#include <packet_transport.h>

Inheritance diagram for esphome::packet_transport::PacketTransport:

Public Member Functions
void	setup () override

void	loop () override

void	update () override

void	dump_config () override

void	set_sensor_count (size_t count)

void	add_sensor (const char id, sensor::Sensor sensor)

void	add_remote_sensor (const char hostname, const char remote_id, sensor::Sensor *sensor)

void	set_binary_sensor_count (size_t count)

void	add_binary_sensor (const char id, binary_sensor::BinarySensor sensor)

void	add_remote_binary_sensor (const char hostname, const char remote_id, binary_sensor::BinarySensor *sensor)

void	add_provider (const char *hostname)

void	set_is_provider (bool is_provider)

void	set_encryption_key (std::vector< uint8_t > key)

void	set_rolling_code_enable (bool enable)

void	set_ping_pong_enable (bool enable)

void	set_ping_pong_recycle_time (uint32_t recycle_time)

void	set_provider_encryption (const char *name, std::vector< uint8_t > key)

void	set_provider_status_sensor (const char name, binary_sensor::BinarySensor sensor)

void	set_platform_name (const char *name)

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object.

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor.

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
virtual float	get_setup_priority () const
	priority of setup().

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

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.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *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 ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

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

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Protected Member Functions
virtual void	send_packet (const std::vector< uint8_t > &buf) const =0

virtual size_t	get_max_packet_size ()=0

virtual bool	should_send ()

void	process_ (std::span< const uint8_t > data)
	Process a received packet.

void	send_data_ (bool all)

void	flush_ ()

void	add_data_ (uint8_t key, const char *id, float data)

void	add_data_ (uint8_t key, const char *id, uint32_t data)

void	increment_code_ ()

void	add_binary_data_ (uint8_t key, const char *id, bool data)

void	init_data_ ()

void	add_key_ (const char *name, uint32_t key)

void	send_ping_pong_request_ ()

bool	is_encrypted_ () const

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

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

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

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 id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

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

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

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

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 id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

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

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

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
bool	updated_ {}

uint32_t	ping_key_ {}

uint32_t	rolling_code_ [2] {}

bool	rolling_code_enable_ {}

bool	ping_pong_enable_ {}

uint32_t	ping_pong_recyle_time_ {}

uint32_t	last_key_time_ {}

bool	resend_ping_key_ {}

bool	is_provider_ {}

const char *	name_ {}

ESPPreferenceObject	pref_ {}

std::vector< uint8_t >	encryption_key_ {}

FixedVector< Sensor >	sensors_ {}

string_map_t< string_map_t< sensor::Sensor * > >	remote_sensors_ {}

FixedVector< BinarySensor >	binary_sensors_ {}

string_map_t< string_map_t< binary_sensor::BinarySensor * > >	remote_binary_sensors_ {}

string_map_t< Provider >	providers_ {}

std::vector< uint8_t >	ping_header_ {}

std::vector< uint8_t >	header_ {}

std::vector< uint8_t >	data_ {}

string_map_t< uint32_t >	ping_keys_ {}

const char *	platform_name_ {""}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

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 Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

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

ComponentRuntimeStats	runtime_stats_

Detailed Description

Definition at line 59 of file packet_transport.h.

Member Function Documentation

◆ add_binary_data_()

void esphome::packet_transport::PacketTransport::add_binary_data_	(	uint8_t	key,
		const char *	id,
		bool	data )

protected

Definition at line 282 of file packet_transport.cpp.

◆ add_binary_sensor()

void esphome::packet_transport::PacketTransport::add_binary_sensor	(	const char *	id,
		binary_sensor::BinarySensor *	sensor )

inline

Definition at line 79 of file packet_transport.h.

◆ add_data_() [1/2]

void esphome::packet_transport::PacketTransport::add_data_	(	uint8_t	key,
		const char *	id,
		float	data )

protected

Definition at line 292 of file packet_transport.cpp.

◆ add_data_() [2/2]

void esphome::packet_transport::PacketTransport::add_data_	(	uint8_t	key,
		const char *	id,
		uint32_t	data )

protected

Definition at line 297 of file packet_transport.cpp.

◆ add_key_()

void esphome::packet_transport::PacketTransport::add_key_	(	const char *	name,
		uint32_t	key )

protected

Definition at line 383 of file packet_transport.cpp.

◆ add_provider()

void esphome::packet_transport::PacketTransport::add_provider ( const char * hostname )

inline

Definition at line 90 of file packet_transport.h.

◆ add_remote_binary_sensor()

void esphome::packet_transport::PacketTransport::add_remote_binary_sensor	(	const char *	hostname,
		const char *	remote_id,
		binary_sensor::BinarySensor *	sensor )

inline

Definition at line 84 of file packet_transport.h.

◆ add_remote_sensor()

void esphome::packet_transport::PacketTransport::add_remote_sensor	(	const char *	hostname,
		const char *	remote_id,
		sensor::Sensor *	sensor )

inline

Definition at line 72 of file packet_transport.h.

◆ add_sensor()

void esphome::packet_transport::PacketTransport::add_sensor	(	const char *	id,
		sensor::Sensor *	sensor )

inline

Definition at line 68 of file packet_transport.h.

◆ dump_config()

void esphome::packet_transport::PacketTransport::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 546 of file packet_transport.cpp.

◆ flush_()

void esphome::packet_transport::PacketTransport::flush_ ( )

protected

Definition at line 265 of file packet_transport.cpp.

◆ get_max_packet_size()

virtual size_t esphome::packet_transport::PacketTransport::get_max_packet_size ( )

protectedpure virtual

Implemented in esphome::espnow::ESPNowTransport, esphome::sx126x::SX126xTransport, esphome::sx127x::SX127xTransport, esphome::uart::UARTTransport, and esphome::udp::UDPTransport.

◆ increment_code_()

void esphome::packet_transport::PacketTransport::increment_code_ ( )

protected

Definition at line 580 of file packet_transport.cpp.

◆ init_data_()

void esphome::packet_transport::PacketTransport::init_data_ ( )

protected

Definition at line 249 of file packet_transport.cpp.

◆ is_encrypted_()

bool esphome::packet_transport::PacketTransport::is_encrypted_ ( ) const

inlineprotected

Definition at line 167 of file packet_transport.h.

◆ loop()

void esphome::packet_transport::PacketTransport::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::uart::UARTTransport.

Definition at line 591 of file packet_transport.cpp.

◆ process_()

void esphome::packet_transport::PacketTransport::process_ ( std::span< const uint8_t > data )

protected

Process a received packet.

Definition at line 420 of file packet_transport.cpp.

◆ send_data_()

void esphome::packet_transport::PacketTransport::send_data_ ( bool all )

protected

Definition at line 307 of file packet_transport.cpp.

◆ send_packet()

virtual void esphome::packet_transport::PacketTransport::send_packet ( const std::vector< uint8_t > & buf ) const

protectedpure virtual

Implemented in esphome::espnow::ESPNowTransport, esphome::sx126x::SX126xTransport, esphome::sx127x::SX127xTransport, esphome::uart::UARTTransport, and esphome::udp::UDPTransport.

◆ send_ping_pong_request_()

void esphome::packet_transport::PacketTransport::send_ping_pong_request_ ( )

protected

Definition at line 599 of file packet_transport.cpp.

◆ set_binary_sensor_count()

void esphome::packet_transport::PacketTransport::set_binary_sensor_count ( size_t count )

inline

Definition at line 78 of file packet_transport.h.

◆ set_encryption_key()

void esphome::packet_transport::PacketTransport::set_encryption_key ( std::vector< uint8_t > key )

inline

Definition at line 105 of file packet_transport.h.

◆ set_is_provider()

void esphome::packet_transport::PacketTransport::set_is_provider ( bool is_provider )

inline

Definition at line 104 of file packet_transport.h.

◆ set_ping_pong_enable()

void esphome::packet_transport::PacketTransport::set_ping_pong_enable ( bool enable )

inline

Definition at line 107 of file packet_transport.h.

◆ set_ping_pong_recycle_time()

void esphome::packet_transport::PacketTransport::set_ping_pong_recycle_time ( uint32_t recycle_time )

inline

Definition at line 108 of file packet_transport.h.

◆ set_platform_name()

void esphome::packet_transport::PacketTransport::set_platform_name ( const char * name )

inline

Definition at line 117 of file packet_transport.h.

◆ set_provider_encryption()

void esphome::packet_transport::PacketTransport::set_provider_encryption	(	const char *	name,
		std::vector< uint8_t >	key )

inline

Definition at line 109 of file packet_transport.h.

◆ set_provider_status_sensor()

void esphome::packet_transport::PacketTransport::set_provider_status_sensor	(	const char *	name,
		binary_sensor::BinarySensor *	sensor )

inline

Definition at line 113 of file packet_transport.h.

◆ set_rolling_code_enable()

void esphome::packet_transport::PacketTransport::set_rolling_code_enable ( bool enable )

inline

Definition at line 106 of file packet_transport.h.

◆ set_sensor_count()

void esphome::packet_transport::PacketTransport::set_sensor_count ( size_t count )

inline

Definition at line 67 of file packet_transport.h.

◆ setup()

void esphome::packet_transport::PacketTransport::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::sx126x::SX126xTransport, esphome::sx127x::SX127xTransport, and esphome::udp::UDPTransport.

Definition at line 202 of file packet_transport.cpp.

◆ should_send()

virtual bool esphome::packet_transport::PacketTransport::should_send ( )

inlineprotectedvirtual

Reimplemented in esphome::espnow::ESPNowTransport, esphome::sx126x::SX126xTransport, esphome::sx127x::SX127xTransport, esphome::uart::UARTTransport, and esphome::udp::UDPTransport.

Definition at line 123 of file packet_transport.h.

◆ update()

void esphome::packet_transport::PacketTransport::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 331 of file packet_transport.cpp.

Field Documentation

◆ binary_sensors_

FixedVector<BinarySensor> esphome::packet_transport::PacketTransport::binary_sensors_ {}

protected

Definition at line 154 of file packet_transport.h.

◆ data_

std::vector<uint8_t> esphome::packet_transport::PacketTransport::data_ {}

protected

Definition at line 161 of file packet_transport.h.

◆ encryption_key_

std::vector<uint8_t> esphome::packet_transport::PacketTransport::encryption_key_ {}

protected

Definition at line 147 of file packet_transport.h.

◆ header_

std::vector<uint8_t> esphome::packet_transport::PacketTransport::header_ {}

protected

Definition at line 160 of file packet_transport.h.

◆ is_provider_

bool esphome::packet_transport::PacketTransport::is_provider_ {}

protected

Definition at line 143 of file packet_transport.h.

◆ last_key_time_

uint32_t esphome::packet_transport::PacketTransport::last_key_time_ {}

protected

Definition at line 141 of file packet_transport.h.

◆ name_

const char* esphome::packet_transport::PacketTransport::name_ {}

protected

Definition at line 144 of file packet_transport.h.

◆ ping_header_

std::vector<uint8_t> esphome::packet_transport::PacketTransport::ping_header_ {}

protected

Definition at line 159 of file packet_transport.h.

◆ ping_key_

uint32_t esphome::packet_transport::PacketTransport::ping_key_ {}

protected

Definition at line 136 of file packet_transport.h.

◆ ping_keys_

string_map_t<uint32_t> esphome::packet_transport::PacketTransport::ping_keys_ {}

protected

Definition at line 162 of file packet_transport.h.

◆ ping_pong_enable_

bool esphome::packet_transport::PacketTransport::ping_pong_enable_ {}

protected

Definition at line 139 of file packet_transport.h.

◆ ping_pong_recyle_time_

uint32_t esphome::packet_transport::PacketTransport::ping_pong_recyle_time_ {}

protected

Definition at line 140 of file packet_transport.h.

◆ platform_name_

const char* esphome::packet_transport::PacketTransport::platform_name_ {""}

protected

Definition at line 163 of file packet_transport.h.

◆ pref_

ESPPreferenceObject esphome::packet_transport::PacketTransport::pref_ {}

protected

Definition at line 145 of file packet_transport.h.

◆ providers_

string_map_t<Provider> esphome::packet_transport::PacketTransport::providers_ {}

protected

Definition at line 158 of file packet_transport.h.

◆ remote_binary_sensors_

string_map_t<string_map_t<binary_sensor::BinarySensor *> > esphome::packet_transport::PacketTransport::remote_binary_sensors_ {}

protected

Definition at line 155 of file packet_transport.h.

◆ remote_sensors_

string_map_t<string_map_t<sensor::Sensor *> > esphome::packet_transport::PacketTransport::remote_sensors_ {}

protected

Definition at line 151 of file packet_transport.h.

◆ resend_ping_key_

bool esphome::packet_transport::PacketTransport::resend_ping_key_ {}

protected

Definition at line 142 of file packet_transport.h.

◆ rolling_code_

uint32_t esphome::packet_transport::PacketTransport::rolling_code_[2] {}

protected

Definition at line 137 of file packet_transport.h.

◆ rolling_code_enable_

bool esphome::packet_transport::PacketTransport::rolling_code_enable_ {}

protected

Definition at line 138 of file packet_transport.h.

◆ sensors_

FixedVector<Sensor> esphome::packet_transport::PacketTransport::sensors_ {}

protected

Definition at line 150 of file packet_transport.h.

◆ updated_

bool esphome::packet_transport::PacketTransport::updated_ {}

protected

Definition at line 135 of file packet_transport.h.

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

esphome/components/packet_transport/packet_transport.h
esphome/components/packet_transport/packet_transport.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_binary_data_()

◆ add_binary_sensor()

◆ add_data_() [1/2]

◆ add_data_() [2/2]

◆ add_key_()

◆ add_provider()

◆ add_remote_binary_sensor()

◆ add_remote_sensor()

◆ add_sensor()

◆ dump_config()

◆ flush_()

◆ get_max_packet_size()

◆ increment_code_()

◆ init_data_()

◆ is_encrypted_()

◆ loop()

◆ process_()

◆ send_data_()

◆ send_packet()

◆ send_ping_pong_request_()

◆ set_binary_sensor_count()

◆ set_encryption_key()

◆ set_is_provider()

◆ set_ping_pong_enable()

◆ set_ping_pong_recycle_time()

◆ set_platform_name()

◆ set_provider_encryption()

◆ set_provider_status_sensor()

◆ set_rolling_code_enable()

◆ set_sensor_count()

◆ setup()

◆ should_send()

◆ update()

Field Documentation

◆ binary_sensors_

◆ data_

◆ encryption_key_

◆ header_

◆ is_provider_

◆ last_key_time_

◆ name_

◆ ping_header_

◆ ping_key_

◆ ping_keys_

◆ ping_pong_enable_

◆ ping_pong_recyle_time_

◆ platform_name_

◆ pref_

◆ providers_

◆ remote_binary_sensors_

◆ remote_sensors_

◆ resend_ping_key_

◆ rolling_code_

◆ rolling_code_enable_

◆ sensors_

◆ updated_