ESPHome  2024.10.2
api_connection.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include "esphome/core/defines.h"
4 #ifdef USE_API
5 #include "api_frame_helper.h"
6 #include "api_pb2.h"
7 #include "api_pb2_service.h"
8 #include "api_server.h"
10 #include "esphome/core/component.h"
11 
12 #include <vector>
13 
14 namespace esphome {
15 namespace api {
16 
18  public:
19  APIConnection(std::unique_ptr<socket::Socket> socket, APIServer *parent);
20  virtual ~APIConnection();
21 
22  void start();
23  void loop();
24 
27  return this->send_list_entities_done_response(resp);
28  }
29 #ifdef USE_BINARY_SENSOR
32 #endif
33 #ifdef USE_COVER
34  bool send_cover_state(cover::Cover *cover);
35  bool send_cover_info(cover::Cover *cover);
36  void cover_command(const CoverCommandRequest &msg) override;
37 #endif
38 #ifdef USE_FAN
39  bool send_fan_state(fan::Fan *fan);
40  bool send_fan_info(fan::Fan *fan);
41  void fan_command(const FanCommandRequest &msg) override;
42 #endif
43 #ifdef USE_LIGHT
46  void light_command(const LightCommandRequest &msg) override;
47 #endif
48 #ifdef USE_SENSOR
49  bool send_sensor_state(sensor::Sensor *sensor, float state);
50  bool send_sensor_info(sensor::Sensor *sensor);
51 #endif
52 #ifdef USE_SWITCH
53  bool send_switch_state(switch_::Switch *a_switch, bool state);
54  bool send_switch_info(switch_::Switch *a_switch);
55  void switch_command(const SwitchCommandRequest &msg) override;
56 #endif
57 #ifdef USE_TEXT_SENSOR
58  bool send_text_sensor_state(text_sensor::TextSensor *text_sensor, std::string state);
60 #endif
61 #ifdef USE_ESP32_CAMERA
62  void send_camera_state(std::shared_ptr<esp32_camera::CameraImage> image);
64  void camera_image(const CameraImageRequest &msg) override;
65 #endif
66 #ifdef USE_CLIMATE
67  bool send_climate_state(climate::Climate *climate);
68  bool send_climate_info(climate::Climate *climate);
69  void climate_command(const ClimateCommandRequest &msg) override;
70 #endif
71 #ifdef USE_NUMBER
72  bool send_number_state(number::Number *number, float state);
73  bool send_number_info(number::Number *number);
74  void number_command(const NumberCommandRequest &msg) override;
75 #endif
76 #ifdef USE_DATETIME_DATE
79  void date_command(const DateCommandRequest &msg) override;
80 #endif
81 #ifdef USE_DATETIME_TIME
84  void time_command(const TimeCommandRequest &msg) override;
85 #endif
86 #ifdef USE_DATETIME_DATETIME
89  void datetime_command(const DateTimeCommandRequest &msg) override;
90 #endif
91 #ifdef USE_TEXT
92  bool send_text_state(text::Text *text, std::string state);
93  bool send_text_info(text::Text *text);
94  void text_command(const TextCommandRequest &msg) override;
95 #endif
96 #ifdef USE_SELECT
97  bool send_select_state(select::Select *select, std::string state);
98  bool send_select_info(select::Select *select);
99  void select_command(const SelectCommandRequest &msg) override;
100 #endif
101 #ifdef USE_BUTTON
102  bool send_button_info(button::Button *button);
103  void button_command(const ButtonCommandRequest &msg) override;
104 #endif
105 #ifdef USE_LOCK
106  bool send_lock_state(lock::Lock *a_lock, lock::LockState state);
107  bool send_lock_info(lock::Lock *a_lock);
108  void lock_command(const LockCommandRequest &msg) override;
109 #endif
110 #ifdef USE_VALVE
111  bool send_valve_state(valve::Valve *valve);
112  bool send_valve_info(valve::Valve *valve);
113  void valve_command(const ValveCommandRequest &msg) override;
114 #endif
115 #ifdef USE_MEDIA_PLAYER
118  void media_player_command(const MediaPlayerCommandRequest &msg) override;
119 #endif
120  bool send_log_message(int level, const char *tag, const char *line);
122  if (!this->service_call_subscription_)
123  return;
125  }
126 #ifdef USE_BLUETOOTH_PROXY
130 
131  void bluetooth_device_request(const BluetoothDeviceRequest &msg) override;
132  void bluetooth_gatt_read(const BluetoothGATTReadRequest &msg) override;
133  void bluetooth_gatt_write(const BluetoothGATTWriteRequest &msg) override;
137  void bluetooth_gatt_notify(const BluetoothGATTNotifyRequest &msg) override;
139  const SubscribeBluetoothConnectionsFreeRequest &msg) override;
140 
141 #endif
142 #ifdef USE_HOMEASSISTANT_TIME
144  GetTimeRequest req;
145  this->send_get_time_request(req);
146  }
147 #endif
148 
149 #ifdef USE_VOICE_ASSISTANT
151  void on_voice_assistant_response(const VoiceAssistantResponse &msg) override;
153  void on_voice_assistant_audio(const VoiceAssistantAudio &msg) override;
157  const VoiceAssistantConfigurationRequest &msg) override;
159 #endif
160 
161 #ifdef USE_ALARM_CONTROL_PANEL
165 #endif
166 
167 #ifdef USE_EVENT
168  bool send_event(event::Event *event, std::string event_type);
169  bool send_event_info(event::Event *event);
170 #endif
171 
172 #ifdef USE_UPDATE
175  void update_command(const UpdateCommandRequest &msg) override;
176 #endif
177 
178  void on_disconnect_response(const DisconnectResponse &value) override;
179  void on_ping_response(const PingResponse &value) override {
180  // we initiated ping
181  this->ping_retries_ = 0;
182  this->sent_ping_ = false;
183  }
185 #ifdef USE_HOMEASSISTANT_TIME
186  void on_get_time_response(const GetTimeResponse &value) override;
187 #endif
188  HelloResponse hello(const HelloRequest &msg) override;
189  ConnectResponse connect(const ConnectRequest &msg) override;
190  DisconnectResponse disconnect(const DisconnectRequest &msg) override;
191  PingResponse ping(const PingRequest &msg) override { return {}; }
192  DeviceInfoResponse device_info(const DeviceInfoRequest &msg) override;
193  void list_entities(const ListEntitiesRequest &msg) override { this->list_entities_iterator_.begin(); }
194  void subscribe_states(const SubscribeStatesRequest &msg) override {
195  this->state_subscription_ = true;
197  }
198  void subscribe_logs(const SubscribeLogsRequest &msg) override {
199  this->log_subscription_ = msg.level;
200  if (msg.dump_config)
202  }
204  this->service_call_subscription_ = true;
205  }
207  GetTimeResponse get_time(const GetTimeRequest &msg) override {
208  // TODO
209  return {};
210  }
211  void execute_service(const ExecuteServiceRequest &msg) override;
212 
213  bool is_authenticated() override { return this->connection_state_ == ConnectionState::AUTHENTICATED; }
214  bool is_connection_setup() override {
215  return this->connection_state_ == ConnectionState ::CONNECTED || this->is_authenticated();
216  }
217  void on_fatal_error() override;
218  void on_unauthenticated_access() override;
219  void on_no_setup_connection() override;
221  // FIXME: ensure no recursive writes can happen
222  this->proto_write_buffer_.clear();
223  return {&this->proto_write_buffer_};
224  }
225  bool send_buffer(ProtoWriteBuffer buffer, uint32_t message_type) override;
226 
227  std::string get_client_combined_info() const { return this->client_combined_info_; }
228 
229  protected:
230  friend APIServer;
231 
232  bool send_(const void *buf, size_t len, bool force);
233 
234  enum class ConnectionState {
236  CONNECTED,
238  } connection_state_{ConnectionState::WAITING_FOR_HELLO};
239 
240  bool remove_{false};
241 
242  // Buffer used to encode proto messages
243  // Re-use to prevent allocations
244  std::vector<uint8_t> proto_write_buffer_;
245  std::unique_ptr<APIFrameHelper> helper_;
246 
247  std::string client_info_;
248  std::string client_peername_;
252 #ifdef USE_ESP32_CAMERA
254 #endif
255 
256  bool state_subscription_{false};
257  int log_subscription_{ESPHOME_LOG_LEVEL_NONE};
258  uint32_t last_traffic_;
259  uint32_t next_ping_retry_{0};
260  uint8_t ping_retries_{0};
261  bool sent_ping_{false};
263  bool next_close_ = false;
267  int state_subs_at_ = -1;
268 };
269 
270 } // namespace api
271 } // namespace esphome
272 #endif
Base class for all switches.
Definition: switch.h:39
bool send_text_sensor_state(text_sensor::TextSensor *text_sensor, std::string state)
bool send_alarm_control_panel_state(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel)
bool send_time_info(datetime::TimeEntity *time)
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
Definition: light_state.h:34
void subscribe_homeassistant_services(const SubscribeHomeassistantServicesRequest &msg) override
void datetime_command(const DateTimeCommandRequest &msg) override
bool send_text_info(text::Text *text)
bool send_climate_info(climate::Climate *climate)
Base class for all cover devices.
Definition: cover.h:111
void on_voice_assistant_audio(const VoiceAssistantAudio &msg) override
void bluetooth_gatt_notify(const BluetoothGATTNotifyRequest &msg) override
bool send_cover_info(cover::Cover *cover)
bool send_switch_state(switch_::Switch *a_switch, bool state)
void update_command(const UpdateCommandRequest &msg) override
void alarm_control_panel_command(const AlarmControlPanelCommandRequest &msg) override
void send_homeassistant_service_call(const HomeassistantServiceResponse &call)
void on_voice_assistant_response(const VoiceAssistantResponse &msg) override
BluetoothConnectionsFreeResponse subscribe_bluetooth_connections_free(const SubscribeBluetoothConnectionsFreeRequest &msg) override
InitialStateIterator initial_state_iterator_
bool send_valve_state(valve::Valve *valve)
Base class for all buttons.
Definition: button.h:29
bool send_camera_info(esp32_camera::ESP32Camera *camera)
bool send_fan_state(fan::Fan *fan)
bool send_climate_state(climate::Climate *climate)
bool send_button_info(button::Button *button)
DisconnectResponse disconnect(const DisconnectRequest &msg) override
bool send_lock_state(lock::Lock *a_lock, lock::LockState state)
bool send_text_state(text::Text *text, std::string state)
std::unique_ptr< APIFrameHelper > helper_
void media_player_command(const MediaPlayerCommandRequest &msg) override
bool send_homeassistant_service_response(const HomeassistantServiceResponse &msg)
void send_camera_state(std::shared_ptr< esp32_camera::CameraImage > image)
bool send_date_info(datetime::DateEntity *date)
std::string get_client_combined_info() const
void execute_service(const ExecuteServiceRequest &msg) override
Base-class for all text inputs.
Definition: text.h:24
bool send_list_entities_done_response(const ListEntitiesDoneResponse &msg)
void subscribe_voice_assistant(const SubscribeVoiceAssistantRequest &msg) override
bool send_number_info(number::Number *number)
bool send_event(event::Event *event, std::string event_type)
void subscribe_bluetooth_le_advertisements(const SubscribeBluetoothLEAdvertisementsRequest &msg) override
void on_no_setup_connection() override
bool send_binary_sensor_info(binary_sensor::BinarySensor *binary_sensor)
bool send_select_info(select::Select *select)
bool send_event_info(event::Event *event)
bool send_update_info(update::UpdateEntity *update)
void time_command(const TimeCommandRequest &msg) override
void date_command(const DateCommandRequest &msg) override
bool send_sensor_state(sensor::Sensor *sensor, float state)
bool send_select_state(select::Select *select, std::string state)
bool send_valve_info(valve::Valve *valve)
std::vector< uint8_t > proto_write_buffer_
bool send_log_message(int level, const char *tag, const char *line)
Base-class for all numbers.
Definition: number.h:39
bool send_datetime_info(datetime::DateTimeEntity *datetime)
bool send_time_state(datetime::TimeEntity *time)
void on_voice_assistant_announce_request(const VoiceAssistantAnnounceRequest &msg) override
bool send_media_player_info(media_player::MediaPlayer *media_player)
void bluetooth_gatt_write(const BluetoothGATTWriteRequest &msg) override
bool send_alarm_control_panel_info(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel)
bool send_binary_sensor_state(binary_sensor::BinarySensor *binary_sensor, bool state)
void bluetooth_device_request(const BluetoothDeviceRequest &msg) override
bool send_fan_info(fan::Fan *fan)
void subscribe_states(const SubscribeStatesRequest &msg) override
Application App
Global storage of Application pointer - only one Application can exist.
bool send_update_state(update::UpdateEntity *update)
void on_disconnect_response(const DisconnectResponse &value) override
void on_get_time_response(const GetTimeResponse &value) override
void begin(bool include_internal=false)
void button_command(const ButtonCommandRequest &msg) override
void bluetooth_gatt_read_descriptor(const BluetoothGATTReadDescriptorRequest &msg) override
bool send_cover_state(cover::Cover *cover)
VoiceAssistantConfigurationResponse voice_assistant_get_configuration(const VoiceAssistantConfigurationRequest &msg) override
void subscribe_home_assistant_states(const SubscribeHomeAssistantStatesRequest &msg) override
void on_ping_response(const PingResponse &value) override
bool send_buffer(ProtoWriteBuffer buffer, uint32_t message_type) override
esphome::binary_sensor::BinarySensor * binary_sensor
Definition: statsd.h:40
void bluetooth_gatt_write_descriptor(const BluetoothGATTWriteDescriptorRequest &msg) override
void unsubscribe_bluetooth_le_advertisements(const UnsubscribeBluetoothLEAdvertisementsRequest &msg) override
void bluetooth_gatt_get_services(const BluetoothGATTGetServicesRequest &msg) override
esp32_camera::CameraImageReader image_reader_
void switch_command(const SwitchCommandRequest &msg) override
ConnectResponse connect(const ConnectRequest &msg) override
bool send_light_info(light::LightState *light)
void select_command(const SelectCommandRequest &msg) override
bool send_sensor_info(sensor::Sensor *sensor)
std::string size_t len
Definition: helpers.h:292
DeviceInfoResponse device_info(const DeviceInfoRequest &msg) override
bool send_date_state(datetime::DateEntity *date)
GetTimeResponse get_time(const GetTimeRequest &msg) override
bool send_get_time_request(const GetTimeRequest &msg)
void subscribe_logs(const SubscribeLogsRequest &msg) override
Base-class for all selects.
Definition: select.h:31
bool send_light_state(light::LightState *light)
Implementation of SPI Controller mode.
Definition: a01nyub.cpp:7
void on_unauthenticated_access() override
void text_command(const TextCommandRequest &msg) override
void lock_command(const LockCommandRequest &msg) override
bool is_authenticated() override
Base class for all valve devices.
Definition: valve.h:105
bool send_media_player_state(media_player::MediaPlayer *media_player)
Base class for all binary_sensor-type classes.
Definition: binary_sensor.h:37
LockState
Enum for all states a lock can be in.
Definition: lock.h:26
void light_command(const LightCommandRequest &msg) override
bool send_lock_info(lock::Lock *a_lock)
bool send_(const void *buf, size_t len, bool force)
void on_voice_assistant_timer_event_response(const VoiceAssistantTimerEventResponse &msg) override
bool send_datetime_state(datetime::DateTimeEntity *datetime)
void number_command(const NumberCommandRequest &msg) override
ListEntitiesIterator list_entities_iterator_
bool send_switch_info(switch_::Switch *a_switch)
bool send_text_sensor_info(text_sensor::TextSensor *text_sensor)
bool is_connection_setup() override
Base-class for all sensors.
Definition: sensor.h:57
void on_home_assistant_state_response(const HomeAssistantStateResponse &msg) override
void on_voice_assistant_event_response(const VoiceAssistantEventResponse &msg) override
HelloResponse hello(const HelloRequest &msg) override
bool send_bluetooth_le_advertisement(const BluetoothLEAdvertisementResponse &msg)
PingResponse ping(const PingRequest &msg) override
void climate_command(const ClimateCommandRequest &msg) override
bool send_number_state(number::Number *number, float state)
APIConnection(std::unique_ptr< socket::Socket > socket, APIServer *parent)
ProtoWriteBuffer create_buffer() override
esphome::sensor::Sensor * sensor
Definition: statsd.h:37
void cover_command(const CoverCommandRequest &msg) override
void bluetooth_gatt_read(const BluetoothGATTReadRequest &msg) override
void camera_image(const CameraImageRequest &msg) override
void valve_command(const ValveCommandRequest &msg) override
void voice_assistant_set_configuration(const VoiceAssistantSetConfiguration &msg) override
Base class for all locks.
Definition: lock.h:103
ClimateDevice - This is the base class for all climate integrations.
Definition: climate.h:168
bool state
Definition: fan.h:34
void list_entities(const ListEntitiesRequest &msg) override
void fan_command(const FanCommandRequest &msg) override
std::unique_ptr< Socket > socket(int domain, int type, int protocol)
Create a socket of the given domain, type and protocol.