#include <udp_transport.h>

Inheritance diagram for esphome::udp::UDPTransport:

Public Member Functions
void	setup () override

void	update () override

float	get_setup_priority () const override

Public Member Functions inherited from esphome::packet_transport::PacketTransport
void	loop () override

void	dump_config () override

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

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

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

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

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

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.

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)

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

	Parented (UDPComponent *parent)

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

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

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

bool	should_send () override

size_t	get_max_packet_size () override

Protected Member Functions inherited from esphome::packet_transport::PacketTransport
void	process_ (const std::vector< 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_ ()

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

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.

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

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

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 (uint32_t timeout, std::function< void()> &&f)

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

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

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
bool	should_broadcast_ {false}

Protected Attributes inherited from esphome::packet_transport::PacketTransport
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	resend_data_ {}

const char *	name_ {}

ESPPreferenceObject	pref_ {}

std::vector< uint8_t >	encryption_key_ {}

std::vector< Sensor >	sensors_ {}

std::map< std::string, std::map< std::string, sensor::Sensor * > >	remote_sensors_ {}

std::vector< BinarySensor >	binary_sensors_ {}

std::map< std::string, std::map< std::string, binary_sensor::BinarySensor * > >	remote_binary_sensors_ {}

std::map< std::string, Provider >	providers_ {}

std::vector< uint8_t >	ping_header_ {}

std::vector< uint8_t >	header_ {}

std::vector< uint8_t >	data_ {}

std::map< const char *, uint32_t >	ping_keys_ {}

const char *	platform_name_ {""}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component.

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

uint32_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}

std::string	error_message_ {}

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

Detailed Description

Definition at line 12 of file udp_transport.h.

Member Function Documentation

◆ get_max_packet_size()

size_t esphome::udp::UDPTransport::get_max_packet_size ( )

inlineoverrideprotectedvirtual

Implements esphome::packet_transport::PacketTransport.

Definition at line 23 of file udp_transport.h.

◆ get_setup_priority()

float esphome::udp::UDPTransport::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file udp_transport.h.

◆ send_packet()

void esphome::udp::UDPTransport::send_packet ( const std::vector< uint8_t > & buf ) const

overrideprotectedvirtual

Implements esphome::packet_transport::PacketTransport.

Definition at line 34 of file udp_transport.cpp.

◆ setup()

void esphome::udp::UDPTransport::setup ( )

overridevirtual

Reimplemented from esphome::packet_transport::PacketTransport.

Definition at line 12 of file udp_transport.cpp.

◆ should_send()

bool esphome::udp::UDPTransport::should_send ( )

overrideprotectedvirtual

Reimplemented from esphome::packet_transport::PacketTransport.

Definition at line 11 of file udp_transport.cpp.

◆ update()

void esphome::udp::UDPTransport::update ( )

overridevirtual

Reimplemented from esphome::packet_transport::PacketTransport.

Definition at line 28 of file udp_transport.cpp.

Field Documentation

◆ should_broadcast_

bool esphome::udp::UDPTransport::should_broadcast_ {false}

protected

Definition at line 22 of file udp_transport.h.

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

esphome/components/udp/packet_transport/udp_transport.h
esphome/components/udp/packet_transport/udp_transport.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ get_max_packet_size()

◆ get_setup_priority()

◆ send_packet()

◆ setup()

◆ should_send()

◆ update()

Field Documentation

◆ should_broadcast_