api_connection.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/defines.h"
#ifdef USE_API
#include "api_frame_helper.h"
#include "api_pb2.h"
#include "api_pb2_service.h"
#include "api_server.h"
#include "esphome/core/application.h"
#include "esphome/core/component.h"
#include "esphome/core/entity_base.h"
 
#include <vector>
 
namespace esphome {
namespace api {
 
// Keepalive timeout in milliseconds
static constexpr uint32_t KEEPALIVE_TIMEOUT_MS = 60000;
 
using send_message_t = bool (APIConnection::*)(void *);
 
/*
  This class holds a pointer to the source component that wants to publish a message, and a pointer to a function that
  will lazily publish that message.  The two pointers allow dedup in the deferred queue if multiple publishes for the
  same component are backed up, and take up only 8 bytes of memory.  The entry in the deferred queue (a std::vector) is
  the DeferredMessage instance itself (not a pointer to one elsewhere in heap) so still only 8 bytes per entry.  Even
  100 backed up messages (you'd have to have at least 100 sensors publishing because of dedup) would take up only 0.8
  kB.
*/
class DeferredMessageQueue {
  struct DeferredMessage {
    friend class DeferredMessageQueue;
 
   protected:
    void *source_;
    send_message_t send_message_;
 
   public:
    DeferredMessage(void *source, send_message_t send_message) : source_(source), send_message_(send_message) {}
    bool operator==(const DeferredMessage &test) const {
      return (source_ == test.source_ && send_message_ == test.send_message_);
    }
  } __attribute__((packed));
 
 protected:
  // vector is used very specifically for its zero memory overhead even though items are popped from the front (memory
  // footprint is more important than speed here)
  std::vector<DeferredMessage> deferred_queue_;
  APIConnection *api_connection_;
 
  // helper for allowing only unique entries in the queue
  void dmq_push_back_with_dedup_(void *source, send_message_t send_message);
 
 public:
  DeferredMessageQueue(APIConnection *api_connection) : api_connection_(api_connection) {}
  void process_queue();
  void defer(void *source, send_message_t send_message);
  bool empty() const { return deferred_queue_.empty(); }
};
 
class APIConnection : public APIServerConnection {
 public:
  APIConnection(std::unique_ptr<socket::Socket> socket, APIServer *parent);
  virtual ~APIConnection();
 
  void start();
  void loop();
 
  bool send_list_info_done() {
    ListEntitiesDoneResponse resp;
    return this->send_list_entities_done_response(resp);
  }
#ifdef USE_BINARY_SENSOR
  bool send_binary_sensor_state(binary_sensor::BinarySensor *binary_sensor, bool state);
  void send_binary_sensor_info(binary_sensor::BinarySensor *binary_sensor);
 
 protected:
  bool try_send_binary_sensor_state_(binary_sensor::BinarySensor *binary_sensor);
  bool try_send_binary_sensor_state_(binary_sensor::BinarySensor *binary_sensor, bool state);
  bool try_send_binary_sensor_info_(binary_sensor::BinarySensor *binary_sensor);
 
 public:
#endif
#ifdef USE_COVER
  bool send_cover_state(cover::Cover *cover);
  void send_cover_info(cover::Cover *cover);
  void cover_command(const CoverCommandRequest &msg) override;
 
 protected:
  bool try_send_cover_state_(cover::Cover *cover);
  bool try_send_cover_info_(cover::Cover *cover);
 
 public:
#endif
#ifdef USE_FAN
  bool send_fan_state(fan::Fan *fan);
  void send_fan_info(fan::Fan *fan);
  void fan_command(const FanCommandRequest &msg) override;
 
 protected:
  bool try_send_fan_state_(fan::Fan *fan);
  bool try_send_fan_info_(fan::Fan *fan);
 
 public:
#endif
#ifdef USE_LIGHT
  bool send_light_state(light::LightState *light);
  void send_light_info(light::LightState *light);
  void light_command(const LightCommandRequest &msg) override;
 
