#include <api_connection.h>

Inheritance diagram for esphome::api::APIConnection:

Data Structures
struct	APIFlags

struct	DeferredBatch

class	MessageCreator

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	cover_command (const CoverCommandRequest &msg) override

bool	send_fan_state (fan::Fan *fan)

void	fan_command (const FanCommandRequest &msg) override

bool	send_light_state (light::LightState *light)

void	light_command (const LightCommandRequest &msg) override

bool	send_sensor_state (sensor::Sensor *sensor)

bool	send_switch_state (switch_::Switch *a_switch)

void	switch_command (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	camera_image (const CameraImageRequest &msg) override

bool	send_climate_state (climate::Climate *climate)

void	climate_command (const ClimateCommandRequest &msg) override

bool	send_number_state (number::Number *number)

void	number_command (const NumberCommandRequest &msg) override

bool	send_date_state (datetime::DateEntity *date)

void	date_command (const DateCommandRequest &msg) override

bool	send_time_state (datetime::TimeEntity *time)

void	time_command (const TimeCommandRequest &msg) override

bool	send_datetime_state (datetime::DateTimeEntity *datetime)

void	datetime_command (const DateTimeCommandRequest &msg) override

bool	send_text_state (text::Text *text)

void	text_command (const TextCommandRequest &msg) override

bool	send_select_state (select::Select *select)

void	select_command (const SelectCommandRequest &msg) override

void	button_command (const ButtonCommandRequest &msg) override

bool	send_lock_state (lock::Lock *a_lock)

void	lock_command (const LockCommandRequest &msg) override

bool	send_valve_state (valve::Valve *valve)

void	valve_command (const ValveCommandRequest &msg) override

bool	send_media_player_state (media_player::MediaPlayer *media_player)

void	media_player_command (const MediaPlayerCommandRequest &msg) override

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

void	send_homeassistant_service_call (const HomeassistantServiceResponse &call)

void	subscribe_bluetooth_le_advertisements (const SubscribeBluetoothLEAdvertisementsRequest &msg) override

void	unsubscribe_bluetooth_le_advertisements (const UnsubscribeBluetoothLEAdvertisementsRequest &msg) override

void	bluetooth_device_request (const BluetoothDeviceRequest &msg) override

void	bluetooth_gatt_read (const BluetoothGATTReadRequest &msg) override

void	bluetooth_gatt_write (const BluetoothGATTWriteRequest &msg) override

void	bluetooth_gatt_read_descriptor (const BluetoothGATTReadDescriptorRequest &msg) override

void	bluetooth_gatt_write_descriptor (const BluetoothGATTWriteDescriptorRequest &msg) override

void	bluetooth_gatt_get_services (const BluetoothGATTGetServicesRequest &msg) override

void	bluetooth_gatt_notify (const BluetoothGATTNotifyRequest &msg) override

bool	send_subscribe_bluetooth_connections_free_response (const SubscribeBluetoothConnectionsFreeRequest &msg) override

void	bluetooth_scanner_set_mode (const BluetoothScannerSetModeRequest &msg) override

void	send_time_request ()

void	subscribe_voice_assistant (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

bool	send_voice_assistant_get_configuration_response (const VoiceAssistantConfigurationRequest &msg) override

void	voice_assistant_set_configuration (const VoiceAssistantSetConfiguration &msg) override

bool	send_alarm_control_panel_state (alarm_control_panel::AlarmControlPanel *a_alarm_control_panel)

void	alarm_control_panel_command (const AlarmControlPanelCommandRequest &msg) override

void	send_event (event::Event *event, const std::string &event_type)

bool	send_update_state (update::UpdateEntity *update)

void	update_command (const UpdateCommandRequest &msg) override

void	on_disconnect_response (const DisconnectResponse &value) override

void	on_ping_response (const PingResponse &value) override

void	on_home_assistant_state_response (const HomeAssistantStateResponse &msg) override

void	on_get_time_response (const GetTimeResponse &value) override

bool	send_hello_response (const HelloRequest &msg) override

bool	send_connect_response (const ConnectRequest &msg) override

bool	send_disconnect_response (const DisconnectRequest &msg) override

bool	send_ping_response (const PingRequest &msg) override

bool	send_device_info_response (const DeviceInfoRequest &msg) override

void	list_entities (const ListEntitiesRequest &msg) override

void	subscribe_states (const SubscribeStatesRequest &msg) override

void	subscribe_logs (const SubscribeLogsRequest &msg) override

void	subscribe_homeassistant_services (const SubscribeHomeassistantServicesRequest &msg) override

void	subscribe_home_assistant_states (const SubscribeHomeAssistantStatesRequest &msg) override

bool	send_get_time_response (const GetTimeRequest &msg) override

void	execute_service (const ExecuteServiceRequest &msg) override

bool	send_noise_encryption_set_key_response (const NoiseEncryptionSetKeyRequest &msg) override

bool	is_authenticated () override

bool	is_connection_setup () override

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_unauthenticated_access () override

void	on_no_setup_connection () override

ProtoWriteBuffer	create_buffer (uint32_t reserve_size) override

ProtoWriteBuffer	prepare_message_buffer (uint16_t message_size, bool is_first_message)

bool	try_to_clear_buffer (bool log_out_of_space)

bool	send_buffer (ProtoWriteBuffer buffer, uint8_t message_type) override

std::string	get_client_combined_info () const

ProtoWriteBuffer	allocate_single_message_buffer (uint16_t size)

ProtoWriteBuffer	allocate_batch_message_buffer (uint16_t size)

Public Member Functions inherited from esphome::api::APIServerConnection
virtual void	siren_command (const SirenCommandRequest &msg)=0

Public Member Functions inherited from esphome::api::APIServerConnectionBase
bool	send_message (const ProtoMessage &msg, uint8_t message_type)

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

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

Protected Member Functions
void	complete_authentication_ ()

void	process_state_subscriptions_ ()

bool	check_voice_assistant_api_connection_ () const

template<typename Iterator >
void	process_iterator_batch_ (Iterator &iterator)

uint32_t	get_batch_delay_ms_ () const

bool	schedule_batch_ ()

void	process_batch_ ()

void	clear_batch_ ()

void	log_proto_message_ (EntityBase *entity, const MessageCreator &creator, uint8_t message_type)

void	log_batch_item_ (const DeferredBatch::BatchItem &item)

bool	send_message_smart_ (EntityBase *entity, MessageCreatorPtr creator, uint8_t message_type, uint8_t estimated_size)

bool	schedule_message_ (EntityBase *entity, MessageCreator creator, uint8_t message_type, uint8_t estimated_size)

bool	schedule_message_ (EntityBase *entity, MessageCreatorPtr function_ptr, uint8_t message_type, uint8_t estimated_size)

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

void	log_warning_ (const char *message, APIError err)

void	log_socket_operation_failed_ (APIError err)

Protected Member Functions inherited from esphome::api::APIServerConnection
void	on_hello_request (const HelloRequest &msg) override

void	on_connect_request (const ConnectRequest &msg) override

void	on_disconnect_request (const DisconnectRequest &msg) override

void	on_ping_request (const PingRequest &msg) override

void	on_device_info_request (const DeviceInfoRequest &msg) override

void	on_list_entities_request (const ListEntitiesRequest &msg) override

void	on_subscribe_states_request (const SubscribeStatesRequest &msg) override

void	on_subscribe_logs_request (const SubscribeLogsRequest &msg) override

void	on_subscribe_homeassistant_services_request (const SubscribeHomeassistantServicesRequest &msg) override

void	on_subscribe_home_assistant_states_request (const SubscribeHomeAssistantStatesRequest &msg) override

void	on_get_time_request (const GetTimeRequest &msg) override

void	on_execute_service_request (const ExecuteServiceRequest &msg) override

void	on_noise_encryption_set_key_request (const NoiseEncryptionSetKeyRequest &msg) override

void	on_button_command_request (const ButtonCommandRequest &msg) override

void	on_camera_image_request (const CameraImageRequest &msg) override

void	on_climate_command_request (const ClimateCommandRequest &msg) override

void	on_cover_command_request (const CoverCommandRequest &msg) override

void	on_date_command_request (const DateCommandRequest &msg) override

void	on_date_time_command_request (const DateTimeCommandRequest &msg) override

void	on_fan_command_request (const FanCommandRequest &msg) override

void	on_light_command_request (const LightCommandRequest &msg) override

void	on_lock_command_request (const LockCommandRequest &msg) override

void	on_media_player_command_request (const MediaPlayerCommandRequest &msg) override

void	on_number_command_request (const NumberCommandRequest &msg) override

void	on_select_command_request (const SelectCommandRequest &msg) override

void	on_siren_command_request (const SirenCommandRequest &msg) override

void	on_switch_command_request (const SwitchCommandRequest &msg) override

void	on_text_command_request (const TextCommandRequest &msg) override

void	on_time_command_request (const TimeCommandRequest &msg) override

void	on_update_command_request (const UpdateCommandRequest &msg) override

void	on_valve_command_request (const ValveCommandRequest &msg) override

void	on_subscribe_bluetooth_le_advertisements_request (const SubscribeBluetoothLEAdvertisementsRequest &msg) override

void	on_bluetooth_device_request (const BluetoothDeviceRequest &msg) override

void	on_bluetooth_gatt_get_services_request (const BluetoothGATTGetServicesRequest &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_notify_request (const BluetoothGATTNotifyRequest &msg) override

void	on_subscribe_bluetooth_connections_free_request (const SubscribeBluetoothConnectionsFreeRequest &msg) override

void	on_unsubscribe_bluetooth_le_advertisements_request (const UnsubscribeBluetoothLEAdvertisementsRequest &msg) override

void	on_bluetooth_scanner_set_mode_request (const BluetoothScannerSetModeRequest &msg) override

void	on_subscribe_voice_assistant_request (const SubscribeVoiceAssistantRequest &msg) override

void	on_voice_assistant_configuration_request (const VoiceAssistantConfigurationRequest &msg) override

void	on_voice_assistant_set_configuration (const VoiceAssistantSetConfiguration &msg) override

void	on_alarm_control_panel_command_request (const AlarmControlPanelCommandRequest &msg) override

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

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

Protected Member Functions inherited from esphome::api::ProtoService
bool	send_message_ (const ProtoMessage &msg, uint8_t message_type)

bool	check_connection_setup_ ()

bool	check_authenticated_ ()

Static Protected Member Functions
static uint16_t	encode_message_to_buffer (ProtoMessage &msg, uint8_t message_type, APIConnection *conn, uint32_t remaining_size, bool is_single)

static uint16_t	fill_and_encode_entity_state (EntityBase entity, StateResponseProtoMessage &msg, uint8_t message_type, APIConnection conn, uint32_t remaining_size, bool is_single)

static uint16_t	fill_and_encode_entity_info (EntityBase entity, InfoResponseProtoMessage &msg, uint8_t message_type, APIConnection conn, uint32_t remaining_size, bool is_single)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static uint16_t	try_send_event_response (event::Event event, const std::string &event_type, APIConnection conn, uint32_t remaining_size, bool is_single)

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

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

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

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

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

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

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

Protected Attributes
std::unique_ptr< APIFrameHelper >	helper_

APIServer *	parent_

InitialStateIterator	initial_state_iterator_

ListEntitiesIterator	list_entities_iterator_

std::unique_ptr< camera::CameraImageReader >	image_reader_

ClientInfo	client_info_

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}

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

◆ MessageCreatorPtr

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

protected

Definition at line 521 of file api_connection.h.

Member Enumeration Documentation

◆ ConnectionState

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

strongprotected

Enumerator
WAITING_FOR_HELLO
CONNECTED
AUTHENTICATED

Definition at line 634 of file api_connection.h.

Constructor & Destructor Documentation

◆ APIConnection()

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

Definition at line 82 of file api_connection.cpp.

◆ ~APIConnection()

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

virtual

Definition at line 122 of file api_connection.cpp.

Member Function Documentation

◆ alarm_control_panel_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1223 of file api_connection.cpp.

◆ allocate_batch_message_buffer()

ProtoWriteBuffer esphome::api::APIConnection::allocate_batch_message_buffer ( uint16_t size )

Definition at line 1625 of file api_connection.cpp.

◆ allocate_single_message_buffer()

ProtoWriteBuffer esphome::api::APIConnection::allocate_single_message_buffer ( uint16_t size )

Definition at line 1623 of file api_connection.cpp.

◆ bluetooth_device_request()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1083 of file api_connection.cpp.

◆ bluetooth_gatt_get_services()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1098 of file api_connection.cpp.

◆ bluetooth_gatt_notify()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1102 of file api_connection.cpp.

◆ bluetooth_gatt_read()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1086 of file api_connection.cpp.

◆ bluetooth_gatt_read_descriptor()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1092 of file api_connection.cpp.

◆ bluetooth_gatt_write()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1089 of file api_connection.cpp.

◆ bluetooth_gatt_write_descriptor()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1095 of file api_connection.cpp.

◆ bluetooth_scanner_set_mode()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1112 of file api_connection.cpp.

◆ button_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 893 of file api_connection.cpp.

◆ camera_image()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1048 of file api_connection.cpp.

◆ check_voice_assistant_api_connection_()

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

inlineprotected

Definition at line 1119 of file api_connection.cpp.

◆ clear_batch_()

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

inlineprotected

Definition at line 683 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 240 of file api_connection.h.

◆ climate_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 671 of file api_connection.cpp.

◆ complete_authentication_()

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

protected

Definition at line 1336 of file api_connection.cpp.

◆ cover_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 370 of file api_connection.cpp.

◆ create_buffer()

ProtoWriteBuffer esphome::api::APIConnection::create_buffer ( uint32_t reserve_size )

inlineoverridevirtual

Implements esphome::api::ProtoService.

Definition at line 250 of file api_connection.h.

◆ date_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 754 of file api_connection.cpp.

◆ datetime_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 814 of file api_connection.cpp.

◆ encode_message_to_buffer()

uint16_t esphome::api::APIConnection::encode_message_to_buffer	(	ProtoMessage &	msg,
		uint8_t	message_type,
		APIConnection *	conn,
		uint32_t	remaining_size,
		bool	is_single )

staticprotected

Definition at line 265 of file api_connection.cpp.

◆ execute_service()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1499 of file api_connection.cpp.

◆ fan_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 416 of file api_connection.cpp.

◆ fill_and_encode_entity_info()

static uint16_t esphome::api::APIConnection::fill_and_encode_entity_info	(	EntityBase *	entity,
		InfoResponseProtoMessage &	msg,
		uint8_t	message_type,
		APIConnection *	conn,
		uint32_t	remaining_size,
		bool	is_single )

inlinestaticprotected

Definition at line 327 of file api_connection.h.

◆ fill_and_encode_entity_state()

static uint16_t esphome::api::APIConnection::fill_and_encode_entity_state	(	EntityBase *	entity,
		StateResponseProtoMessage &	msg,
		uint8_t	message_type,
		APIConnection *	conn,
		uint32_t	remaining_size,
		bool	is_single )

inlinestaticprotected

Definition at line 317 of file api_connection.h.

◆ get_batch_delay_ms_()

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

protected

Definition at line 107 of file api_connection.cpp.

◆ get_client_combined_info()

std::string esphome::api::APIConnection::get_client_combined_info ( ) const

inline

Definition at line 298 of file api_connection.h.

◆ get_log_subscription_level()

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

inline

Definition at line 237 of file api_connection.h.

◆ is_authenticated()

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

inlineoverridevirtual

Implements esphome::api::ProtoService.

Definition at line 230 of file api_connection.h.

◆ is_connection_setup()

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

inlineoverridevirtual

Implements esphome::api::ProtoService.

Definition at line 233 of file api_connection.h.

◆ light_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 484 of file api_connection.cpp.

◆ list_entities()

void esphome::api::APIConnection::list_entities ( const ListEntitiesRequest & msg )

inlineoverridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 204 of file api_connection.h.

◆ lock_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 923 of file api_connection.cpp.

◆ log_batch_item_()

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

inlineprotected

Definition at line 696 of file api_connection.h.

◆ log_proto_message_()

void esphome::api::APIConnection::log_proto_message_	(	EntityBase *	entity,
		const MessageCreator &	creator,
		uint8_t	message_type )

inlineprotected

Definition at line 690 of file api_connection.h.

◆ log_socket_operation_failed_()

void esphome::api::APIConnection::log_socket_operation_failed_ ( APIError err )

protected

Definition at line 1839 of file api_connection.cpp.

◆ log_warning_()

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

protected

Definition at line 1835 of file api_connection.cpp.

◆ loop()

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

Definition at line 135 of file api_connection.cpp.

◆ media_player_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1012 of file api_connection.cpp.

◆ number_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 725 of file api_connection.cpp.

◆ on_disconnect_response()

void esphome::api::APIConnection::on_disconnect_response ( const DisconnectResponse & value )

overridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 258 of file api_connection.cpp.

◆ on_fatal_error()

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

overridevirtual

Implements esphome::api::ProtoService.

Definition at line 1578 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 1064 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 1490 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 1574 of file api_connection.cpp.

◆ on_ping_response()

void esphome::api::APIConnection::on_ping_response ( const PingResponse & value )

inlineoverridevirtual

Reimplemented from esphome::api::APIServerConnectionBase.

Definition at line 189 of file api_connection.h.

◆ on_unauthenticated_access()

void esphome::api::APIConnection::on_unauthenticated_access ( )

overridevirtual

Implements esphome::api::ProtoService.

Definition at line 1569 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 1164 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 1153 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 1148 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 1129 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 1158 of file api_connection.cpp.

◆ prepare_message_buffer()

ProtoWriteBuffer esphome::api::APIConnection::prepare_message_buffer	(	uint16_t	message_size,
		bool	is_first_message )

inline

Definition at line 269 of file api_connection.h.

◆ process_batch_()

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

protected

Definition at line 1631 of file api_connection.cpp.

◆ process_iterator_batch_()

template<typename Iterator >

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

inlineprotected

Definition at line 357 of file api_connection.h.

◆ process_state_subscriptions_()

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

protected

Definition at line 1814 of file api_connection.cpp.

◆ schedule_batch_()

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

protected

Definition at line 1615 of file api_connection.cpp.

◆ schedule_message_() [1/2]

bool esphome::api::APIConnection::schedule_message_	(	EntityBase *	entity,
		MessageCreator	creator,
		uint8_t	message_type,
		uint8_t	estimated_size )

inlineprotected

Definition at line 735 of file api_connection.h.

◆ schedule_message_() [2/2]

bool esphome::api::APIConnection::schedule_message_	(	EntityBase *	entity,
		MessageCreatorPtr	function_ptr,
		uint8_t	message_type,
		uint8_t	estimated_size )

inlineprotected

Definition at line 741 of file api_connection.h.

◆ schedule_message_front_()

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

inlineprotected

Definition at line 747 of file api_connection.h.

◆ select_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 877 of file api_connection.cpp.

◆ 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 1200 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 315 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 1552 of file api_connection.cpp.

◆ send_climate_state()

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

Definition at line 607 of file api_connection.cpp.

◆ send_connect_response()

bool esphome::api::APIConnection::send_connect_response ( const ConnectRequest & msg )

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1380 of file api_connection.cpp.

◆ send_cover_state()

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

Definition at line 342 of file api_connection.cpp.

◆ send_date_state()

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

Definition at line 733 of file api_connection.cpp.

◆ send_datetime_state()

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

Definition at line 791 of file api_connection.cpp.

◆ send_device_info_response()

bool esphome::api::APIConnection::send_device_info_response ( const DeviceInfoRequest & msg )

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1400 of file api_connection.cpp.

◆ send_disconnect_response()

bool esphome::api::APIConnection::send_disconnect_response ( const DisconnectRequest & msg )

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 249 of file api_connection.cpp.

◆ send_event()

void esphome::api::APIConnection::send_event	(	event::Event *	event,
		const std::string &	event_type )

Definition at line 1254 of file api_connection.cpp.

◆ send_fan_state()

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

Definition at line 383 of file api_connection.cpp.

◆ send_get_time_response()

bool esphome::api::APIConnection::send_get_time_response ( const GetTimeRequest & msg )

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1070 of file api_connection.cpp.

◆ send_hello_response()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1354 of file api_connection.cpp.

◆ send_homeassistant_service_call()

void esphome::api::APIConnection::send_homeassistant_service_call ( const HomeassistantServiceResponse & call )

inline

Definition at line 135 of file api_connection.h.

◆ send_light_state()

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

Definition at line 435 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 900 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 976 of file api_connection.cpp.

◆ send_message_smart_()

bool esphome::api::APIConnection::send_message_smart_	(	EntityBase *	entity,
		MessageCreatorPtr	creator,
		uint8_t	message_type,
		uint8_t	estimated_size )

inlineprotected

Definition at line 703 of file api_connection.h.

◆ send_noise_encryption_set_key_response()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1512 of file api_connection.cpp.

◆ send_number_state()

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

Definition at line 698 of file api_connection.cpp.

◆ send_ping_response()

bool esphome::api::APIConnection::send_ping_response ( const PingRequest & msg )

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1395 of file api_connection.cpp.

◆ send_select_state()

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

Definition at line 855 of file api_connection.cpp.

◆ send_sensor_state()

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

Definition at line 518 of file api_connection.cpp.

◆ send_subscribe_bluetooth_connections_free_response()

bool esphome::api::APIConnection::send_subscribe_bluetooth_connections_free_response ( const SubscribeBluetoothConnectionsFreeRequest & msg )

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1106 of file api_connection.cpp.

◆ send_switch_state()

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

Definition at line 547 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 582 of file api_connection.cpp.

◆ send_text_state()

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

Definition at line 822 of file api_connection.cpp.

◆ send_time_request()

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

inline

Definition at line 157 of file api_connection.h.

◆ send_time_state()

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

Definition at line 762 of file api_connection.cpp.

◆ send_update_state()

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

Definition at line 1278 of file api_connection.cpp.

◆ send_valve_state()

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

Definition at line 941 of file api_connection.cpp.

◆ send_voice_assistant_get_configuration_response()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1170 of file api_connection.cpp.

◆ set_camera_state()

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

Definition at line 1031 of file api_connection.cpp.

◆ start()

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

Definition at line 109 of file api_connection.cpp.

◆ subscribe_bluetooth_le_advertisements()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1077 of file api_connection.cpp.

◆ subscribe_home_assistant_states()

void esphome::api::APIConnection::subscribe_home_assistant_states ( const SubscribeHomeAssistantStatesRequest & msg )

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1529 of file api_connection.cpp.

◆ subscribe_homeassistant_services()

void esphome::api::APIConnection::subscribe_homeassistant_services ( const SubscribeHomeassistantServicesRequest & msg )

inlineoverridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 215 of file api_connection.h.

◆ subscribe_logs()

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

inlineoverridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 209 of file api_connection.h.

◆ subscribe_states()

void esphome::api::APIConnection::subscribe_states ( const SubscribeStatesRequest & msg )

inlineoverridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 205 of file api_connection.h.

◆ subscribe_voice_assistant()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1124 of file api_connection.cpp.

◆ switch_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 570 of file api_connection.cpp.

◆ text_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 847 of file api_connection.cpp.

◆ time_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 783 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,
		bool	is_single )

staticprotected

Definition at line 1213 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,
		bool	is_single )

