esphome::api::APIServerConnectionBase Class Reference

#include <api_pb2_service.h>

Inheritance diagram for esphome::api::APIServerConnectionBase:

Public Member Functions
bool	send_message (const ProtoMessage &msg, uint8_t message_type)
virtual void	on_hello_request (const HelloRequest &value)
virtual void	on_disconnect_request ()
virtual void	on_disconnect_response ()
virtual void	on_ping_request ()
virtual void	on_ping_response ()
virtual void	on_device_info_request ()
virtual void	on_list_entities_request ()
virtual void	on_subscribe_states_request ()
virtual void	on_cover_command_request (const CoverCommandRequest &value)
virtual void	on_fan_command_request (const FanCommandRequest &value)
virtual void	on_light_command_request (const LightCommandRequest &value)
virtual void	on_switch_command_request (const SwitchCommandRequest &value)
virtual void	on_subscribe_logs_request (const SubscribeLogsRequest &value)
virtual void	on_noise_encryption_set_key_request (const NoiseEncryptionSetKeyRequest &value)
virtual void	on_subscribe_homeassistant_services_request ()
virtual void	on_homeassistant_action_response (const HomeassistantActionResponse &value)
virtual void	on_subscribe_home_assistant_states_request ()
virtual void	on_home_assistant_state_response (const HomeAssistantStateResponse &value)
virtual void	on_get_time_response (const GetTimeResponse &value)
virtual void	on_execute_service_request (const ExecuteServiceRequest &value)
virtual void	on_camera_image_request (const CameraImageRequest &value)
virtual void	on_climate_command_request (const ClimateCommandRequest &value)
virtual void	on_water_heater_command_request (const WaterHeaterCommandRequest &value)
virtual void	on_number_command_request (const NumberCommandRequest &value)
virtual void	on_select_command_request (const SelectCommandRequest &value)
virtual void	on_siren_command_request (const SirenCommandRequest &value)
virtual void	on_lock_command_request (const LockCommandRequest &value)
virtual void	on_button_command_request (const ButtonCommandRequest &value)
virtual void	on_media_player_command_request (const MediaPlayerCommandRequest &value)
virtual void	on_subscribe_bluetooth_le_advertisements_request (const SubscribeBluetoothLEAdvertisementsRequest &value)
virtual void	on_bluetooth_device_request (const BluetoothDeviceRequest &value)
virtual void	on_bluetooth_gatt_get_services_request (const BluetoothGATTGetServicesRequest &value)
virtual void	on_bluetooth_gatt_read_request (const BluetoothGATTReadRequest &value)
virtual void	on_bluetooth_gatt_write_request (const BluetoothGATTWriteRequest &value)
virtual void	on_bluetooth_gatt_read_descriptor_request (const BluetoothGATTReadDescriptorRequest &value)
virtual void	on_bluetooth_gatt_write_descriptor_request (const BluetoothGATTWriteDescriptorRequest &value)
virtual void	on_bluetooth_gatt_notify_request (const BluetoothGATTNotifyRequest &value)
virtual void	on_subscribe_bluetooth_connections_free_request ()
virtual void	on_unsubscribe_bluetooth_le_advertisements_request ()
virtual void	on_bluetooth_scanner_set_mode_request (const BluetoothScannerSetModeRequest &value)
virtual void	on_subscribe_voice_assistant_request (const SubscribeVoiceAssistantRequest &value)
virtual void	on_voice_assistant_response (const VoiceAssistantResponse &value)
virtual void	on_voice_assistant_event_response (const VoiceAssistantEventResponse &value)
virtual void	on_voice_assistant_audio (const VoiceAssistantAudio &value)
virtual void	on_voice_assistant_timer_event_response (const VoiceAssistantTimerEventResponse &value)
virtual void	on_voice_assistant_announce_request (const VoiceAssistantAnnounceRequest &value)
virtual void	on_voice_assistant_configuration_request (const VoiceAssistantConfigurationRequest &value)
virtual void	on_voice_assistant_set_configuration (const VoiceAssistantSetConfiguration &value)
virtual void	on_alarm_control_panel_command_request (const AlarmControlPanelCommandRequest &value)
virtual void	on_text_command_request (const TextCommandRequest &value)
virtual void	on_date_command_request (const DateCommandRequest &value)
virtual void	on_time_command_request (const TimeCommandRequest &value)
virtual void	on_valve_command_request (const ValveCommandRequest &value)
virtual void	on_date_time_command_request (const DateTimeCommandRequest &value)
virtual void	on_update_command_request (const UpdateCommandRequest &value)
virtual void	on_z_wave_proxy_frame (const ZWaveProxyFrame &value)
virtual void	on_z_wave_proxy_request (const ZWaveProxyRequest &value)
virtual void	on_infrared_rf_transmit_raw_timings_request (const InfraredRFTransmitRawTimingsRequest &value)