 protected:
  bool try_send_light_state_(light::LightState *light);
  bool try_send_light_info_(light::LightState *light);
 
 public:
#endif
#ifdef USE_SENSOR
  bool send_sensor_state(sensor::Sensor *sensor, float state);
  void send_sensor_info(sensor::Sensor *sensor);
 
 protected:
  bool try_send_sensor_state_(sensor::Sensor *sensor);
  bool try_send_sensor_state_(sensor::Sensor *sensor, float state);
  bool try_send_sensor_info_(sensor::Sensor *sensor);
 
 public:
#endif
#ifdef USE_SWITCH
  bool send_switch_state(switch_::Switch *a_switch, bool state);
  void send_switch_info(switch_::Switch *a_switch);
  void switch_command(const SwitchCommandRequest &msg) override;
 
 protected:
  bool try_send_switch_state_(switch_::Switch *a_switch);
  bool try_send_switch_state_(switch_::Switch *a_switch, bool state);
  bool try_send_switch_info_(switch_::Switch *a_switch);
 
 public:
#endif
#ifdef USE_TEXT_SENSOR
  bool send_text_sensor_state(text_sensor::TextSensor *text_sensor, std::string state);
  void send_text_sensor_info(text_sensor::TextSensor *text_sensor);
 
 protected:
  bool try_send_text_sensor_state_(text_sensor::TextSensor *text_sensor);
  bool try_send_text_sensor_state_(text_sensor::TextSensor *text_sensor, std::string state);
  bool try_send_text_sensor_info_(text_sensor::TextSensor *text_sensor);
 
 public:
#endif
#ifdef USE_ESP32_CAMERA
  void set_camera_state(std::shared_ptr<esp32_camera::CameraImage> image);
  void send_camera_info(esp32_camera::ESP32Camera *camera);
  void camera_image(const CameraImageRequest &msg) override;
 
 protected:
  bool try_send_camera_info_(esp32_camera::ESP32Camera *camera);
 
 public:
#endif
#ifdef USE_CLIMATE
  bool send_climate_state(climate::Climate *climate);
  void send_climate_info(climate::Climate *climate);
  void climate_command(const ClimateCommandRequest &msg) override;
 
 protected:
  bool try_send_climate_state_(climate::Climate *climate);
  bool try_send_climate_info_(climate::Climate *climate);
 
 public:
#endif
#ifdef USE_NUMBER
  bool send_number_state(number::Number *number, float state);
  void send_number_info(number::Number *number);
  void number_command(const NumberCommandRequest &msg) override;
 
 protected:
  bool try_send_number_state_(number::Number *number);
  bool try_send_number_state_(number::Number *number, float state);
  bool try_send_number_info_(number::Number *number);
 
 public:
#endif
#ifdef USE_DATETIME_DATE
  bool send_date_state(datetime::DateEntity *date);
  void send_date_info(datetime::DateEntity *date);
  void date_command(const DateCommandRequest &msg) override;
 
 protected:
  bool try_send_date_state_(datetime::DateEntity *date);
  bool try_send_date_info_(datetime::DateEntity *date);
 
 public:
#endif
#ifdef USE_DATETIME_TIME
  bool send_time_state(datetime::TimeEntity *time);
  void send_time_info(datetime::TimeEntity *time);
  void time_command(const TimeCommandRequest &msg) override;
 
 protected:
  bool try_send_time_state_(datetime::TimeEntity *time);
  bool try_send_time_info_(datetime::TimeEntity *time);
 
 public:
#endif
#ifdef USE_DATETIME_DATETIME
  bool send_datetime_state(datetime::DateTimeEntity *datetime);
  void send_datetime_info(datetime::DateTimeEntity *datetime);
  void datetime_command(const DateTimeCommandRequest &msg) override;
 