staticprotected

Definition at line 1205 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,
		bool	is_single )

staticprotected

Definition at line 330 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,
		bool	is_single )

staticprotected

Definition at line 320 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,
		bool	is_single )

staticprotected

Definition at line 885 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,
		bool	is_single )

staticprotected

Definition at line 1041 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,
		bool	is_single )

staticprotected

Definition at line 646 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,
		bool	is_single )

staticprotected

Definition at line 611 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,
		bool	is_single )

staticprotected

Definition at line 357 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,
		bool	is_single )

staticprotected

Definition at line 346 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,
		bool	is_single )

staticprotected

Definition at line 747 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,
		bool	is_single )

staticprotected

Definition at line 737 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,
		bool	is_single )

staticprotected

Definition at line 807 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,
		bool	is_single )

staticprotected

Definition at line 795 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,
		bool	is_single )

staticprotected

Definition at line 1801 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,
		bool	is_single )

staticprotected

Definition at line 1265 of file api_connection.cpp.

◆ try_send_event_response()

uint16_t esphome::api::APIConnection::try_send_event_response	(	event::Event *	event,
		const std::string &	event_type,
		APIConnection *	conn,
		uint32_t	remaining_size,
		bool	is_single )

staticprotected

Definition at line 1258 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,
		bool	is_single )

