ESPHome  2024.5.5
api_connection.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include "api_frame_helper.h"
4 #include "api_pb2.h"
5 #include "api_pb2_service.h"
6 #include "api_server.h"
9 #include "esphome/core/defines.h"
10 
11 #include <vector>
12 
13 namespace esphome {
14 namespace api {
15 
17  public:
18  APIConnection(std::unique_ptr<socket::Socket> socket, APIServer *parent);
19  virtual ~APIConnection();
20 
21  void start();
22  void loop();
23 
26  return this->send_list_entities_done_response(resp);
27  }
28 #ifdef USE_BINARY_SENSOR
31 #endif
32 #ifdef USE_COVER
33  bool send_cover_state(cover::Cover *cover);
34  bool send_cover_info(cover::Cover *cover);
35  void cover_command(const CoverCommandRequest &msg) override;
36 #endif
37 #ifdef USE_FAN
38  bool send_fan_state(fan::Fan *fan);
39  bool send_fan_info(fan::Fan *fan);
40  void fan_command(const FanCommandRequest &msg) override;
41 #endif
42 #ifdef USE_LIGHT
45  void light_command(const LightCommandRequest &msg) override;
46 #endif
47 #ifdef USE_SENSOR
48  bool send_sensor_state(sensor::Sensor *sensor, float state);
49  bool send_sensor_info(sensor::Sensor *sensor);
50 #endif
51 #ifdef USE_SWITCH
52  bool send_switch_state(switch_::Switch *a_switch, bool state);
53  bool send_switch_info(switch_::Switch *a_switch);
54  void switch_command(const SwitchCommandRequest &msg) override;
55 #endif
56 #ifdef USE_TEXT_SENSOR
57  bool send_text_sensor_state(text_sensor::TextSensor *text_sensor, std::string state);
59 #endif
60 #ifdef USE_ESP32_CAMERA
61  void send_camera_state(std::shared_ptr<esp32_camera::CameraImage> image);
63  void camera_image(const CameraImageRequest &msg) override;
64 #endif
65 #ifdef USE_CLIMATE
66  bool send_climate_state(climate::Climate *climate);
67  bool send_climate_info(climate::Climate *climate);
68  void climate_command(const ClimateCommandRequest &msg) override;
69 #endif
70 #ifdef USE_NUMBER
71  bool send_number_state(number::Number *number, float state);
72  bool send_number_info(number::Number *number);
73  void number_command(const NumberCommandRequest &msg) override;
74 #endif
75 #ifdef USE_DATETIME_DATE
78  void date_command(const DateCommandRequest &msg) override;
79 #endif
80 #ifdef USE_DATETIME_TIME
83  void time_command(const TimeCommandRequest &msg) override;
84 #endif
85 #ifdef USE_DATETIME_DATETIME
88  void datetime_command(const DateTimeCommandRequest &msg) override;
89 #endif
90 #ifdef USE_TEXT
91  bool send_text_state(text::Text *text, std::string state);
92  bool send_text_info(text::Text *text);
93  void text_command(const TextCommandRequest &msg) override;
94 #endif
95 #ifdef USE_SELECT
96  bool send_select_state(select::Select *select, std::string state);
97  bool send_select_info(select::Select *select);
98  void select_command(const SelectCommandRequest &msg) override;
99 #endif
100 #ifdef USE_BUTTON
101  bool send_button_info(button::Button *button);
102  void button_command(const ButtonCommandRequest &msg) override;
103 #endif
104 #ifdef USE_LOCK
105  bool send_lock_state(lock::Lock *a_lock, lock::LockState state);
106  bool send_lock_info(lock::Lock *a_lock);
107  void lock_command(const LockCommandRequest &msg) override;
108 #endif
109 #ifdef USE_VALVE
110  bool send_valve_state(valve::Valve *valve);
111  bool send_valve_info(valve::Valve *valve);
112  void valve_command(const ValveCommandRequest &msg) override;
113 #endif
114 #ifdef USE_MEDIA_PLAYER
117  void media_player_command(const MediaPlayerCommandRequest &msg) override;
118 #endif
119  bool send_log_message(int level, const char *tag, const char *line);
121  if (!this->service_call_subscription_)
122  return;
124  }
125 #ifdef USE_BLUETOOTH_PROXY
129 
130  void bluetooth_device_request(const BluetoothDeviceRequest &msg) override;
131  void bluetooth_gatt_read(const BluetoothGATTReadRequest &msg) override;
132  void bluetooth_gatt_write(const BluetoothGATTWriteRequest &msg) override;
136  void bluetooth_gatt_notify(const BluetoothGATTNotifyRequest &msg) override;
138  const SubscribeBluetoothConnectionsFreeRequest &msg) override;
139 
140 #endif
141 #ifdef USE_HOMEASSISTANT_TIME
143  GetTimeRequest req;
144  this->send_get_time_request(req);
145  }
146 #endif
147 
148 #ifdef USE_VOICE_ASSISTANT
150  void on_voice_assistant_response(const VoiceAssistantResponse &msg) override;
152  void on_voice_assistant_audio(const VoiceAssistantAudio &msg) override;
153 #endif
154 
155 #ifdef USE_ALARM_CONTROL_PANEL
159 #endif
160 
161 #ifdef USE_EVENT
162  bool send_event(event::Event *event, std::string event_type);
163  bool send_event_info(event::Event *event);
164 #endif
165 
166  void on_disconnect_response(const DisconnectResponse &value) override;
167  void on_ping_response(const PingResponse &value) override {
168  // we initiated ping
169  this->ping_retries_ = 0;
170  this->sent_ping_ = false;
171  }
173 #ifdef USE_HOMEASSISTANT_TIME
174  void on_get_time_response(const GetTimeResponse &value) override;
175 #endif
176  HelloResponse hello(const HelloRequest &msg) override;
177  ConnectResponse connect(const ConnectRequest &msg) override;
178  DisconnectResponse disconnect(const DisconnectRequest &msg) override;
179  PingResponse ping(const PingRequest &msg) override { return {}; }
180  DeviceInfoResponse device_info(const DeviceInfoRequest &msg) override;
181  void list_entities(const ListEntitiesRequest &msg) override { this->list_entities_iterator_.begin(); }
182  void subscribe_states(const SubscribeStatesRequest &msg) override {
183  this->state_subscription_ = true;
185  }
186  void subscribe_logs(const SubscribeLogsRequest &msg) override {
187  this->log_subscription_ = msg.level;
188  if (msg.dump_config)
190  }
192  this->service_call_subscription_ = true;
193  }
195  GetTimeResponse get_time(const GetTimeRequest &msg) override {
196  // TODO
197  return {};
198  }
199  void execute_service(const ExecuteServiceRequest &msg) override;
200 
201  bool is_authenticated() override { return this->connection_state_ == ConnectionState::AUTHENTICATED; }
202  bool is_connection_setup() override {
203  return this->connection_state_ == ConnectionState ::CONNECTED || this->is_authenticated();
204  }
205  void on_fatal_error() override;
206  void on_unauthenticated_access() override;
207  void on_no_setup_connection() override;
209  // FIXME: ensure no recursive writes can happen
210  this->proto_write_buffer_.clear();
211  return {&this->proto_write_buffer_};
212  }
213  bool send_buffer(ProtoWriteBuffer buffer, uint32_t message_type) override;
214 
215  std::string get_client_combined_info() const { return this->client_combined_info_; }
216 
217  protected:
218  friend APIServer;
219 
220  bool send_(const void *buf, size_t len, bool force);
221 
222  enum class ConnectionState {
224  CONNECTED,
226  } connection_state_{ConnectionState::WAITING_FOR_HELLO};
227 
228  bool remove_{false};
229 
230  // Buffer used to encode proto messages
231  // Re-use to prevent allocations
232  std::vector<uint8_t> proto_write_buffer_;
233  std::unique_ptr<APIFrameHelper> helper_;
234 
235  std::string client_info_;
236  std::string client_peername_;
240 #ifdef USE_ESP32_CAMERA
242 #endif
243 
244  bool state_subscription_{false};
245  int log_subscription_{ESPHOME_LOG_LEVEL_NONE};
246  uint32_t last_traffic_;
247  uint32_t next_ping_retry_{0};
248  uint8_t ping_retries_{0};
249  bool sent_ping_{false};
251  bool next_close_ = false;
255  int state_subs_at_ = -1;
256 };
257 
258 } // namespace api
259 } // namespace esphome
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 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)
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)
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.
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)
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
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)
This is a workaround until we can figure out a way to get the tflite-micro idf component code availab...
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)
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
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
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.