 protected:
  bool try_send_datetime_state_(datetime::DateTimeEntity *datetime);
  bool try_send_datetime_info_(datetime::DateTimeEntity *datetime);
 
 public:
#endif
#ifdef USE_TEXT
  bool send_text_state(text::Text *text, std::string state);
  void send_text_info(text::Text *text);
  void text_command(const TextCommandRequest &msg) override;
 
 protected:
  bool try_send_text_state_(text::Text *text);
  bool try_send_text_state_(text::Text *text, std::string state);
  bool try_send_text_info_(text::Text *text);
 
 public:
#endif
#ifdef USE_SELECT
  bool send_select_state(select::Select *select, std::string state);
  void send_select_info(select::Select *select);
  void select_command(const SelectCommandRequest &msg) override;
 
 protected:
  bool try_send_select_state_(select::Select *select);
  bool try_send_select_state_(select::Select *select, std::string state);
  bool try_send_select_info_(select::Select *select);
 
 public:
#endif
#ifdef USE_BUTTON
  void send_button_info(button::Button *button);
  void button_command(const ButtonCommandRequest &msg) override;
 
 protected:
  bool try_send_button_info_(button::Button *button);
 
 public:
#endif
#ifdef USE_LOCK
  bool send_lock_state(lock::Lock *a_lock, lock::LockState state);
  void send_lock_info(lock::Lock *a_lock);
  void lock_command(const LockCommandRequest &msg) override;
 
 protected:
  bool try_send_lock_state_(lock::Lock *a_lock);
  bool try_send_lock_state_(lock::Lock *a_lock, lock::LockState state);
  bool try_send_lock_info_(lock::Lock *a_lock);
 
 public:
#endif
#ifdef USE_VALVE
  bool send_valve_state(valve::Valve *valve);
  void send_valve_info(valve::Valve *valve);
  void valve_command(const ValveCommandRequest &msg) override;
 
 protected:
  bool try_send_valve_state_(valve::Valve *valve);
  bool try_send_valve_info_(valve::Valve *valve);
 
 public:
#endif
#ifdef USE_MEDIA_PLAYER
  bool send_media_player_state(media_player::MediaPlayer *media_player);
  void send_media_player_info(media_player::MediaPlayer *media_player);
  void media_player_command(const MediaPlayerCommandRequest &msg) override;
 
 protected:
  bool try_send_media_player_state_(media_player::MediaPlayer *media_player);
  bool try_send_media_player_info_(media_player::MediaPlayer *media_player);
 
 public:
#endif
  bool try_send_log_message(int level, const char *tag, const char *line);
  void send_homeassistant_service_call(const HomeassistantServiceResponse &call) {
    if (!this->service_call_subscription_)
      return;
    this->send_homeassistant_service_response(call);
  }
#ifdef USE_BLUETOOTH_PROXY
  void subscribe_bluetooth_le_advertisements(const SubscribeBluetoothLEAdvertisementsRequest &msg) override;
  void unsubscribe_bluetooth_le_advertisements(const UnsubscribeBluetoothLEAdvertisementsRequest &msg) override;
  bool send_bluetooth_le_advertisement(const BluetoothLEAdvertisementResponse &msg);
 
  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;
  BluetoothConnectionsFreeResponse subscribe_bluetooth_connections_free(
      const SubscribeBluetoothConnectionsFreeRequest &msg) override;
  void bluetooth_scanner_set_mode(const BluetoothScannerSetModeRequest &msg) override;
 
#endif
#ifdef USE_HOMEASSISTANT_TIME
  void send_time_request() {
    GetTimeRequest req;
    this->send_get_time_request(req);
  }
#endif
 
#ifdef USE_VOICE_ASSISTANT
  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;
  VoiceAssistantConfigurationResponse voice_assistant_get_configuration(
      const VoiceAssistantConfigurationRequest &msg) override;
  void voice_assistant_set_configuration(const VoiceAssistantSetConfiguration &msg) override;
#endif
 
#ifdef USE_ALARM_CONTROL_PANEL
  bool send_alarm_control_panel_state(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel);
  void send_alarm_control_panel_info(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel);
  void alarm_control_panel_command(const AlarmControlPanelCommandRequest &msg) override;
 