staticprotected

Definition at line 404 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,
		bool	is_single )

staticprotected

Definition at line 387 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,
		bool	is_single )

staticprotected

Definition at line 464 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,
		bool	is_single )

staticprotected

Definition at line 439 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,
		bool	is_single )

staticprotected

Definition at line 1795 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,
		bool	is_single )

staticprotected

Definition at line 913 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,
		bool	is_single )

staticprotected

Definition at line 905 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 1329 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,
		bool	is_single )

staticprotected

Definition at line 993 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,
		bool	is_single )

staticprotected

Definition at line 980 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,
		bool	is_single )

staticprotected

Definition at line 712 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,
		bool	is_single )

staticprotected

Definition at line 703 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,
		bool	is_single )

staticprotected

Definition at line 1807 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,
		bool	is_single )

staticprotected

Definition at line 869 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,
		bool	is_single )

staticprotected

Definition at line 860 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,
		bool	is_single )

staticprotected

Definition at line 532 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,
		bool	is_single )

staticprotected

Definition at line 523 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,
		bool	is_single )

staticprotected

Definition at line 561 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,
		bool	is_single )

staticprotected

Definition at line 552 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,
		bool	is_single )

staticprotected

Definition at line 836 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,
		bool	is_single )

staticprotected

Definition at line 596 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,
		bool	is_single )

