#include <api_connection.h>

Inheritance diagram for esphome::api::APIConnection:

Data Structures
struct	APIFlags

struct	DeferredBatch

union	IteratorUnion

Public Types
using	MessageEncodeFn = void ()(const void , ProtoWriteBuffer &)

using	CalculateSizeFn = uint32_t ()(const void )

Public Member Functions
	APIConnection (std::unique_ptr< socket::Socket > socket, APIServer *parent)

virtual	~APIConnection ()

void	start ()

void	loop ()

bool	send_list_info_done ()

bool	send_binary_sensor_state (binary_sensor::BinarySensor *binary_sensor)

bool	send_cover_state (cover::Cover *cover)

void	on_cover_command_request (const CoverCommandRequest &msg) override

bool	send_fan_state (fan::Fan *fan)

void	on_fan_command_request (const FanCommandRequest &msg) override

bool	send_light_state (light::LightState *light)

void	on_light_command_request (const LightCommandRequest &msg) override

bool	send_sensor_state (sensor::Sensor *sensor)

bool	send_switch_state (switch_::Switch *a_switch)

void	on_switch_command_request (const SwitchCommandRequest &msg) override

bool	send_text_sensor_state (text_sensor::TextSensor *text_sensor)

void	set_camera_state (std::shared_ptr< camera::CameraImage > image)

void	on_camera_image_request (const CameraImageRequest &msg) override

bool	send_climate_state (climate::Climate *climate)

void	on_climate_command_request (const ClimateCommandRequest &msg) override

bool	send_number_state (number::Number *number)

void	on_number_command_request (const NumberCommandRequest &msg) override

bool	send_date_state (datetime::DateEntity *date)

void	on_date_command_request (const DateCommandRequest &msg) override

bool	send_time_state (datetime::TimeEntity *time)

void	on_time_command_request (const TimeCommandRequest &msg) override

bool	send_datetime_state (datetime::DateTimeEntity *datetime)

void	on_date_time_command_request (const DateTimeCommandRequest &msg) override

bool	send_text_state (text::Text *text)

void	on_text_command_request (const TextCommandRequest &msg) override

bool	send_select_state (select::Select *select)

void	on_select_command_request (const SelectCommandRequest &msg) override

void	on_button_command_request (const ButtonCommandRequest &msg) override

bool	send_lock_state (lock::Lock *a_lock)

void	on_lock_command_request (const LockCommandRequest &msg) override

bool	send_valve_state (valve::Valve *valve)

void	on_valve_command_request (const ValveCommandRequest &msg) override

bool	send_media_player_state (media_player::MediaPlayer *media_player)

void	on_media_player_command_request (const MediaPlayerCommandRequest &msg) override

bool	try_send_log_message (int level, const char tag, const char line, size_t message_len)

void	send_homeassistant_action (const HomeassistantActionRequest &call)

void	on_homeassistant_action_response (const HomeassistantActionResponse &msg) override

void	on_subscribe_bluetooth_le_advertisements_request (const SubscribeBluetoothLEAdvertisementsRequest &msg) override

void	on_unsubscribe_bluetooth_le_advertisements_request () override

void	on_bluetooth_device_request (const BluetoothDeviceRequest &msg) override

void	on_bluetooth_gatt_read_request (const BluetoothGATTReadRequest &msg) override

void	on_bluetooth_gatt_write_request (const BluetoothGATTWriteRequest &msg) override

void	on_bluetooth_gatt_read_descriptor_request (const BluetoothGATTReadDescriptorRequest &msg) override

void	on_bluetooth_gatt_write_descriptor_request (const BluetoothGATTWriteDescriptorRequest &msg) override

void	on_bluetooth_gatt_get_services_request (const BluetoothGATTGetServicesRequest &msg) override

void	on_bluetooth_gatt_notify_request (const BluetoothGATTNotifyRequest &msg) override

void	on_subscribe_bluetooth_connections_free_request () override

void	on_bluetooth_scanner_set_mode_request (const BluetoothScannerSetModeRequest &msg) override

void	on_bluetooth_set_connection_params_request (const BluetoothSetConnectionParamsRequest &msg) override

void	send_time_request ()

void	on_subscribe_voice_assistant_request (const SubscribeVoiceAssistantRequest &msg) override

void	on_voice_assistant_response (const VoiceAssistantResponse &msg) override

void	on_voice_assistant_event_response (const VoiceAssistantEventResponse &msg) override

void	on_voice_assistant_audio (const VoiceAssistantAudio &msg) override

void	on_voice_assistant_timer_event_response (const VoiceAssistantTimerEventResponse &msg) override

void	on_voice_assistant_announce_request (const VoiceAssistantAnnounceRequest &msg) override

void	on_voice_assistant_configuration_request (const VoiceAssistantConfigurationRequest &msg) override

void	on_voice_assistant_set_configuration (const VoiceAssistantSetConfiguration &msg) override

void	on_z_wave_proxy_frame (const ZWaveProxyFrame &msg) override

void	on_z_wave_proxy_request (const ZWaveProxyRequest &msg) override

bool	send_alarm_control_panel_state (alarm_control_panel::AlarmControlPanel *a_alarm_control_panel)

void	on_alarm_control_panel_command_request (const AlarmControlPanelCommandRequest &msg) override

bool	send_water_heater_state (water_heater::WaterHeater *water_heater)

void	on_water_heater_command_request (const WaterHeaterCommandRequest &msg) override

void	on_infrared_rf_transmit_raw_timings_request (const InfraredRFTransmitRawTimingsRequest &msg) override

void	send_infrared_rf_receive_event (const InfraredRFReceiveEvent &msg)

void	on_serial_proxy_configure_request (const SerialProxyConfigureRequest &msg) override

void	on_serial_proxy_write_request (const SerialProxyWriteRequest &msg) override

void	on_serial_proxy_set_modem_pins_request (const SerialProxySetModemPinsRequest &msg) override

void	on_serial_proxy_get_modem_pins_request (const SerialProxyGetModemPinsRequest &msg) override

void	on_serial_proxy_request (const SerialProxyRequest &msg) override

void	send_serial_proxy_data (const SerialProxyDataReceived &msg)

void	send_event (event::Event *event)

bool	send_update_state (update::UpdateEntity *update)

void	on_update_command_request (const UpdateCommandRequest &msg) override

void	on_disconnect_response () override

void	on_ping_response () override

void	on_home_assistant_state_response (const HomeAssistantStateResponse &msg) override

void	on_get_time_response (const GetTimeResponse &value) override

void	on_hello_request (const HelloRequest &msg) override

void	on_disconnect_request () override

void	on_ping_request () override

void	on_device_info_request () override

void	on_list_entities_request () override

void	on_subscribe_states_request () override

void	on_subscribe_logs_request (const SubscribeLogsRequest &msg) override

void	on_subscribe_homeassistant_services_request () override

void	on_subscribe_home_assistant_states_request () override

void	on_execute_service_request (const ExecuteServiceRequest &msg) override

void	send_execute_service_response (uint32_t call_id, bool success, StringRef error_message)

void	send_execute_service_response (uint32_t call_id, bool success, StringRef error_message, const uint8_t *response_data, size_t response_data_len)