 protected:
  bool try_send_alarm_control_panel_state_(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel);
  bool try_send_alarm_control_panel_info_(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel);
 
 public:
#endif
 
#ifdef USE_EVENT
  void send_event(event::Event *event, std::string event_type);
  void send_event_info(event::Event *event);
 
 protected:
  bool try_send_event_(event::Event *event);
  bool try_send_event_(event::Event *event, std::string event_type);
  bool try_send_event_info_(event::Event *event);
 
 public:
#endif
 
#ifdef USE_UPDATE
  bool send_update_state(update::UpdateEntity *update);
  void send_update_info(update::UpdateEntity *update);
  void update_command(const UpdateCommandRequest &msg) override;
 
 protected:
  bool try_send_update_state_(update::UpdateEntity *update);
  bool try_send_update_info_(update::UpdateEntity *update);
 
 public:
#endif
 
  void on_disconnect_response(const DisconnectResponse &value) override;
  void on_ping_response(const PingResponse &value) override {
    // we initiated ping
    this->ping_retries_ = 0;
    this->sent_ping_ = false;
  }
  void on_home_assistant_state_response(const HomeAssistantStateResponse &msg) override;
#ifdef USE_HOMEASSISTANT_TIME
  void on_get_time_response(const GetTimeResponse &value) override;
#endif
  HelloResponse hello(const HelloRequest &msg) override;
  ConnectResponse connect(const ConnectRequest &msg) override;
  DisconnectResponse disconnect(const DisconnectRequest &msg) override;
  PingResponse ping(const PingRequest &msg) override { return {}; }
  DeviceInfoResponse device_info(const DeviceInfoRequest &msg) override;
  void list_entities(const ListEntitiesRequest &msg) override { this->list_entities_iterator_.begin(); }
  void subscribe_states(const SubscribeStatesRequest &msg) override {
    this->state_subscription_ = true;
    this->initial_state_iterator_.begin();
  }
  void subscribe_logs(const SubscribeLogsRequest &msg) override {
    this->log_subscription_ = msg.level;
    if (msg.dump_config)
      App.schedule_dump_config();
  }
  void subscribe_homeassistant_services(const SubscribeHomeassistantServicesRequest &msg) override {
    this->service_call_subscription_ = true;
  }
  void subscribe_home_assistant_states(const SubscribeHomeAssistantStatesRequest &msg) override;
  GetTimeResponse get_time(const GetTimeRequest &msg) override {
    // TODO
    return {};
  }
  void execute_service(const ExecuteServiceRequest &msg) override;
#ifdef USE_API_NOISE
  NoiseEncryptionSetKeyResponse noise_encryption_set_key(const NoiseEncryptionSetKeyRequest &msg) override;
#endif
 
  bool is_authenticated() override { return this->connection_state_ == ConnectionState::AUTHENTICATED; }
  bool is_connection_setup() override {
    return this->connection_state_ == ConnectionState ::CONNECTED || this->is_authenticated();
  }
  void on_fatal_error() override;
  void on_unauthenticated_access() override;
  void on_no_setup_connection() override;
  ProtoWriteBuffer create_buffer(uint32_t reserve_size) override {
    // FIXME: ensure no recursive writes can happen
    this->proto_write_buffer_.clear();
    // Get header padding size - used for both reserve and insert
    uint8_t header_padding = this->helper_->frame_header_padding();
    // Reserve space for header padding + message + footer
    // - Header padding: space for protocol headers (7 bytes for Noise, 6 for Plaintext)
    // - Footer: space for MAC (16 bytes for Noise, 0 for Plaintext)
    this->proto_write_buffer_.reserve(reserve_size + header_padding + this->helper_->frame_footer_size());
    // Insert header padding bytes so message encoding starts at the correct position
    this->proto_write_buffer_.insert(this->proto_write_buffer_.begin(), header_padding, 0);
    return {&this->proto_write_buffer_};
  }
  bool try_to_clear_buffer(bool log_out_of_space);
  bool send_buffer(ProtoWriteBuffer buffer, uint32_t message_type) override;
 
