esphome 2025.6.3__py3-none-any.whl → 2025.7.0__py3-none-any.whl

esphome/components/api/custom_api_device.h

@@ -3,10 +3,13 @@
 #include <map>
 #include "api_server.h"
 #ifdef USE_API
+#ifdef USE_API_SERVICES
 #include "user_services.h"
+#endif
 namespace esphome {
 namespace api {
 
+#ifdef USE_API_SERVICES
 template<typename T, typename... Ts> class CustomAPIDeviceService : public UserServiceBase<Ts...> {
  public:
   CustomAPIDeviceService(const std::string &name, const std::array<std::string, sizeof...(Ts)> &arg_names, T *obj,
@@ -19,6 +22,7 @@ template<typename T, typename... Ts> class CustomAPIDeviceService : public UserS
   T *obj_;
   void (T::*callback_)(Ts...);
 };
+#endif  // USE_API_SERVICES
 
 class CustomAPIDevice {
  public:
@@ -46,12 +50,14 @@ class CustomAPIDevice {
    * @param name The name of the service to register.
    * @param arg_names The name of the arguments for the service, must match the arguments of the function.
    */
+#ifdef USE_API_SERVICES
   template<typename T, typename... Ts>
   void register_service(void (T::*callback)(Ts...), const std::string &name,
                         const std::array<std::string, sizeof...(Ts)> &arg_names) {
     auto *service = new CustomAPIDeviceService<T, Ts...>(name, arg_names, (T *) this, callback);  // NOLINT
     global_api_server->register_user_service(service);
   }
+#endif
 
   /** Register a custom native API service that will show up in Home Assistant.
    *
@@ -71,10 +77,12 @@ class CustomAPIDevice {
    * @param callback The member function to call when the service is triggered.
    * @param name The name of the arguments for the service, must match the arguments of the function.
    */
+#ifdef USE_API_SERVICES
   template<typename T> void register_service(void (T::*callback)(), const std::string &name) {
     auto *service = new CustomAPIDeviceService<T>(name, {}, (T *) this, callback);  // NOLINT
     global_api_server->register_user_service(service);
   }
+#endif
 
   /** Subscribe to the state (or attribute state) of an entity from Home Assistant.
    *

esphome/components/api/list_entities.cpp

@@ -1,6 +1,7 @@
 #include "list_entities.h"
 #ifdef USE_API
 #include "api_connection.h"
+#include "api_pb2.h"
 #include "esphome/core/application.h"
 #include "esphome/core/log.h"
 #include "esphome/core/util.h"
@@ -8,152 +9,84 @@
 namespace esphome {
 namespace api {
 
+// Generate entity handler implementations using macros
 #ifdef USE_BINARY_SENSOR
-bool ListEntitiesIterator::on_binary_sensor(binary_sensor::BinarySensor *binary_sensor) {
-  this->client_->send_binary_sensor_info(binary_sensor);
-  return true;
-}
+LIST_ENTITIES_HANDLER(binary_sensor, binary_sensor::BinarySensor, ListEntitiesBinarySensorResponse)
 #endif
 #ifdef USE_COVER
-bool ListEntitiesIterator::on_cover(cover::Cover *cover) {
-  this->client_->send_cover_info(cover);
-  return true;
-}
+LIST_ENTITIES_HANDLER(cover, cover::Cover, ListEntitiesCoverResponse)
 #endif
 #ifdef USE_FAN
-bool ListEntitiesIterator::on_fan(fan::Fan *fan) {
-  this->client_->send_fan_info(fan);
-  return true;
-}
+LIST_ENTITIES_HANDLER(fan, fan::Fan, ListEntitiesFanResponse)
 #endif
 #ifdef USE_LIGHT
-bool ListEntitiesIterator::on_light(light::LightState *light) {
-  this->client_->send_light_info(light);
-  return true;
-}
+LIST_ENTITIES_HANDLER(light, light::LightState, ListEntitiesLightResponse)
 #endif
 #ifdef USE_SENSOR
-bool ListEntitiesIterator::on_sensor(sensor::Sensor *sensor) {
-  this->client_->send_sensor_info(sensor);
-  return true;
-}
+LIST_ENTITIES_HANDLER(sensor, sensor::Sensor, ListEntitiesSensorResponse)
 #endif
 #ifdef USE_SWITCH
-bool ListEntitiesIterator::on_switch(switch_::Switch *a_switch) {
-  this->client_->send_switch_info(a_switch);
-  return true;
-}
+LIST_ENTITIES_HANDLER(switch, switch_::Switch, ListEntitiesSwitchResponse)
 #endif
 #ifdef USE_BUTTON
-bool ListEntitiesIterator::on_button(button::Button *button) {
-  this->client_->send_button_info(button);
-  return true;
-}
+LIST_ENTITIES_HANDLER(button, button::Button, ListEntitiesButtonResponse)
 #endif
 #ifdef USE_TEXT_SENSOR
-bool ListEntitiesIterator::on_text_sensor(text_sensor::TextSensor *text_sensor) {
-  this->client_->send_text_sensor_info(text_sensor);
-  return true;
-}
+LIST_ENTITIES_HANDLER(text_sensor, text_sensor::TextSensor, ListEntitiesTextSensorResponse)
 #endif
 #ifdef USE_LOCK
-bool ListEntitiesIterator::on_lock(lock::Lock *a_lock) {
-  this->client_->send_lock_info(a_lock);
-  return true;
-}
+LIST_ENTITIES_HANDLER(lock, lock::Lock, ListEntitiesLockResponse)
 #endif
 #ifdef USE_VALVE
-bool ListEntitiesIterator::on_valve(valve::Valve *valve) {
-  this->client_->send_valve_info(valve);
-  return true;
-}
+LIST_ENTITIES_HANDLER(valve, valve::Valve, ListEntitiesValveResponse)
 #endif
-
-bool ListEntitiesIterator::on_end() { return this->client_->send_list_info_done(); }
-ListEntitiesIterator::ListEntitiesIterator(APIConnection *client) : client_(client) {}
-bool ListEntitiesIterator::on_service(UserServiceDescriptor *service) {
-  auto resp = service->encode_list_service_response();
-  return this->client_->send_message(resp);
-}
-
-#ifdef USE_ESP32_CAMERA
-bool ListEntitiesIterator::on_camera(esp32_camera::ESP32Camera *camera) {
-  this->client_->send_camera_info(camera);
-  return true;
-}
+#ifdef USE_CAMERA
+LIST_ENTITIES_HANDLER(camera, camera::Camera, ListEntitiesCameraResponse)
 #endif
-
 #ifdef USE_CLIMATE
-bool ListEntitiesIterator::on_climate(climate::Climate *climate) {
-  this->client_->send_climate_info(climate);
-  return true;
-}
+LIST_ENTITIES_HANDLER(climate, climate::Climate, ListEntitiesClimateResponse)
 #endif
-
 #ifdef USE_NUMBER
-bool ListEntitiesIterator::on_number(number::Number *number) {
-  this->client_->send_number_info(number);
-  return true;
-}
+LIST_ENTITIES_HANDLER(number, number::Number, ListEntitiesNumberResponse)
 #endif
-
 #ifdef USE_DATETIME_DATE
-bool ListEntitiesIterator::on_date(datetime::DateEntity *date) {
-  this->client_->send_date_info(date);
-  return true;
-}
+LIST_ENTITIES_HANDLER(date, datetime::DateEntity, ListEntitiesDateResponse)
 #endif
-
 #ifdef USE_DATETIME_TIME
-bool ListEntitiesIterator::on_time(datetime::TimeEntity *time) {
-  this->client_->send_time_info(time);
-  return true;
-}
+LIST_ENTITIES_HANDLER(time, datetime::TimeEntity, ListEntitiesTimeResponse)
 #endif
-
 #ifdef USE_DATETIME_DATETIME
-bool ListEntitiesIterator::on_datetime(datetime::DateTimeEntity *datetime) {
-  this->client_->send_datetime_info(datetime);
-  return true;
-}
+LIST_ENTITIES_HANDLER(datetime, datetime::DateTimeEntity, ListEntitiesDateTimeResponse)
 #endif
-
 #ifdef USE_TEXT
-bool ListEntitiesIterator::on_text(text::Text *text) {
-  this->client_->send_text_info(text);
-  return true;
-}
+LIST_ENTITIES_HANDLER(text, text::Text, ListEntitiesTextResponse)
 #endif
-
 #ifdef USE_SELECT
-bool ListEntitiesIterator::on_select(select::Select *select) {
-  this->client_->send_select_info(select);
-  return true;
-}
+LIST_ENTITIES_HANDLER(select, select::Select, ListEntitiesSelectResponse)
 #endif
-
 #ifdef USE_MEDIA_PLAYER
-bool ListEntitiesIterator::on_media_player(media_player::MediaPlayer *media_player) {
-  this->client_->send_media_player_info(media_player);
-  return true;
-}
+LIST_ENTITIES_HANDLER(media_player, media_player::MediaPlayer, ListEntitiesMediaPlayerResponse)
 #endif
 #ifdef USE_ALARM_CONTROL_PANEL
-bool ListEntitiesIterator::on_alarm_control_panel(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) {
-  this->client_->send_alarm_control_panel_info(a_alarm_control_panel);
-  return true;
-}
+LIST_ENTITIES_HANDLER(alarm_control_panel, alarm_control_panel::AlarmControlPanel,
+                      ListEntitiesAlarmControlPanelResponse)
 #endif
 #ifdef USE_EVENT
-bool ListEntitiesIterator::on_event(event::Event *event) {
-  this->client_->send_event_info(event);
-  return true;
-}
+LIST_ENTITIES_HANDLER(event, event::Event, ListEntitiesEventResponse)
 #endif
 #ifdef USE_UPDATE
-bool ListEntitiesIterator::on_update(update::UpdateEntity *update) {
-  this->client_->send_update_info(update);
-  return true;
+LIST_ENTITIES_HANDLER(update, update::UpdateEntity, ListEntitiesUpdateResponse)
+#endif
+
+// Special cases that don't follow the pattern
+bool ListEntitiesIterator::on_end() { return this->client_->send_list_info_done(); }
+
+ListEntitiesIterator::ListEntitiesIterator(APIConnection *client) : client_(client) {}
+
+#ifdef USE_API_SERVICES
+bool ListEntitiesIterator::on_service(UserServiceDescriptor *service) {
+  auto resp = service->encode_list_service_response();
+  return this->client_->send_message(resp);
 }
 #endif
 

esphome/components/api/list_entities.h

@@ -9,75 +9,85 @@ namespace api {
 
 class APIConnection;
 
+// Macro for generating ListEntitiesIterator handlers
+// Calls schedule_message_ with try_send_*_info
+#define LIST_ENTITIES_HANDLER(entity_type, EntityClass, ResponseType) \
+  bool ListEntitiesIterator::on_##entity_type(EntityClass *entity) { /* NOLINT(bugprone-macro-parentheses) */ \
+    return this->client_->schedule_message_(entity, &APIConnection::try_send_##entity_type##_info, \
+                                            ResponseType::MESSAGE_TYPE, ResponseType::ESTIMATED_SIZE); \
+  }
+
 class ListEntitiesIterator : public ComponentIterator {
  public:
   ListEntitiesIterator(APIConnection *client);
 #ifdef USE_BINARY_SENSOR
-  bool on_binary_sensor(binary_sensor::BinarySensor *binary_sensor) override;
+  bool on_binary_sensor(binary_sensor::BinarySensor *entity) override;
 #endif
 #ifdef USE_COVER
-  bool on_cover(cover::Cover *cover) override;
+  bool on_cover(cover::Cover *entity) override;
 #endif
 #ifdef USE_FAN
-  bool on_fan(fan::Fan *fan) override;
+  bool on_fan(fan::Fan *entity) override;
 #endif
 #ifdef USE_LIGHT
-  bool on_light(light::LightState *light) override;
+  bool on_light(light::LightState *entity) override;
 #endif
 #ifdef USE_SENSOR
-  bool on_sensor(sensor::Sensor *sensor) override;
+  bool on_sensor(sensor::Sensor *entity) override;
 #endif
 #ifdef USE_SWITCH
-  bool on_switch(switch_::Switch *a_switch) override;
+  bool on_switch(switch_::Switch *entity) override;
 #endif
 #ifdef USE_BUTTON
-  bool on_button(button::Button *button) override;
+  bool on_button(button::Button *entity) override;
 #endif
 #ifdef USE_TEXT_SENSOR
-  bool on_text_sensor(text_sensor::TextSensor *text_sensor) override;
+  bool on_text_sensor(text_sensor::TextSensor *entity) override;
 #endif
+#ifdef USE_API_SERVICES
   bool on_service(UserServiceDescriptor *service) override;
-#ifdef USE_ESP32_CAMERA
-  bool on_camera(esp32_camera::ESP32Camera *camera) override;
+#endif
+#ifdef USE_CAMERA
+  bool on_camera(camera::Camera *entity) override;
 #endif
 #ifdef USE_CLIMATE
-  bool on_climate(climate::Climate *climate) override;
+  bool on_climate(climate::Climate *entity) override;
 #endif
 #ifdef USE_NUMBER
-  bool on_number(number::Number *number) override;
+  bool on_number(number::Number *entity) override;
 #endif
 #ifdef USE_DATETIME_DATE
-  bool on_date(datetime::DateEntity *date) override;
+  bool on_date(datetime::DateEntity *entity) override;
 #endif
 #ifdef USE_DATETIME_TIME
-  bool on_time(datetime::TimeEntity *time) override;
+  bool on_time(datetime::TimeEntity *entity) override;
 #endif
 #ifdef USE_DATETIME_DATETIME
-  bool on_datetime(datetime::DateTimeEntity *datetime) override;
+  bool on_datetime(datetime::DateTimeEntity *entity) override;
 #endif
 #ifdef USE_TEXT
-  bool on_text(text::Text *text) override;
+  bool on_text(text::Text *entity) override;
 #endif
 #ifdef USE_SELECT
-  bool on_select(select::Select *select) override;
+  bool on_select(select::Select *entity) override;
 #endif
 #ifdef USE_LOCK
-  bool on_lock(lock::Lock *a_lock) override;
+  bool on_lock(lock::Lock *entity) override;
 #endif
 #ifdef USE_VALVE
-  bool on_valve(valve::Valve *valve) override;
+  bool on_valve(valve::Valve *entity) override;
 #endif
 #ifdef USE_MEDIA_PLAYER
-  bool on_media_player(media_player::MediaPlayer *media_player) override;
+  bool on_media_player(media_player::MediaPlayer *entity) override;
 #endif
 #ifdef USE_ALARM_CONTROL_PANEL
-  bool on_alarm_control_panel(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) override;
+  bool on_alarm_control_panel(alarm_control_panel::AlarmControlPanel *entity) override;
 #endif
 #ifdef USE_EVENT
-  bool on_event(event::Event *event) override;
+  bool on_event(event::Event *entity) override;
 #endif
 #ifdef USE_UPDATE
-  bool on_update(update::UpdateEntity *update) override;
+  bool on_update(update::UpdateEntity *entity) override;
 #endif
   bool on_end() override;
   bool completed() { return this->state_ == IteratorState::NONE; }