void	on_noise_encryption_set_key_request (const NoiseEncryptionSetKeyRequest &msg) override

bool	is_authenticated () override

bool	is_connection_setup () override

bool	is_marked_for_removal () const

uint8_t	get_log_subscription_level () const

bool	client_supports_api_version (uint16_t major, uint16_t minor) const

void	on_fatal_error () override

void	on_no_setup_connection () override

template<typename T >
bool	send_message (const T &msg)

void	prepare_first_message_buffer (APIBuffer &shared_buf, size_t header_padding, size_t total_size)

void	prepare_first_message_buffer (APIBuffer &shared_buf, size_t payload_size)

bool	try_to_clear_buffer (bool log_out_of_space)

bool	send_buffer (ProtoWriteBuffer buffer, uint8_t message_type) override

const char *	get_name () const

const char *	get_peername_to (std::span< char, socket::SOCKADDR_STR_LEN > buf) const
	Get peer name (IP address) into caller-provided buffer, returns buf for convenience.

Public Member Functions inherited from esphome::api::APIServerConnectionBase
virtual void	on_siren_command_request (const SirenCommandRequest &value)

Protected Types
enum class	ActiveIterator : uint8_t { NONE , LIST_ENTITIES , INITIAL_STATE }

enum class	ConnectionState : uint8_t { WAITING_FOR_HELLO = 0 , CONNECTED = 1 , AUTHENTICATED = 2 }

using	MessageCreatorPtr = uint16_t ()(EntityBase , APIConnection *, uint32_t remaining_size)

Protected Member Functions
bool	try_to_clear_buffer_slow_ (bool log_out_of_space)

void	complete_authentication_ ()

bool	send_hello_response_ (const HelloRequest &msg)

bool	send_disconnect_response_ ()

bool	send_ping_response_ ()

bool	send_device_info_response_ ()

bool	send_noise_encryption_set_key_response_ (const NoiseEncryptionSetKeyRequest &msg)

bool	send_subscribe_bluetooth_connections_free_response_ ()

bool	send_voice_assistant_get_configuration_response_ (const VoiceAssistantConfigurationRequest &msg)

void	try_send_camera_image_ ()

void	process_state_subscriptions_ ()

bool	send_message_ (uint32_t payload_size, uint8_t message_type, MessageEncodeFn encode_fn, const void *msg)

bool	check_voice_assistant_api_connection_ () const

size_t	get_max_batch_size_ () const

void	__attribute__ ((noinline)) check_keepalive_(uint32_t now)

void	__attribute__ ((noinline)) process_active_iterator_()

void	process_iterator_batch_ (ComponentIterator &iterator)

void	destroy_active_iterator_ ()

void	begin_iterator_ (ActiveIterator type)

uint32_t	get_batch_delay_ms_ () const

bool	schedule_batch_ ()

void	process_batch_ ()

void	process_batch_multi_ (APIBuffer &shared_buf, size_t num_items, uint8_t header_padding, uint8_t footer_size) __attribute__((noinline))

void	clear_batch_ ()

uint16_t	dispatch_message_ (const DeferredBatch::BatchItem &item, uint32_t remaining_size, bool batch_first)

void	log_batch_item_ (const DeferredBatch::BatchItem &item)

bool	should_send_immediately_ (uint8_t message_type) const

bool	send_message_smart_ (EntityBase *entity, uint8_t message_type, uint8_t estimated_size, uint8_t aux_data_index=DeferredBatch::AUX_DATA_UNUSED)

bool	schedule_message_ (EntityBase *entity, uint8_t message_type, uint8_t estimated_size, uint8_t aux_data_index=DeferredBatch::AUX_DATA_UNUSED)

bool	schedule_message_front_ (EntityBase *entity, uint8_t message_type, uint8_t estimated_size)

void	log_client_ (int level, const LogString *message)

void	log_warning_ (const LogString *message, APIError err)

void	fatal_error_with_log_ (const LogString *message, APIError err)

Protected Member Functions inherited from esphome::api::APIServerConnectionBase
void	log_send_message_ (const char name, const char dump)

void	log_receive_message_ (const LogString *name, const ProtoMessage &msg)

void	log_receive_message_ (const LogString *name)

void	read_message (uint32_t msg_size, uint32_t msg_type, const uint8_t *msg_data) override

Protected Member Functions inherited from esphome::api::ProtoService
bool	check_connection_setup_ ()

bool	check_authenticated_ ()

Static Protected Member Functions
template<typename T >
static uint32_t	calc_size (const void *msg)

static void	encode_msg_noop (const void *, ProtoWriteBuffer &)

static uint16_t	encode_to_buffer (uint32_t calculated_size, MessageEncodeFn encode_fn, const void msg, APIConnection conn, uint32_t remaining_size)

template<typename T >
static uint16_t	encode_message_to_buffer (T &msg, APIConnection *conn, uint32_t remaining_size)

static uint16_t	fill_and_encode_entity_state (EntityBase entity, StateResponseProtoMessage &msg, CalculateSizeFn size_fn, MessageEncodeFn encode_fn, APIConnection conn, uint32_t remaining_size)

template<typename T >
static uint16_t	fill_and_encode_entity_state (EntityBase entity, T &msg, APIConnection conn, uint32_t remaining_size)

static uint16_t	fill_and_encode_entity_info (EntityBase entity, InfoResponseProtoMessage &msg, CalculateSizeFn size_fn, MessageEncodeFn encode_fn, APIConnection conn, uint32_t remaining_size)

template<typename T >
static uint16_t	fill_and_encode_entity_info (EntityBase entity, T &msg, APIConnection conn, uint32_t remaining_size)

static uint16_t	fill_and_encode_entity_info_with_device_class (EntityBase entity, InfoResponseProtoMessage &msg, StringRef &device_class_field, CalculateSizeFn size_fn, MessageEncodeFn encode_fn, APIConnection conn, uint32_t remaining_size)