  std::string get_client_combined_info() const { return this->client_combined_info_; }
 
 protected:
  friend APIServer;
 
  bool send_state_(esphome::EntityBase *entity, send_message_t try_send_func) {
    if (!this->state_subscription_)
      return false;
    if (this->try_to_clear_buffer(true) && (this->*try_send_func)(entity)) {
      return true;
    }
    this->deferred_message_queue_.defer(entity, try_send_func);
    return true;
  }
 
  template<typename EntityT, typename StateT, typename... Args>
  bool send_state_with_value_(EntityT *entity, bool (APIConnection::*try_send_entity_func)(EntityT *),
                              bool (APIConnection::*try_send_state_func)(EntityT *, StateT, Args...), StateT state,
                              Args... args) {
    if (!this->state_subscription_)
      return false;
    if (this->try_to_clear_buffer(true) && (this->*try_send_state_func)(entity, state, args...)) {
      return true;
    }
    this->deferred_message_queue_.defer(entity, reinterpret_cast<send_message_t>(try_send_entity_func));
    return true;
  }
 
  void send_info_(esphome::EntityBase *entity, send_message_t try_send_func) {
    if (this->try_to_clear_buffer(true) && (this->*try_send_func)(entity)) {
      return;
    }
    this->deferred_message_queue_.defer(entity, try_send_func);
  }
 
  template<typename ResponseT>
  bool try_send_entity_info_(esphome::EntityBase *entity, ResponseT &response,
                             bool (APIServerConnectionBase::*send_response_func)(const ResponseT &)) {
    // Set common fields that are shared by all entity types
    response.key = entity->get_object_id_hash();
    response.object_id = entity->get_object_id();
 
    if (entity->has_own_name())
      response.name = entity->get_name();
 
    // Set common EntityBase properties
    response.icon = entity->get_icon();
    response.disabled_by_default = entity->is_disabled_by_default();
    response.entity_category = static_cast<enums::EntityCategory>(entity->get_entity_category());
 
    // Send the response using the provided send method
    return (this->*send_response_func)(response);
  }
 
  bool send_(const void *buf, size_t len, bool force);
 
  enum class ConnectionState {
    WAITING_FOR_HELLO,
    CONNECTED,
    AUTHENTICATED,
  } connection_state_{ConnectionState::WAITING_FOR_HELLO};
 
  bool remove_{false};
 
  // Buffer used to encode proto messages
  // Re-use to prevent allocations
  std::vector<uint8_t> proto_write_buffer_;
  std::unique_ptr<APIFrameHelper> helper_;
 
  std::string client_info_;
  std::string client_peername_;
  std::string client_combined_info_;
  uint32_t client_api_version_major_{0};
  uint32_t client_api_version_minor_{0};
#ifdef USE_ESP32_CAMERA
  esp32_camera::CameraImageReader image_reader_;
#endif
 
  bool state_subscription_{false};
  int log_subscription_{ESPHOME_LOG_LEVEL_NONE};
  uint32_t last_traffic_;
  uint32_t next_ping_retry_{0};
  uint8_t ping_retries_{0};
  bool sent_ping_{false};
  bool service_call_subscription_{false};
  bool next_close_ = false;
  APIServer *parent_;
  DeferredMessageQueue deferred_message_queue_;
  InitialStateIterator initial_state_iterator_;
  ListEntitiesIterator list_entities_iterator_;
  int state_subs_at_ = -1;
};
 
}  // namespace api
}  // namespace esphome
#endif