Webserver utilize Component Iterator to not overload eventstream (#3310)

2026-05-21 21:43:26 +02:00 · 2022-03-23 09:45:05 +13:00
parent e621b938e3
commit bfbf88b2ea
13 changed files with 217 additions and 134 deletions
@@ -0,0 +1,120 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/core/controller.h"
+#include "esphome/core/helpers.h"
+
+#ifdef USE_ESP32_CAMERA
+#include "esphome/components/esp32_camera/esp32_camera.h"
+#endif
+
+namespace esphome {
+
+#ifdef USE_API
+namespace api {
+class UserServiceDescriptor;
+}  // namespace api
+#endif
+
+class ComponentIterator {
+ public:
+  void begin(bool include_internal = false);
+  void advance();
+  virtual bool on_begin();
+#ifdef USE_BINARY_SENSOR
+  virtual bool on_binary_sensor(binary_sensor::BinarySensor *binary_sensor) = 0;
+#endif
+#ifdef USE_COVER
+  virtual bool on_cover(cover::Cover *cover) = 0;
+#endif
+#ifdef USE_FAN
+  virtual bool on_fan(fan::Fan *fan) = 0;
+#endif
+#ifdef USE_LIGHT
+  virtual bool on_light(light::LightState *light) = 0;
+#endif
+#ifdef USE_SENSOR
+  virtual bool on_sensor(sensor::Sensor *sensor) = 0;
+#endif
+#ifdef USE_SWITCH
+  virtual bool on_switch(switch_::Switch *a_switch) = 0;
+#endif
+#ifdef USE_BUTTON
+  virtual bool on_button(button::Button *button) = 0;
+#endif
+#ifdef USE_TEXT_SENSOR
+  virtual bool on_text_sensor(text_sensor::TextSensor *text_sensor) = 0;
+#endif
+#ifdef USE_API
+  virtual bool on_service(api::UserServiceDescriptor *service);
+#endif
+#ifdef USE_ESP32_CAMERA
+  virtual bool on_camera(esp32_camera::ESP32Camera *camera);
+#endif
+#ifdef USE_CLIMATE
+  virtual bool on_climate(climate::Climate *climate) = 0;
+#endif
+#ifdef USE_NUMBER
+  virtual bool on_number(number::Number *number) = 0;
+#endif
+#ifdef USE_SELECT
+  virtual bool on_select(select::Select *select) = 0;
+#endif
+#ifdef USE_LOCK
+  virtual bool on_lock(lock::Lock *a_lock) = 0;
+#endif
+  virtual bool on_end();
+
+ protected:
+  enum class IteratorState {
+    NONE = 0,
+    BEGIN,
+#ifdef USE_BINARY_SENSOR
+    BINARY_SENSOR,
+#endif
+#ifdef USE_COVER
+    COVER,
+#endif
+#ifdef USE_FAN
+    FAN,
+#endif
+#ifdef USE_LIGHT
+    LIGHT,
+#endif
+#ifdef USE_SENSOR
+    SENSOR,
+#endif
+#ifdef USE_SWITCH
+    SWITCH,
+#endif
+#ifdef USE_BUTTON
+    BUTTON,
+#endif
+#ifdef USE_TEXT_SENSOR
+    TEXT_SENSOR,
+#endif
+#ifdef USE_API
+    SERVICE,
+#endif
+#ifdef USE_ESP32_CAMERA
+    CAMERA,
+#endif
+#ifdef USE_CLIMATE
+    CLIMATE,
+#endif
+#ifdef USE_NUMBER
+    NUMBER,
+#endif
+#ifdef USE_SELECT
+    SELECT,
+#endif
+#ifdef USE_LOCK
+    LOCK,
+#endif
+    MAX,
+  } state_{IteratorState::NONE};
+  size_t at_{0};
+  bool include_internal_{false};
+};
+
+}  // namespace esphome