template<typename T >
static uint16_t	fill_and_encode_entity_info_with_device_class (EntityBase entity, T &msg, StringRef &device_class_field, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_binary_sensor_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_binary_sensor_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_cover_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_cover_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_fan_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_fan_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_light_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_light_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_sensor_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_sensor_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_switch_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_switch_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_text_sensor_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_text_sensor_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_climate_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_climate_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_number_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_number_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_date_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_date_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_time_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_time_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_datetime_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_datetime_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_text_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_text_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_select_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_select_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_button_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_lock_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_lock_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_valve_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_valve_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_media_player_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_media_player_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_alarm_control_panel_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_alarm_control_panel_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_water_heater_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_water_heater_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_infrared_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_event_response (event::Event event, StringRef event_type, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_event_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_update_state (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_update_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_camera_info (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_list_info_done (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_disconnect_request (EntityBase entity, APIConnection conn, uint32_t remaining_size)

static uint16_t	try_send_ping_request (EntityBase entity, APIConnection conn, uint32_t remaining_size)

Protected Attributes
std::unique_ptr< APIFrameHelper >	helper_

std::unique_ptr< APINoiseFrameHelper >	helper_

std::unique_ptr< APIPlaintextFrameHelper >	helper_

APIServer *	parent_

union esphome::api::APIConnection::IteratorUnion	iterator_storage_

std::unique_ptr< camera::CameraImageReader >	image_reader_

uint32_t	last_traffic_

int	state_subs_at_ = -1

DeferredBatch	deferred_batch_

struct esphome::api::APIConnection::APIFlags	flags_

uint16_t	client_api_version_major_ {0}

uint16_t	client_api_version_minor_ {0}

ActiveIterator	active_iterator_ {ActiveIterator::NONE}

Static Protected Attributes
static constexpr size_t	MAX_BATCH_PACKET_SIZE = 1390

Detailed Description

Definition at line 47 of file api_connection.h.

Member Typedef Documentation

◆ CalculateSizeFn

using esphome::api::APIConnection::CalculateSizeFn = uint32_t (*)(const void *)

Definition at line 293 of file api_connection.h.

◆ MessageCreatorPtr

using esphome::api::APIConnection::MessageCreatorPtr = uint16_t (*)(EntityBase *, APIConnection *, uint32_t remaining_size)

protected

Definition at line 594 of file api_connection.h.

◆ MessageEncodeFn

using esphome::api::APIConnection::MessageEncodeFn = void (*)(const void *, ProtoWriteBuffer &)

Definition at line 291 of file api_connection.h.

Member Enumeration Documentation

◆ ActiveIterator

enum class esphome::api::APIConnection::ActiveIterator : uint8_t

strongprotected

Enumerator
NONE
LIST_ENTITIES
INITIAL_STATE

Definition at line 570 of file api_connection.h.

◆ ConnectionState

enum class esphome::api::APIConnection::ConnectionState : uint8_t

strongprotected

Enumerator
WAITING_FOR_HELLO
CONNECTED
AUTHENTICATED

Definition at line 651 of file api_connection.h.

Constructor & Destructor Documentation

◆ APIConnection()

esphome::api::APIConnection::APIConnection	(	std::unique_ptr< socket::Socket >	socket,
		APIServer *	parent )

Definition at line 108 of file api_connection.cpp.

◆ ~APIConnection()

esphome::api::APIConnection::~APIConnection ( )

virtual

Definition at line 146 of file api_connection.cpp.

Member Function Documentation

◆ attribute() [1/2]

void esphome::api::APIConnection::__attribute__ ( (noinline) )

protected

◆ attribute() [2/2]

void esphome::api::APIConnection::__attribute__ ( (noinline) )

protected

◆ begin_iterator_()

void esphome::api::APIConnection::begin_iterator_ ( ActiveIterator type )

protected

Definition at line 186 of file api_connection.cpp.

◆ calc_size()

template<typename T >

static uint32_t esphome::api::APIConnection::calc_size ( const void * msg )

inlinestaticprotected

Definition at line 365 of file api_connection.h.

◆ check_voice_assistant_api_connection_()

bool esphome::api::APIConnection::check_voice_assistant_api_connection_ ( ) const

inlineprotected

Definition at line 1209 of file api_connection.cpp.

◆ clear_batch_()

void esphome::api::APIConnection::clear_batch_ ( )

inlineprotected

Definition at line 704 of file api_connection.h.

◆ client_supports_api_version()

bool esphome::api::APIConnection::client_supports_api_version	(	uint16_t	major,
		uint16_t	minor ) const

inline

Definition at line 282 of file api_connection.h.

◆ complete_authentication_()

void esphome::api::APIConnection::complete_authentication_ ( )

protected

Definition at line 1606 of file api_connection.cpp.

◆ destroy_active_iterator_()

void esphome::api::APIConnection::destroy_active_iterator_ ( )

protected

Definition at line 172 of file api_connection.cpp.

◆ dispatch_message_()

uint16_t esphome::api::APIConnection::dispatch_message_	(	const DeferredBatch::BatchItem &	item,
		uint32_t	remaining_size,
		bool	batch_first )

protected

Definition at line 2273 of file api_connection.cpp.

◆ encode_message_to_buffer()

template<typename T >

static uint16_t esphome::api::APIConnection::encode_message_to_buffer	(	T &	msg,
		APIConnection *	conn,
		uint32_t	remaining_size )

inlinestaticprotected

Definition at line 380 of file api_connection.h.

◆ encode_msg_noop()

static void esphome::api::APIConnection::encode_msg_noop	(	const void *	,
		ProtoWriteBuffer &	)

inlinestaticprotected

Definition at line 370 of file api_connection.h.

◆ encode_to_buffer()

uint16_t esphome::api::APIConnection::encode_to_buffer	(	uint32_t	calculated_size,
		MessageEncodeFn	encode_fn,
		const void *	msg,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1998 of file api_connection.cpp.

◆ fatal_error_with_log_()

void esphome::api::APIConnection::fatal_error_with_log_	(	const LogString *	message,
		APIError	err )

inlineprotected

Definition at line 763 of file api_connection.h.

◆ fill_and_encode_entity_info() [1/2]

uint16_t esphome::api::APIConnection::fill_and_encode_entity_info	(	EntityBase *	entity,
		InfoResponseProtoMessage &	msg,
		CalculateSizeFn	size_fn,
		MessageEncodeFn	encode_fn,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 369 of file api_connection.cpp.

◆ fill_and_encode_entity_info() [2/2]

template<typename T >

static uint16_t esphome::api::APIConnection::fill_and_encode_entity_info	(	EntityBase *	entity,
		T &	msg,
		APIConnection *	conn,
		uint32_t	remaining_size )

inlinestaticprotected

Definition at line 407 of file api_connection.h.

◆ fill_and_encode_entity_info_with_device_class() [1/2]

uint16_t esphome::api::APIConnection::fill_and_encode_entity_info_with_device_class	(	EntityBase *	entity,
		InfoResponseProtoMessage &	msg,
		StringRef &	device_class_field,
		CalculateSizeFn	size_fn,
		MessageEncodeFn	encode_fn,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 402 of file api_connection.cpp.

◆ fill_and_encode_entity_info_with_device_class() [2/2]

template<typename T >

static uint16_t esphome::api::APIConnection::fill_and_encode_entity_info_with_device_class	(	EntityBase *	entity,
		T &	msg,
		StringRef &	device_class_field,
		APIConnection *	conn,
		uint32_t	remaining_size )

inlinestaticprotected

Definition at line 420 of file api_connection.h.

◆ fill_and_encode_entity_state() [1/2]

uint16_t esphome::api::APIConnection::fill_and_encode_entity_state	(	EntityBase *	entity,
		StateResponseProtoMessage &	msg,
		CalculateSizeFn	size_fn,
		MessageEncodeFn	encode_fn,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 359 of file api_connection.cpp.

◆ fill_and_encode_entity_state() [2/2]

template<typename T >

static uint16_t esphome::api::APIConnection::fill_and_encode_entity_state	(	EntityBase *	entity,
		T &	msg,
		APIConnection *	conn,
		uint32_t	remaining_size )

inlinestaticprotected

Definition at line 395 of file api_connection.h.

◆ get_batch_delay_ms_()

uint32_t esphome::api::APIConnection::get_batch_delay_ms_ ( ) const

protected

Definition at line 131 of file api_connection.cpp.

◆ get_log_subscription_level()

uint8_t esphome::api::APIConnection::get_log_subscription_level ( ) const

inline

Definition at line 279 of file api_connection.h.

◆ get_max_batch_size_()

size_t esphome::api::APIConnection::get_max_batch_size_ ( ) const

inlineprotected

Definition at line 435 of file api_connection.h.

◆ get_name()

const char * esphome::api::APIConnection::get_name ( ) const

inline

Definition at line 329 of file api_connection.h.

◆ get_peername_to()

const char * esphome::api::APIConnection::get_peername_to ( std::span< char, socket::SOCKADDR_STR_LEN > buf ) const

inline

Get peer name (IP address) into caller-provided buffer, returns buf for convenience.

Definition at line 331 of file api_connection.h.

◆ is_authenticated()

bool esphome::api::APIConnection::is_authenticated ( )

inlineoverridevirtual

Implements esphome::api::ProtoService.

Definition at line 271 of file api_connection.h.

◆ is_connection_setup()

bool esphome::api::APIConnection::is_connection_setup ( )

inlineoverridevirtual

Implements esphome::api::ProtoService.

Definition at line 274 of file api_connection.h.

◆ is_marked_for_removal()

bool esphome::api::APIConnection::is_marked_for_removal ( ) const

inline

Definition at line 278 of file api_connection.h.

◆ log_batch_item_()

void esphome::api::APIConnection::log_batch_item_ ( const DeferredBatch::BatchItem & item )

inlineprotected

Definition at line 714 of file api_connection.h.

◆ log_client_()

void esphome::api::APIConnection::log_client_	(	int	level,
		const LogString *	message )

protected

Definition at line 2434 of file api_connection.cpp.

◆ log_warning_()

void esphome::api::APIConnection::log_warning_	(	const LogString *	message,
		APIError	err )

protected

Definition at line 2440 of file api_connection.cpp.

◆ loop()

void esphome::api::APIConnection::loop ( )

Definition at line 198 of file api_connection.cpp.

◆ on_alarm_control_panel_command_request()

void esphome::api::APIConnection::on_alarm_control_panel_command_request ( const AlarmControlPanelCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1341 of file api_connection.cpp.

◆ on_bluetooth_device_request()

void esphome::api::APIConnection::on_bluetooth_device_request ( const BluetoothDeviceRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1166 of file api_connection.cpp.

◆ on_bluetooth_gatt_get_services_request()

void esphome::api::APIConnection::on_bluetooth_gatt_get_services_request ( const BluetoothGATTGetServicesRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1181 of file api_connection.cpp.

◆ on_bluetooth_gatt_notify_request()

void esphome::api::APIConnection::on_bluetooth_gatt_notify_request ( const BluetoothGATTNotifyRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1185 of file api_connection.cpp.

◆ on_bluetooth_gatt_read_descriptor_request()

void esphome::api::APIConnection::on_bluetooth_gatt_read_descriptor_request ( const BluetoothGATTReadDescriptorRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1175 of file api_connection.cpp.

◆ on_bluetooth_gatt_read_request()

void esphome::api::APIConnection::on_bluetooth_gatt_read_request ( const BluetoothGATTReadRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1169 of file api_connection.cpp.

◆ on_bluetooth_gatt_write_descriptor_request()

void esphome::api::APIConnection::on_bluetooth_gatt_write_descriptor_request ( const BluetoothGATTWriteDescriptorRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1178 of file api_connection.cpp.

◆ on_bluetooth_gatt_write_request()

void esphome::api::APIConnection::on_bluetooth_gatt_write_request ( const BluetoothGATTWriteRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1172 of file api_connection.cpp.

◆ on_bluetooth_scanner_set_mode_request()

void esphome::api::APIConnection::on_bluetooth_scanner_set_mode_request ( const BluetoothScannerSetModeRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1199 of file api_connection.cpp.

◆ on_bluetooth_set_connection_params_request()

void esphome::api::APIConnection::on_bluetooth_set_connection_params_request ( const BluetoothSetConnectionParamsRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1203 of file api_connection.cpp.

◆ on_button_command_request()

void esphome::api::APIConnection::on_button_command_request ( const ButtonCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 934 of file api_connection.cpp.

◆ on_camera_image_request()

void esphome::api::APIConnection::on_camera_image_request ( const CameraImageRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1107 of file api_connection.cpp.

◆ on_climate_command_request()

void esphome::api::APIConnection::on_climate_command_request ( const ClimateCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 740 of file api_connection.cpp.

◆ on_cover_command_request()

void esphome::api::APIConnection::on_cover_command_request ( const CoverCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 458 of file api_connection.cpp.

◆ on_date_command_request()

void esphome::api::APIConnection::on_date_command_request ( const DateCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 814 of file api_connection.cpp.

◆ on_date_time_command_request()

void esphome::api::APIConnection::on_date_time_command_request ( const DateTimeCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 866 of file api_connection.cpp.

◆ on_device_info_request()

void esphome::api::APIConnection::on_device_info_request ( )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1816 of file api_connection.cpp.

◆ on_disconnect_request()

void esphome::api::APIConnection::on_disconnect_request ( )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1806 of file api_connection.cpp.

◆ on_disconnect_response()

void esphome::api::APIConnection::on_disconnect_response ( )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 353 of file api_connection.cpp.

◆ on_execute_service_request()

void esphome::api::APIConnection::on_execute_service_request ( const ExecuteServiceRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1854 of file api_connection.cpp.

◆ on_fan_command_request()

void esphome::api::APIConnection::on_fan_command_request ( const FanCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 501 of file api_connection.cpp.

◆ on_fatal_error()

void esphome::api::APIConnection::on_fatal_error ( )

overridevirtual

Implements esphome::api::ProtoService.

Definition at line 2065 of file api_connection.cpp.

◆ on_get_time_response()

void esphome::api::APIConnection::on_get_time_response ( const GetTimeResponse & value )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1123 of file api_connection.cpp.

◆ on_hello_request()

void esphome::api::APIConnection::on_hello_request ( const HelloRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1801 of file api_connection.cpp.

◆ on_home_assistant_state_response()

void esphome::api::APIConnection::on_home_assistant_state_response ( const HomeAssistantStateResponse & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1823 of file api_connection.cpp.

◆ on_homeassistant_action_response()

void esphome::api::APIConnection::on_homeassistant_action_response ( const HomeassistantActionResponse & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1917 of file api_connection.cpp.

◆ on_infrared_rf_transmit_raw_timings_request()

void esphome::api::APIConnection::on_infrared_rf_transmit_raw_timings_request ( const InfraredRFTransmitRawTimingsRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1445 of file api_connection.cpp.

◆ on_light_command_request()

void esphome::api::APIConnection::on_light_command_request ( const LightCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 569 of file api_connection.cpp.

◆ on_list_entities_request()

void esphome::api::APIConnection::on_list_entities_request ( )

inlineoverridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 231 of file api_connection.h.

◆ on_lock_command_request()

void esphome::api::APIConnection::on_lock_command_request ( const LockCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 960 of file api_connection.cpp.

◆ on_media_player_command_request()

void esphome::api::APIConnection::on_media_player_command_request ( const MediaPlayerCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1040 of file api_connection.cpp.

◆ on_no_setup_connection()

void esphome::api::APIConnection::on_no_setup_connection ( )

overridevirtual

Implements esphome::api::ProtoService.

Definition at line 2061 of file api_connection.cpp.

◆ on_noise_encryption_set_key_request()

void esphome::api::APIConnection::on_noise_encryption_set_key_request ( const NoiseEncryptionSetKeyRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1951 of file api_connection.cpp.

◆ on_number_command_request()

void esphome::api::APIConnection::on_number_command_request ( const NumberCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 789 of file api_connection.cpp.

◆ on_ping_request()

void esphome::api::APIConnection::on_ping_request ( )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1811 of file api_connection.cpp.

◆ on_ping_response()

void esphome::api::APIConnection::on_ping_response ( )

inlineoverridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 217 of file api_connection.h.

◆ on_select_command_request()

void esphome::api::APIConnection::on_select_command_request ( const SelectCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 921 of file api_connection.cpp.

◆ on_serial_proxy_configure_request()

void esphome::api::APIConnection::on_serial_proxy_configure_request ( const SerialProxyConfigureRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1461 of file api_connection.cpp.

◆ on_serial_proxy_get_modem_pins_request()

void esphome::api::APIConnection::on_serial_proxy_get_modem_pins_request ( const SerialProxyGetModemPinsRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1490 of file api_connection.cpp.

◆ on_serial_proxy_request()

void esphome::api::APIConnection::on_serial_proxy_request ( const SerialProxyRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1502 of file api_connection.cpp.

◆ on_serial_proxy_set_modem_pins_request()

void esphome::api::APIConnection::on_serial_proxy_set_modem_pins_request ( const SerialProxySetModemPinsRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1481 of file api_connection.cpp.

◆ on_serial_proxy_write_request()

void esphome::api::APIConnection::on_serial_proxy_write_request ( const SerialProxyWriteRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1472 of file api_connection.cpp.

◆ on_subscribe_bluetooth_connections_free_request()

void esphome::api::APIConnection::on_subscribe_bluetooth_connections_free_request ( )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1193 of file api_connection.cpp.

◆ on_subscribe_bluetooth_le_advertisements_request()

void esphome::api::APIConnection::on_subscribe_bluetooth_le_advertisements_request ( const SubscribeBluetoothLEAdvertisementsRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1159 of file api_connection.cpp.

◆ on_subscribe_home_assistant_states_request()

void esphome::api::APIConnection::on_subscribe_home_assistant_states_request ( )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1958 of file api_connection.cpp.

◆ on_subscribe_homeassistant_services_request()

void esphome::api::APIConnection::on_subscribe_homeassistant_services_request ( )

inlineoverridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 252 of file api_connection.h.

◆ on_subscribe_logs_request()

void esphome::api::APIConnection::on_subscribe_logs_request ( const SubscribeLogsRequest & msg )

inlineoverridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 240 of file api_connection.h.

◆ on_subscribe_states_request()

void esphome::api::APIConnection::on_subscribe_states_request ( )

inlineoverridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 232 of file api_connection.h.

◆ on_subscribe_voice_assistant_request()

void esphome::api::APIConnection::on_subscribe_voice_assistant_request ( const SubscribeVoiceAssistantRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1214 of file api_connection.cpp.

◆ on_switch_command_request()

void esphome::api::APIConnection::on_switch_command_request ( const SwitchCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 644 of file api_connection.cpp.

◆ on_text_command_request()

void esphome::api::APIConnection::on_text_command_request ( const TextCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 895 of file api_connection.cpp.

◆ on_time_command_request()

void esphome::api::APIConnection::on_time_command_request ( const TimeCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 839 of file api_connection.cpp.

◆ on_unsubscribe_bluetooth_le_advertisements_request()

void esphome::api::APIConnection::on_unsubscribe_bluetooth_le_advertisements_request ( )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1163 of file api_connection.cpp.

◆ on_update_command_request()

void esphome::api::APIConnection::on_update_command_request ( const UpdateCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1579 of file api_connection.cpp.

◆ on_valve_command_request()

void esphome::api::APIConnection::on_valve_command_request ( const ValveCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 997 of file api_connection.cpp.

◆ on_voice_assistant_announce_request()

void esphome::api::APIConnection::on_voice_assistant_announce_request ( const VoiceAssistantAnnounceRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1254 of file api_connection.cpp.

◆ on_voice_assistant_audio()

void esphome::api::APIConnection::on_voice_assistant_audio ( const VoiceAssistantAudio & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1243 of file api_connection.cpp.

◆ on_voice_assistant_configuration_request()

void esphome::api::APIConnection::on_voice_assistant_configuration_request ( const VoiceAssistantConfigurationRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1297 of file api_connection.cpp.

◆ on_voice_assistant_event_response()

void esphome::api::APIConnection::on_voice_assistant_event_response ( const VoiceAssistantEventResponse & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1238 of file api_connection.cpp.

◆ on_voice_assistant_response()

void esphome::api::APIConnection::on_voice_assistant_response ( const VoiceAssistantResponse & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1219 of file api_connection.cpp.

◆ on_voice_assistant_set_configuration()

void esphome::api::APIConnection::on_voice_assistant_set_configuration ( const VoiceAssistantSetConfiguration & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1303 of file api_connection.cpp.

◆ on_voice_assistant_timer_event_response()

void esphome::api::APIConnection::on_voice_assistant_timer_event_response ( const VoiceAssistantTimerEventResponse & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1248 of file api_connection.cpp.

◆ on_water_heater_command_request()

void esphome::api::APIConnection::on_water_heater_command_request ( const WaterHeaterCommandRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1400 of file api_connection.cpp.

◆ on_z_wave_proxy_frame()

void esphome::api::APIConnection::on_z_wave_proxy_frame ( const ZWaveProxyFrame & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1311 of file api_connection.cpp.

◆ on_z_wave_proxy_request()

void esphome::api::APIConnection::on_z_wave_proxy_request ( const ZWaveProxyRequest & msg )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 1315 of file api_connection.cpp.

◆ prepare_first_message_buffer() [1/2]

void esphome::api::APIConnection::prepare_first_message_buffer	(	APIBuffer &	shared_buf,
		size_t	header_padding,
		size_t	total_size )

inline

Definition at line 303 of file api_connection.h.

◆ prepare_first_message_buffer() [2/2]

void esphome::api::APIConnection::prepare_first_message_buffer	(	APIBuffer &	shared_buf,
		size_t	payload_size )

inline

Definition at line 314 of file api_connection.h.

◆ process_batch_()

void esphome::api::APIConnection::process_batch_ ( )

protected

Definition at line 2129 of file api_connection.cpp.

◆ process_batch_multi_()

void esphome::api::APIConnection::process_batch_multi_	(	APIBuffer &	shared_buf,
		size_t	num_items,
		uint8_t	header_padding,
		uint8_t	footer_size )

protected

Definition at line 2187 of file api_connection.cpp.

◆ process_iterator_batch_()

void esphome::api::APIConnection::process_iterator_batch_ ( ComponentIterator & iterator )

protected

Definition at line 330 of file api_connection.cpp.

◆ process_state_subscriptions_()

void esphome::api::APIConnection::process_state_subscriptions_ ( )

protected

Definition at line 2413 of file api_connection.cpp.

◆ schedule_batch_()

bool esphome::api::APIConnection::schedule_batch_ ( )

protected

Definition at line 2121 of file api_connection.cpp.

◆ schedule_message_()

bool esphome::api::APIConnection::schedule_message_	(	EntityBase *	entity,
		uint8_t	message_type,
		uint8_t	estimated_size,
		uint8_t	aux_data_index = DeferredBatch::AUX_DATA_UNUSED )

inlineprotected

Definition at line 746 of file api_connection.h.

◆ schedule_message_front_()

bool esphome::api::APIConnection::schedule_message_front_	(	EntityBase *	entity,
		uint8_t	message_type,
		uint8_t	estimated_size )

inlineprotected

Definition at line 753 of file api_connection.h.

◆ send_alarm_control_panel_state()

bool esphome::api::APIConnection::send_alarm_control_panel_state ( alarm_control_panel::AlarmControlPanel * a_alarm_control_panel )

Definition at line 1321 of file api_connection.cpp.

◆ send_binary_sensor_state()

bool esphome::api::APIConnection::send_binary_sensor_state ( binary_sensor::BinarySensor * binary_sensor )

Definition at line 413 of file api_connection.cpp.

◆ send_buffer()

bool esphome::api::APIConnection::send_buffer	(	ProtoWriteBuffer	buffer,
		uint8_t	message_type )

overridevirtual

Implements esphome::api::ProtoService.

Definition at line 2041 of file api_connection.cpp.

◆ send_climate_state()

bool esphome::api::APIConnection::send_climate_state ( climate::Climate * climate )

Definition at line 676 of file api_connection.cpp.

◆ send_cover_state()

bool esphome::api::APIConnection::send_cover_state ( cover::Cover * cover )

Definition at line 435 of file api_connection.cpp.

◆ send_date_state()

bool esphome::api::APIConnection::send_date_state ( datetime::DateEntity * date )

Definition at line 797 of file api_connection.cpp.

◆ send_datetime_state()

bool esphome::api::APIConnection::send_datetime_state ( datetime::DateTimeEntity * datetime )

Definition at line 847 of file api_connection.cpp.

◆ send_device_info_response_()

bool esphome::api::APIConnection::send_device_info_response_ ( )

protected

Definition at line 1668 of file api_connection.cpp.

◆ send_disconnect_response_()

bool esphome::api::APIConnection::send_disconnect_response_ ( )

protected

Definition at line 344 of file api_connection.cpp.

◆ send_event()

void esphome::api::APIConnection::send_event ( event::Event * event )

Definition at line 1425 of file api_connection.cpp.

◆ send_execute_service_response() [1/2]

void esphome::api::APIConnection::send_execute_service_response	(	uint32_t	call_id,
		bool	success,
		StringRef	error_message )

Definition at line 1894 of file api_connection.cpp.

◆ send_execute_service_response() [2/2]

void esphome::api::APIConnection::send_execute_service_response	(	uint32_t	call_id,
		bool	success,
		StringRef	error_message,
		const uint8_t *	response_data,
		size_t	response_data_len )

Definition at line 1902 of file api_connection.cpp.

◆ send_fan_state()

bool esphome::api::APIConnection::send_fan_state ( fan::Fan * fan )

Definition at line 471 of file api_connection.cpp.

◆ send_hello_response_()

bool esphome::api::APIConnection::send_hello_response_ ( const HelloRequest & msg )

protected

Definition at line 1635 of file api_connection.cpp.

◆ send_homeassistant_action()

void esphome::api::APIConnection::send_homeassistant_action ( const HomeassistantActionRequest & call )

inline

Definition at line 135 of file api_connection.h.

◆ send_infrared_rf_receive_event()

void esphome::api::APIConnection::send_infrared_rf_receive_event ( const InfraredRFReceiveEvent & msg )

Definition at line 1457 of file api_connection.cpp.

◆ send_light_state()

bool esphome::api::APIConnection::send_light_state ( light::LightState * light )

Definition at line 520 of file api_connection.cpp.

◆ send_list_info_done()

bool esphome::api::APIConnection::send_list_info_done ( )

inline

Definition at line 57 of file api_connection.h.

◆ send_lock_state()

bool esphome::api::APIConnection::send_lock_state ( lock::Lock * a_lock )

Definition at line 941 of file api_connection.cpp.

◆ send_media_player_state()

bool esphome::api::APIConnection::send_media_player_state ( media_player::MediaPlayer * media_player )

Definition at line 1008 of file api_connection.cpp.

◆ send_message()

template<typename T >

bool esphome::api::APIConnection::send_message ( const T & msg )

inline

Definition at line 295 of file api_connection.h.

◆ send_message_()

bool esphome::api::APIConnection::send_message_	(	uint32_t	payload_size,
		uint8_t	message_type,
		MessageEncodeFn	encode_fn,
		const void *	msg )

protected

Definition at line 1974 of file api_connection.cpp.

◆ send_message_smart_()

bool esphome::api::APIConnection::send_message_smart_	(	EntityBase *	entity,
		uint8_t	message_type,
		uint8_t	estimated_size,
		uint8_t	aux_data_index = DeferredBatch::AUX_DATA_UNUSED )

protected

Definition at line 2104 of file api_connection.cpp.

◆ send_noise_encryption_set_key_response_()

bool esphome::api::APIConnection::send_noise_encryption_set_key_response_ ( const NoiseEncryptionSetKeyRequest & msg )

protected

Definition at line 1930 of file api_connection.cpp.

◆ send_number_state()

bool esphome::api::APIConnection::send_number_state ( number::Number * number )

Definition at line 767 of file api_connection.cpp.

◆ send_ping_response_()

bool esphome::api::APIConnection::send_ping_response_ ( )

protected

Definition at line 1663 of file api_connection.cpp.

◆ send_select_state()

bool esphome::api::APIConnection::send_select_state ( select::Select * select )

Definition at line 903 of file api_connection.cpp.

◆ send_sensor_state()

bool esphome::api::APIConnection::send_sensor_state ( sensor::Sensor * sensor )

Definition at line 603 of file api_connection.cpp.

◆ send_serial_proxy_data()

void esphome::api::APIConnection::send_serial_proxy_data ( const SerialProxyDataReceived & msg )

Definition at line 1540 of file api_connection.cpp.

◆ send_subscribe_bluetooth_connections_free_response_()

bool esphome::api::APIConnection::send_subscribe_bluetooth_connections_free_response_ ( )

protected

Definition at line 1189 of file api_connection.cpp.

◆ send_switch_state()

bool esphome::api::APIConnection::send_switch_state ( switch_::Switch * a_switch )

Definition at line 627 of file api_connection.cpp.

◆ send_text_sensor_state()

bool esphome::api::APIConnection::send_text_sensor_state ( text_sensor::TextSensor * text_sensor )

Definition at line 656 of file api_connection.cpp.

◆ send_text_state()

bool esphome::api::APIConnection::send_text_state ( text::Text * text )

Definition at line 874 of file api_connection.cpp.

◆ send_time_request()

void esphome::api::APIConnection::send_time_request ( )

inline

Definition at line 161 of file api_connection.h.

◆ send_time_state()

bool esphome::api::APIConnection::send_time_state ( datetime::TimeEntity * time )

Definition at line 822 of file api_connection.cpp.

◆ send_update_state()

bool esphome::api::APIConnection::send_update_state ( update::UpdateEntity * update )

Definition at line 1553 of file api_connection.cpp.

◆ send_valve_state()

bool esphome::api::APIConnection::send_valve_state ( valve::Valve * valve )

Definition at line 978 of file api_connection.cpp.

◆ send_voice_assistant_get_configuration_response_()

bool esphome::api::APIConnection::send_voice_assistant_get_configuration_response_ ( const VoiceAssistantConfigurationRequest & msg )

protected

Definition at line 1260 of file api_connection.cpp.

◆ send_water_heater_state()

bool esphome::api::APIConnection::send_water_heater_state ( water_heater::WaterHeater * water_heater )

Definition at line 1372 of file api_connection.cpp.

◆ set_camera_state()

void esphome::api::APIConnection::set_camera_state ( std::shared_ptr< camera::CameraImage > image )

Definition at line 1089 of file api_connection.cpp.

◆ should_send_immediately_()

bool esphome::api::APIConnection::should_send_immediately_ ( uint8_t message_type ) const

inlineprotected

Definition at line 728 of file api_connection.h.

◆ start()

void esphome::api::APIConnection::start ( )

Definition at line 133 of file api_connection.cpp.

◆ try_send_alarm_control_panel_info()

uint16_t esphome::api::APIConnection::try_send_alarm_control_panel_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1332 of file api_connection.cpp.

◆ try_send_alarm_control_panel_state()

uint16_t esphome::api::APIConnection::try_send_alarm_control_panel_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1325 of file api_connection.cpp.

◆ try_send_binary_sensor_info()

uint16_t esphome::api::APIConnection::try_send_binary_sensor_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 426 of file api_connection.cpp.

◆ try_send_binary_sensor_state()

uint16_t esphome::api::APIConnection::try_send_binary_sensor_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 418 of file api_connection.cpp.

◆ try_send_button_info()

uint16_t esphome::api::APIConnection::try_send_button_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 929 of file api_connection.cpp.

◆ try_send_camera_image_()

void esphome::api::APIConnection::try_send_camera_image_ ( )

protected

Definition at line 1059 of file api_connection.cpp.

◆ try_send_camera_info()

uint16_t esphome::api::APIConnection::try_send_camera_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1102 of file api_connection.cpp.

◆ try_send_climate_info()

uint16_t esphome::api::APIConnection::try_send_climate_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 713 of file api_connection.cpp.

◆ try_send_climate_state()

uint16_t esphome::api::APIConnection::try_send_climate_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 679 of file api_connection.cpp.

◆ try_send_cover_info()

uint16_t esphome::api::APIConnection::try_send_cover_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 448 of file api_connection.cpp.

◆ try_send_cover_state()

uint16_t esphome::api::APIConnection::try_send_cover_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 438 of file api_connection.cpp.

◆ try_send_date_info()

uint16_t esphome::api::APIConnection::try_send_date_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 809 of file api_connection.cpp.

◆ try_send_date_state()

uint16_t esphome::api::APIConnection::try_send_date_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 800 of file api_connection.cpp.

◆ try_send_datetime_info()

uint16_t esphome::api::APIConnection::try_send_datetime_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 861 of file api_connection.cpp.

◆ try_send_datetime_state()

uint16_t esphome::api::APIConnection::try_send_datetime_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 851 of file api_connection.cpp.

◆ try_send_disconnect_request()

uint16_t esphome::api::APIConnection::try_send_disconnect_request	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 2402 of file api_connection.cpp.

◆ try_send_event_info()

uint16_t esphome::api::APIConnection::try_send_event_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1436 of file api_connection.cpp.

◆ try_send_event_response()

uint16_t esphome::api::APIConnection::try_send_event_response	(	event::Event *	event,
		StringRef	event_type,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1429 of file api_connection.cpp.

◆ try_send_fan_info()

uint16_t esphome::api::APIConnection::try_send_fan_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 490 of file api_connection.cpp.

◆ try_send_fan_state()

uint16_t esphome::api::APIConnection::try_send_fan_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 474 of file api_connection.cpp.

◆ try_send_infrared_info()

uint16_t esphome::api::APIConnection::try_send_infrared_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1544 of file api_connection.cpp.

◆ try_send_light_info()

uint16_t esphome::api::APIConnection::try_send_light_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 544 of file api_connection.cpp.

◆ try_send_light_state()

uint16_t esphome::api::APIConnection::try_send_light_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 523 of file api_connection.cpp.

◆ try_send_list_info_done()

uint16_t esphome::api::APIConnection::try_send_list_info_done	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 2397 of file api_connection.cpp.

◆ try_send_lock_info()

uint16_t esphome::api::APIConnection::try_send_lock_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 952 of file api_connection.cpp.

◆ try_send_lock_state()

uint16_t esphome::api::APIConnection::try_send_lock_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 945 of file api_connection.cpp.

◆ try_send_log_message()

bool esphome::api::APIConnection::try_send_log_message	(	int	level,
		const char *	tag,
		const char *	line,
		size_t	message_len )

Definition at line 1599 of file api_connection.cpp.

◆ try_send_media_player_info()

uint16_t esphome::api::APIConnection::try_send_media_player_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1023 of file api_connection.cpp.

◆ try_send_media_player_state()

uint16_t esphome::api::APIConnection::try_send_media_player_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1012 of file api_connection.cpp.

◆ try_send_number_info()

uint16_t esphome::api::APIConnection::try_send_number_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 779 of file api_connection.cpp.

◆ try_send_number_state()

uint16_t esphome::api::APIConnection::try_send_number_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 771 of file api_connection.cpp.

◆ try_send_ping_request()

uint16_t esphome::api::APIConnection::try_send_ping_request	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 2407 of file api_connection.cpp.

◆ try_send_select_info()

uint16_t esphome::api::APIConnection::try_send_select_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 915 of file api_connection.cpp.

◆ try_send_select_state()

uint16_t esphome::api::APIConnection::try_send_select_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 907 of file api_connection.cpp.

◆ try_send_sensor_info()

uint16_t esphome::api::APIConnection::try_send_sensor_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 615 of file api_connection.cpp.

◆ try_send_sensor_state()

uint16_t esphome::api::APIConnection::try_send_sensor_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 607 of file api_connection.cpp.

◆ try_send_switch_info()

uint16_t esphome::api::APIConnection::try_send_switch_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 638 of file api_connection.cpp.

◆ try_send_switch_state()

uint16_t esphome::api::APIConnection::try_send_switch_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 631 of file api_connection.cpp.

◆ try_send_text_info()

uint16_t esphome::api::APIConnection::try_send_text_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 886 of file api_connection.cpp.

◆ try_send_text_sensor_info()

uint16_t esphome::api::APIConnection::try_send_text_sensor_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 668 of file api_connection.cpp.

◆ try_send_text_sensor_state()

uint16_t esphome::api::APIConnection::try_send_text_sensor_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 661 of file api_connection.cpp.

◆ try_send_text_state()

uint16_t esphome::api::APIConnection::try_send_text_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 878 of file api_connection.cpp.

◆ try_send_time_info()

uint16_t esphome::api::APIConnection::try_send_time_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 834 of file api_connection.cpp.

◆ try_send_time_state()

uint16_t esphome::api::APIConnection::try_send_time_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 825 of file api_connection.cpp.

◆ try_send_update_info()

uint16_t esphome::api::APIConnection::try_send_update_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1574 of file api_connection.cpp.

◆ try_send_update_state()

uint16_t esphome::api::APIConnection::try_send_update_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1556 of file api_connection.cpp.

◆ try_send_valve_info()

uint16_t esphome::api::APIConnection::try_send_valve_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 988 of file api_connection.cpp.

◆ try_send_valve_state()

uint16_t esphome::api::APIConnection::try_send_valve_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 981 of file api_connection.cpp.

◆ try_send_water_heater_info()

uint16_t esphome::api::APIConnection::try_send_water_heater_info	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1388 of file api_connection.cpp.

◆ try_send_water_heater_state()

uint16_t esphome::api::APIConnection::try_send_water_heater_state	(	EntityBase *	entity,
		APIConnection *	conn,
		uint32_t	remaining_size )

staticprotected

Definition at line 1376 of file api_connection.cpp.

◆ try_to_clear_buffer()

bool esphome::api::APIConnection::try_to_clear_buffer ( bool log_out_of_space )

inline

Definition at line 320 of file api_connection.h.

◆ try_to_clear_buffer_slow_()

bool esphome::api::APIConnection::try_to_clear_buffer_slow_ ( bool log_out_of_space )

protected

Definition at line 1960 of file api_connection.cpp.

Field Documentation

◆ active_iterator_

ActiveIterator esphome::api::APIConnection::active_iterator_ {ActiveIterator::NONE}

protected

Definition at line 683 of file api_connection.h.

◆ client_api_version_major_

uint16_t esphome::api::APIConnection::client_api_version_major_ {0}

protected

Definition at line 680 of file api_connection.h.

◆ client_api_version_minor_

uint16_t esphome::api::APIConnection::client_api_version_minor_ {0}

protected

Definition at line 681 of file api_connection.h.

◆ deferred_batch_

DeferredBatch esphome::api::APIConnection::deferred_batch_

protected

Definition at line 648 of file api_connection.h.

◆ flags_

struct esphome::api::APIConnection::APIFlags esphome::api::APIConnection::flags_

protected

◆ helper_ [1/3]

std::unique_ptr<APIFrameHelper> esphome::api::APIConnection::helper_

protected

Definition at line 559 of file api_connection.h.

◆ helper_ [2/3]

std::unique_ptr<APINoiseFrameHelper> esphome::api::APIConnection::helper_

protected

Definition at line 561 of file api_connection.h.

◆ helper_ [3/3]

std::unique_ptr<APIPlaintextFrameHelper> esphome::api::APIConnection::helper_

protected

Definition at line 563 of file api_connection.h.

◆ image_reader_

std::unique_ptr<camera::CameraImageReader> esphome::api::APIConnection::image_reader_

protected

Definition at line 584 of file api_connection.h.

◆ iterator_storage_

union esphome::api::APIConnection::IteratorUnion esphome::api::APIConnection::iterator_storage_

protected

◆ last_traffic_

uint32_t esphome::api::APIConnection::last_traffic_

protected

Definition at line 588 of file api_connection.h.

◆ MAX_BATCH_PACKET_SIZE

size_t esphome::api::APIConnection::MAX_BATCH_PACKET_SIZE = 1390

staticconstexprprotected

Definition at line 698 of file api_connection.h.

◆ parent_

APIServer* esphome::api::APIConnection::parent_

protected

Definition at line 565 of file api_connection.h.

◆ state_subs_at_

int esphome::api::APIConnection::state_subs_at_ = -1

protected

Definition at line 590 of file api_connection.h.

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

esphome/components/api/api_connection.h
esphome/components/api/api_connection.cpp

Data Structures

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CalculateSizeFn

◆ MessageCreatorPtr

◆ MessageEncodeFn

Member Enumeration Documentation

◆ ActiveIterator

◆ ConnectionState

Constructor & Destructor Documentation

◆ APIConnection()

◆ ~APIConnection()

Member Function Documentation

◆ __attribute__() [1/2]

◆ __attribute__() [2/2]

◆ begin_iterator_()

◆ calc_size()

◆ check_voice_assistant_api_connection_()

◆ clear_batch_()

◆ client_supports_api_version()

◆ complete_authentication_()

◆ destroy_active_iterator_()

◆ dispatch_message_()

◆ encode_message_to_buffer()

◆ encode_msg_noop()

◆ encode_to_buffer()

◆ fatal_error_with_log_()

◆ fill_and_encode_entity_info() [1/2]

◆ fill_and_encode_entity_info() [2/2]

◆ fill_and_encode_entity_info_with_device_class() [1/2]

◆ fill_and_encode_entity_info_with_device_class() [2/2]

◆ fill_and_encode_entity_state() [1/2]

◆ fill_and_encode_entity_state() [2/2]

◆ get_batch_delay_ms_()

◆ get_log_subscription_level()

◆ get_max_batch_size_()

◆ get_name()

◆ get_peername_to()

◆ is_authenticated()

◆ is_connection_setup()

◆ is_marked_for_removal()

◆ log_batch_item_()

◆ log_client_()

◆ log_warning_()

◆ loop()

◆ on_alarm_control_panel_command_request()

◆ on_bluetooth_device_request()

◆ on_bluetooth_gatt_get_services_request()

◆ on_bluetooth_gatt_notify_request()

◆ on_bluetooth_gatt_read_descriptor_request()

◆ on_bluetooth_gatt_read_request()

◆ on_bluetooth_gatt_write_descriptor_request()

◆ on_bluetooth_gatt_write_request()

◆ on_bluetooth_scanner_set_mode_request()

◆ on_bluetooth_set_connection_params_request()

◆ on_button_command_request()

◆ on_camera_image_request()

◆ on_climate_command_request()

◆ on_cover_command_request()

◆ on_date_command_request()

◆ on_date_time_command_request()

◆ on_device_info_request()

◆ on_disconnect_request()

◆ on_disconnect_response()

◆ on_execute_service_request()

◆ on_fan_command_request()

◆ on_fatal_error()

◆ on_get_time_response()

◆ on_hello_request()

◆ on_home_assistant_state_response()

◆ on_homeassistant_action_response()

◆ on_infrared_rf_transmit_raw_timings_request()

◆ on_light_command_request()

◆ attribute() [1/2]

◆ attribute() [2/2]