staticprotected

Definition at line 587 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,
		bool	is_single )

staticprotected

Definition at line 827 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,
		bool	is_single )

staticprotected

Definition at line 776 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,
		bool	is_single )

staticprotected

Definition at line 766 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,
		bool	is_single )

staticprotected

Definition at line 1301 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,
		bool	is_single )

staticprotected

Definition at line 1282 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,
		bool	is_single )

staticprotected

Definition at line 953 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,
		bool	is_single )

staticprotected

Definition at line 945 of file api_connection.cpp.

◆ try_to_clear_buffer()

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

Definition at line 1533 of file api_connection.cpp.

◆ unsubscribe_bluetooth_le_advertisements()

void esphome::api::APIConnection::unsubscribe_bluetooth_le_advertisements ( const UnsubscribeBluetoothLEAdvertisementsRequest & msg )

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1080 of file api_connection.cpp.

◆ update_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1309 of file api_connection.cpp.

◆ valve_command()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 965 of file api_connection.cpp.

◆ voice_assistant_set_configuration()

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

overridevirtual

Implements esphome::api::APIServerConnection.

Definition at line 1191 of file api_connection.cpp.

Field Documentation

◆ client_api_version_major_

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

protected

Definition at line 663 of file api_connection.h.

◆ client_api_version_minor_

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

