ESPHome  2024.5.4
component_iterator.h
Go to the documentation of this file.
1 #pragma once
2 
5 #include "esphome/core/helpers.h"
6 
7 #ifdef USE_ESP32_CAMERA
9 #endif
10 
11 namespace esphome {
12 
13 #ifdef USE_API
14 namespace api {
15 class UserServiceDescriptor;
16 } // namespace api
17 #endif
18 
20  public:
21  void begin(bool include_internal = false);
22  void advance();
23  virtual bool on_begin();
24 #ifdef USE_BINARY_SENSOR
25  virtual bool on_binary_sensor(binary_sensor::BinarySensor *binary_sensor) = 0;
26 #endif
27 #ifdef USE_COVER
28  virtual bool on_cover(cover::Cover *cover) = 0;
29 #endif
30 #ifdef USE_FAN
31  virtual bool on_fan(fan::Fan *fan) = 0;
32 #endif
33 #ifdef USE_LIGHT
34  virtual bool on_light(light::LightState *light) = 0;
35 #endif
36 #ifdef USE_SENSOR
37  virtual bool on_sensor(sensor::Sensor *sensor) = 0;
38 #endif
39 #ifdef USE_SWITCH
40  virtual bool on_switch(switch_::Switch *a_switch) = 0;
41 #endif
42 #ifdef USE_BUTTON
43  virtual bool on_button(button::Button *button) = 0;
44 #endif
45 #ifdef USE_TEXT_SENSOR
46  virtual bool on_text_sensor(text_sensor::TextSensor *text_sensor) = 0;
47 #endif
48 #ifdef USE_API
49  virtual bool on_service(api::UserServiceDescriptor *service);
50 #endif
51 #ifdef USE_ESP32_CAMERA
52  virtual bool on_camera(esp32_camera::ESP32Camera *camera);
53 #endif
54 #ifdef USE_CLIMATE
55  virtual bool on_climate(climate::Climate *climate) = 0;
56 #endif
57 #ifdef USE_NUMBER
58  virtual bool on_number(number::Number *number) = 0;
59 #endif
60 #ifdef USE_DATETIME_DATE
61  virtual bool on_date(datetime::DateEntity *date) = 0;
62 #endif
63 #ifdef USE_DATETIME_TIME
64  virtual bool on_time(datetime::TimeEntity *time) = 0;
65 #endif
66 #ifdef USE_DATETIME_DATETIME
67  virtual bool on_datetime(datetime::DateTimeEntity *datetime) = 0;
68 #endif
69 #ifdef USE_TEXT
70  virtual bool on_text(text::Text *text) = 0;
71 #endif
72 #ifdef USE_SELECT
73  virtual bool on_select(select::Select *select) = 0;
74 #endif
75 #ifdef USE_LOCK
76  virtual bool on_lock(lock::Lock *a_lock) = 0;
77 #endif
78 #ifdef USE_VALVE
79  virtual bool on_valve(valve::Valve *valve) = 0;
80 #endif
81 #ifdef USE_MEDIA_PLAYER
82  virtual bool on_media_player(media_player::MediaPlayer *media_player);
83 #endif
84 #ifdef USE_ALARM_CONTROL_PANEL
85  virtual bool on_alarm_control_panel(alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) = 0;
86 #endif
87 #ifdef USE_EVENT
88  virtual bool on_event(event::Event *event) = 0;
89 #endif
90  virtual bool on_end();
91 
92  protected:
93  enum class IteratorState {
94  NONE = 0,
95  BEGIN,
96 #ifdef USE_BINARY_SENSOR
98 #endif
99 #ifdef USE_COVER
100  COVER,
101 #endif
102 #ifdef USE_FAN
103  FAN,
104 #endif
105 #ifdef USE_LIGHT
106  LIGHT,
107 #endif
108 #ifdef USE_SENSOR
109  SENSOR,
110 #endif
111 #ifdef USE_SWITCH
112  SWITCH,
113 #endif
114 #ifdef USE_BUTTON
115  BUTTON,
116 #endif
117 #ifdef USE_TEXT_SENSOR
118  TEXT_SENSOR,
119 #endif
120 #ifdef USE_API
121  SERVICE,
122 #endif
123 #ifdef USE_ESP32_CAMERA
124  CAMERA,
125 #endif
126 #ifdef USE_CLIMATE
127  CLIMATE,
128 #endif
129 #ifdef USE_NUMBER
130  NUMBER,
131 #endif
132 #ifdef USE_DATETIME_DATE
133  DATETIME_DATE,
134 #endif
135 #ifdef USE_DATETIME_TIME
136  DATETIME_TIME,
137 #endif
138 #ifdef USE_DATETIME_DATETIME
139  DATETIME_DATETIME,
140 #endif
141 #ifdef USE_TEXT
142  TEXT,
143 #endif
144 #ifdef USE_SELECT
145  SELECT,
146 #endif
147 #ifdef USE_LOCK
148  LOCK,
149 #endif
150 #ifdef USE_VALVE
151  VALVE,
152 #endif
153 #ifdef USE_MEDIA_PLAYER
154  MEDIA_PLAYER,
155 #endif
156 #ifdef USE_ALARM_CONTROL_PANEL
157  ALARM_CONTROL_PANEL,
158 #endif
159 #ifdef USE_EVENT
160  EVENT,
161 #endif
162  MAX,
163  } state_{IteratorState::NONE};
164  size_t at_{0};
165  bool include_internal_{false};
166 };
167 
168 } // namespace esphome
Base class for all switches.
Definition: switch.h:39
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
Definition: light_state.h:34
Base class for all cover devices.
Definition: cover.h:111
Base class for all buttons.
Definition: button.h:29
Base-class for all text inputs.
Definition: text.h:24
Base-class for all numbers.
Definition: number.h:39
Base-class for all selects.
Definition: select.h:31
This is a workaround until we can figure out a way to get the tflite-micro idf component code availab...
Definition: a01nyub.cpp:7
Base class for all valve devices.
Definition: valve.h:105
Base class for all binary_sensor-type classes.
Definition: binary_sensor.h:37
Base-class for all sensors.
Definition: sensor.h:57
Base class for all locks.
Definition: lock.h:103
ClimateDevice - This is the base class for all climate integrations.
Definition: climate.h:168