Protected Member Functions
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
virtual bool	is_authenticated ()=0
virtual bool	is_connection_setup ()=0
virtual void	on_fatal_error ()=0
virtual void	on_no_setup_connection ()=0
virtual bool	send_buffer (ProtoWriteBuffer buffer, uint8_t message_type)=0
virtual bool	send_message_impl (const ProtoMessage &msg, uint8_t message_type)=0
	Send a protobuf message by calculating its size, allocating a buffer, encoding, and sending.
bool	check_connection_setup_ ()
bool	check_authenticated_ ()

Detailed Description

Definition at line 11 of file api_pb2_service.h.

Member Function Documentation

log_receive_message_() [1/2]

void esphome::api::APIServerConnectionBase::log_receive_message_ ( const LogString * name )

protected

Definition at line 18 of file api_pb2_service.cpp.

log_receive_message_() [2/2]

void esphome::api::APIServerConnectionBase::log_receive_message_ ( const LogString * name, const ProtoMessage & msg )

protected

Definition at line 14 of file api_pb2_service.cpp.

log_send_message_()

void esphome::api::APIServerConnectionBase::log_send_message_ ( const char * name, const char * dump )

protected

Definition at line 11 of file api_pb2_service.cpp.

on_alarm_control_panel_command_request()

virtual void esphome::api::APIServerConnectionBase::on_alarm_control_panel_command_request ( const AlarmControlPanelCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 190 of file api_pb2_service.h.

on_bluetooth_device_request()

virtual void esphome::api::APIServerConnectionBase::on_bluetooth_device_request ( const BluetoothDeviceRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 126 of file api_pb2_service.h.

on_bluetooth_gatt_get_services_request()

virtual void esphome::api::APIServerConnectionBase::on_bluetooth_gatt_get_services_request ( const BluetoothGATTGetServicesRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 130 of file api_pb2_service.h.

on_bluetooth_gatt_notify_request()

virtual void esphome::api::APIServerConnectionBase::on_bluetooth_gatt_notify_request ( const BluetoothGATTNotifyRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 147 of file api_pb2_service.h.

on_bluetooth_gatt_read_descriptor_request()

virtual void esphome::api::APIServerConnectionBase::on_bluetooth_gatt_read_descriptor_request ( const BluetoothGATTReadDescriptorRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 141 of file api_pb2_service.h.

on_bluetooth_gatt_read_request()

virtual void esphome::api::APIServerConnectionBase::on_bluetooth_gatt_read_request ( const BluetoothGATTReadRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 134 of file api_pb2_service.h.

on_bluetooth_gatt_write_descriptor_request()

virtual void esphome::api::APIServerConnectionBase::on_bluetooth_gatt_write_descriptor_request ( const BluetoothGATTWriteDescriptorRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 144 of file api_pb2_service.h.

on_bluetooth_gatt_write_request()

virtual void esphome::api::APIServerConnectionBase::on_bluetooth_gatt_write_request ( const BluetoothGATTWriteRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 138 of file api_pb2_service.h.

on_bluetooth_scanner_set_mode_request()

virtual void esphome::api::APIServerConnectionBase::on_bluetooth_scanner_set_mode_request ( const BluetoothScannerSetModeRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 159 of file api_pb2_service.h.

on_button_command_request()

virtual void esphome::api::APIServerConnectionBase::on_button_command_request ( const ButtonCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 114 of file api_pb2_service.h.

on_camera_image_request()

virtual void esphome::api::APIServerConnectionBase::on_camera_image_request ( const CameraImageRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 86 of file api_pb2_service.h.

on_climate_command_request()

virtual void esphome::api::APIServerConnectionBase::on_climate_command_request ( const ClimateCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 90 of file api_pb2_service.h.

on_cover_command_request()

virtual void esphome::api::APIServerConnectionBase::on_cover_command_request ( const CoverCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 43 of file api_pb2_service.h.

on_date_command_request()

virtual void esphome::api::APIServerConnectionBase::on_date_command_request ( const DateCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 198 of file api_pb2_service.h.

on_date_time_command_request()

virtual void esphome::api::APIServerConnectionBase::on_date_time_command_request ( const DateTimeCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 210 of file api_pb2_service.h.

on_device_info_request()

virtual void esphome::api::APIServerConnectionBase::on_device_info_request ( )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 36 of file api_pb2_service.h.

on_disconnect_request()

virtual void esphome::api::APIServerConnectionBase::on_disconnect_request ( )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 32 of file api_pb2_service.h.

on_disconnect_response()

virtual void esphome::api::APIServerConnectionBase::on_disconnect_response ( )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 33 of file api_pb2_service.h.

on_execute_service_request()

virtual void esphome::api::APIServerConnectionBase::on_execute_service_request ( const ExecuteServiceRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 82 of file api_pb2_service.h.

on_fan_command_request()

virtual void esphome::api::APIServerConnectionBase::on_fan_command_request ( const FanCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 47 of file api_pb2_service.h.

on_get_time_response()

virtual void esphome::api::APIServerConnectionBase::on_get_time_response ( const GetTimeResponse & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 79 of file api_pb2_service.h.

on_hello_request()

virtual void esphome::api::APIServerConnectionBase::on_hello_request ( const HelloRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 30 of file api_pb2_service.h.

on_home_assistant_state_response()

virtual void esphome::api::APIServerConnectionBase::on_home_assistant_state_response ( const HomeAssistantStateResponse & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 76 of file api_pb2_service.h.

on_homeassistant_action_response()

virtual void esphome::api::APIServerConnectionBase::on_homeassistant_action_response ( const HomeassistantActionResponse & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 69 of file api_pb2_service.h.

on_infrared_rf_transmit_raw_timings_request()

virtual void esphome::api::APIServerConnectionBase::on_infrared_rf_transmit_raw_timings_request ( const InfraredRFTransmitRawTimingsRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 224 of file api_pb2_service.h.

on_light_command_request()

virtual void esphome::api::APIServerConnectionBase::on_light_command_request ( const LightCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 51 of file api_pb2_service.h.

on_list_entities_request()

virtual void esphome::api::APIServerConnectionBase::on_list_entities_request ( )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 38 of file api_pb2_service.h.

on_lock_command_request()

virtual void esphome::api::APIServerConnectionBase::on_lock_command_request ( const LockCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 110 of file api_pb2_service.h.

on_media_player_command_request()

virtual void esphome::api::APIServerConnectionBase::on_media_player_command_request ( const MediaPlayerCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 118 of file api_pb2_service.h.

on_noise_encryption_set_key_request()

virtual void esphome::api::APIServerConnectionBase::on_noise_encryption_set_key_request ( const NoiseEncryptionSetKeyRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 61 of file api_pb2_service.h.

on_number_command_request()

virtual void esphome::api::APIServerConnectionBase::on_number_command_request ( const NumberCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 98 of file api_pb2_service.h.

on_ping_request()

virtual void esphome::api::APIServerConnectionBase::on_ping_request ( )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 34 of file api_pb2_service.h.

on_ping_response()

virtual void esphome::api::APIServerConnectionBase::on_ping_response ( )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 35 of file api_pb2_service.h.

on_select_command_request()

virtual void esphome::api::APIServerConnectionBase::on_select_command_request ( const SelectCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 102 of file api_pb2_service.h.

on_siren_command_request()

virtual void esphome::api::APIServerConnectionBase::on_siren_command_request ( const SirenCommandRequest & value )

inlinevirtual

Definition at line 106 of file api_pb2_service.h.

on_subscribe_bluetooth_connections_free_request()

virtual void esphome::api::APIServerConnectionBase::on_subscribe_bluetooth_connections_free_request ( )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 151 of file api_pb2_service.h.

on_subscribe_bluetooth_le_advertisements_request()

virtual void esphome::api::APIServerConnectionBase::on_subscribe_bluetooth_le_advertisements_request ( const SubscribeBluetoothLEAdvertisementsRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 121 of file api_pb2_service.h.

on_subscribe_home_assistant_states_request()

virtual void esphome::api::APIServerConnectionBase::on_subscribe_home_assistant_states_request ( )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 72 of file api_pb2_service.h.

on_subscribe_homeassistant_services_request()

virtual void esphome::api::APIServerConnectionBase::on_subscribe_homeassistant_services_request ( )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 65 of file api_pb2_service.h.

on_subscribe_logs_request()

virtual void esphome::api::APIServerConnectionBase::on_subscribe_logs_request ( const SubscribeLogsRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 58 of file api_pb2_service.h.

on_subscribe_states_request()

virtual void esphome::api::APIServerConnectionBase::on_subscribe_states_request ( )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 40 of file api_pb2_service.h.

on_subscribe_voice_assistant_request()

virtual void esphome::api::APIServerConnectionBase::on_subscribe_voice_assistant_request ( const SubscribeVoiceAssistantRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 162 of file api_pb2_service.h.

on_switch_command_request()

virtual void esphome::api::APIServerConnectionBase::on_switch_command_request ( const SwitchCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 55 of file api_pb2_service.h.

on_text_command_request()

virtual void esphome::api::APIServerConnectionBase::on_text_command_request ( const TextCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 194 of file api_pb2_service.h.

on_time_command_request()

virtual void esphome::api::APIServerConnectionBase::on_time_command_request ( const TimeCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 202 of file api_pb2_service.h.

on_unsubscribe_bluetooth_le_advertisements_request()

virtual void esphome::api::APIServerConnectionBase::on_unsubscribe_bluetooth_le_advertisements_request ( )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 155 of file api_pb2_service.h.

on_update_command_request()

virtual void esphome::api::APIServerConnectionBase::on_update_command_request ( const UpdateCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 214 of file api_pb2_service.h.

on_valve_command_request()

virtual void esphome::api::APIServerConnectionBase::on_valve_command_request ( const ValveCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 206 of file api_pb2_service.h.

on_voice_assistant_announce_request()

virtual void esphome::api::APIServerConnectionBase::on_voice_assistant_announce_request ( const VoiceAssistantAnnounceRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 178 of file api_pb2_service.h.

on_voice_assistant_audio()

virtual void esphome::api::APIServerConnectionBase::on_voice_assistant_audio ( const VoiceAssistantAudio & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 172 of file api_pb2_service.h.

on_voice_assistant_configuration_request()

virtual void esphome::api::APIServerConnectionBase::on_voice_assistant_configuration_request ( const VoiceAssistantConfigurationRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 182 of file api_pb2_service.h.

on_voice_assistant_event_response()

virtual void esphome::api::APIServerConnectionBase::on_voice_assistant_event_response ( const VoiceAssistantEventResponse & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 169 of file api_pb2_service.h.

on_voice_assistant_response()

virtual void esphome::api::APIServerConnectionBase::on_voice_assistant_response ( const VoiceAssistantResponse & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 166 of file api_pb2_service.h.

on_voice_assistant_set_configuration()

virtual void esphome::api::APIServerConnectionBase::on_voice_assistant_set_configuration ( const VoiceAssistantSetConfiguration & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 186 of file api_pb2_service.h.

on_voice_assistant_timer_event_response()

virtual void esphome::api::APIServerConnectionBase::on_voice_assistant_timer_event_response ( const VoiceAssistantTimerEventResponse & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 175 of file api_pb2_service.h.

on_water_heater_command_request()

virtual void esphome::api::APIServerConnectionBase::on_water_heater_command_request ( const WaterHeaterCommandRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 94 of file api_pb2_service.h.

on_z_wave_proxy_frame()

virtual void esphome::api::APIServerConnectionBase::on_z_wave_proxy_frame ( const ZWaveProxyFrame & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 217 of file api_pb2_service.h.

on_z_wave_proxy_request()

virtual void esphome::api::APIServerConnectionBase::on_z_wave_proxy_request ( const ZWaveProxyRequest & value )

inlinevirtual

Reimplemented in esphome::api::APIConnection.

Definition at line 220 of file api_pb2_service.h.

read_message()

void esphome::api::APIServerConnectionBase::read_message ( uint32_t msg_size, uint32_t msg_type, const uint8_t * msg_data )

overrideprotectedvirtual

Implements esphome::api::ProtoService.

Definition at line 23 of file api_pb2_service.cpp.

send_message()

bool esphome::api::APIServerConnectionBase::send_message ( const ProtoMessage & msg, uint8_t message_type )

inline

Definition at line 22 of file api_pb2_service.h.

---

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

• esphome/components/api/api_pb2_service.h
• esphome/components/api/api_pb2_service.cpp