protected

Definition at line 664 of file api_connection.h.

◆ client_info_

ClientInfo esphome::api::APIConnection::client_info_

protected

Definition at line 512 of file api_connection.h.

◆ deferred_batch_

DeferredBatch esphome::api::APIConnection::deferred_batch_

protected

Definition at line 631 of file api_connection.h.

◆ flags_

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

protected

◆ helper_

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

protected

Definition at line 500 of file api_connection.h.

◆ image_reader_

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

protected

Definition at line 508 of file api_connection.h.

◆ initial_state_iterator_

InitialStateIterator esphome::api::APIConnection::initial_state_iterator_

protected

Definition at line 505 of file api_connection.h.

◆ last_traffic_

uint32_t esphome::api::APIConnection::last_traffic_

protected

Definition at line 515 of file api_connection.h.

◆ list_entities_iterator_

ListEntitiesIterator esphome::api::APIConnection::list_entities_iterator_

protected

Definition at line 506 of file api_connection.h.

◆ MAX_BATCH_PACKET_SIZE

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

staticconstexprprotected

Definition at line 679 of file api_connection.h.

◆ parent_

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

protected

Definition at line 501 of file api_connection.h.

◆ state_subs_at_

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

protected

Definition at line 517 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 Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ MessageCreatorPtr

Member Enumeration Documentation

◆ ConnectionState

Constructor & Destructor Documentation

◆ APIConnection()

◆ ~APIConnection()

Member Function Documentation

◆ alarm_control_panel_command()

◆ allocate_batch_message_buffer()

◆ allocate_single_message_buffer()

◆ bluetooth_device_request()

◆ bluetooth_gatt_get_services()

◆ bluetooth_gatt_notify()

◆ bluetooth_gatt_read()

◆ bluetooth_gatt_read_descriptor()

◆ bluetooth_gatt_write()

◆ bluetooth_gatt_write_descriptor()

◆ bluetooth_scanner_set_mode()

◆ button_command()

◆ camera_image()

◆ check_voice_assistant_api_connection_()

◆ clear_batch_()

◆ client_supports_api_version()

◆ climate_command()

◆ complete_authentication_()

◆ cover_command()

◆ create_buffer()

◆ date_command()

◆ datetime_command()

◆ encode_message_to_buffer()

◆ execute_service()

◆ fan_command()

◆ fill_and_encode_entity_info()

◆ fill_and_encode_entity_state()

◆ get_batch_delay_ms_()

◆ get_client_combined_info()

◆ get_log_subscription_level()

◆ is_authenticated()

◆ is_connection_setup()

◆ light_command()

◆ list_entities()

◆ lock_command()

◆ log_batch_item_()

◆ log_proto_message_()

◆ log_socket_operation_failed_()

◆ log_warning_()

◆ loop()

◆ media_player_command()

◆ number_command()

◆ on_disconnect_response()

◆ on_fatal_error()

◆ on_get_time_response()

◆ on_home_assistant_state_response()

◆ on_no_setup_connection()

◆ on_ping_response()

◆ on_unauthenticated_access()

◆ on_voice_assistant_announce_request()

◆ on_voice_assistant_audio()

◆ on_voice_assistant_event_response()

◆ on_voice_assistant_response()

◆ on_voice_assistant_timer_event_response()

◆ prepare_message_buffer()

◆ process_batch_()

◆ process_iterator_batch_()

◆ process_state_subscriptions_()

◆ schedule_batch_()

◆ schedule_message_() [1/2]

◆ schedule_message_() [2/2]

◆ schedule_message_front_()

◆ select_command()

◆ send_alarm_control_panel_state()