ESPHome  2024.3.1
component.cpp
Go to the documentation of this file.
2 
4 #include "esphome/core/hal.h"
5 #include "esphome/core/helpers.h"
6 #include "esphome/core/log.h"
7 #include <utility>
8 #include <cinttypes>
9 
10 namespace esphome {
11 
12 static const char *const TAG = "component";
13 
14 namespace setup_priority {
15 
16 const float BUS = 1000.0f;
17 const float IO = 900.0f;
18 const float HARDWARE = 800.0f;
19 const float DATA = 600.0f;
20 const float PROCESSOR = 400.0;
21 const float BLUETOOTH = 350.0f;
22 const float AFTER_BLUETOOTH = 300.0f;
23 const float WIFI = 250.0f;
24 const float ETHERNET = 250.0f;
25 const float BEFORE_CONNECTION = 220.0f;
26 const float AFTER_WIFI = 200.0f;
27 const float AFTER_CONNECTION = 100.0f;
28 const float LATE = -100.0f;
29 
30 } // namespace setup_priority
31 
32 const uint32_t COMPONENT_STATE_MASK = 0xFF;
33 const uint32_t COMPONENT_STATE_CONSTRUCTION = 0x00;
34 const uint32_t COMPONENT_STATE_SETUP = 0x01;
35 const uint32_t COMPONENT_STATE_LOOP = 0x02;
36 const uint32_t COMPONENT_STATE_FAILED = 0x03;
37 const uint32_t STATUS_LED_MASK = 0xFF00;
38 const uint32_t STATUS_LED_OK = 0x0000;
39 const uint32_t STATUS_LED_WARNING = 0x0100;
40 const uint32_t STATUS_LED_ERROR = 0x0200;
41 
42 uint32_t global_state = 0; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
43 
44 float Component::get_loop_priority() const { return 0.0f; }
45 
47 
49 
50 void Component::loop() {}
51 
52 void Component::set_interval(const std::string &name, uint32_t interval, std::function<void()> &&f) { // NOLINT
53  App.scheduler.set_interval(this, name, interval, std::move(f));
54 }
55 
56 bool Component::cancel_interval(const std::string &name) { // NOLINT
57  return App.scheduler.cancel_interval(this, name);
58 }
59 
60 void Component::set_retry(const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts,
61  std::function<RetryResult(uint8_t)> &&f, float backoff_increase_factor) { // NOLINT
62  App.scheduler.set_retry(this, name, initial_wait_time, max_attempts, std::move(f), backoff_increase_factor);
63 }
64 
65 bool Component::cancel_retry(const std::string &name) { // NOLINT
66  return App.scheduler.cancel_retry(this, name);
67 }
68 
69 void Component::set_timeout(const std::string &name, uint32_t timeout, std::function<void()> &&f) { // NOLINT
70  return App.scheduler.set_timeout(this, name, timeout, std::move(f));
71 }
72 
73 bool Component::cancel_timeout(const std::string &name) { // NOLINT
74  return App.scheduler.cancel_timeout(this, name);
75 }
76 
77 void Component::call_loop() { this->loop(); }
78 void Component::call_setup() { this->setup(); }
79 void Component::call_dump_config() { this->dump_config(); }
80 
81 uint32_t Component::get_component_state() const { return this->component_state_; }
83  uint32_t state = this->component_state_ & COMPONENT_STATE_MASK;
84  switch (state) {
86  // State Construction: Call setup and set state to setup
87  this->component_state_ &= ~COMPONENT_STATE_MASK;
88  this->component_state_ |= COMPONENT_STATE_SETUP;
89  this->call_setup();
90  break;
92  // State setup: Call first loop and set state to loop
93  this->component_state_ &= ~COMPONENT_STATE_MASK;
94  this->component_state_ |= COMPONENT_STATE_LOOP;
95  this->call_loop();
96  break;
98  // State loop: Call loop
99  this->call_loop();
100  break;
101  case COMPONENT_STATE_FAILED: // NOLINT(bugprone-branch-clone)
102  // State failed: Do nothing
103  break;
104  default:
105  break;
106  }
107 }
108 const char *Component::get_component_source() const {
109  if (this->component_source_ == nullptr)
110  return "<unknown>";
111  return this->component_source_;
112 }
114  ESP_LOGE(TAG, "Component %s was marked as failed.", this->get_component_source());
115  this->component_state_ &= ~COMPONENT_STATE_MASK;
116  this->component_state_ |= COMPONENT_STATE_FAILED;
117  this->status_set_error();
118 }
119 void Component::defer(std::function<void()> &&f) { // NOLINT
120  App.scheduler.set_timeout(this, "", 0, std::move(f));
121 }
122 bool Component::cancel_defer(const std::string &name) { // NOLINT
123  return App.scheduler.cancel_timeout(this, name);
124 }
125 void Component::defer(const std::string &name, std::function<void()> &&f) { // NOLINT
126  App.scheduler.set_timeout(this, name, 0, std::move(f));
127 }
128 void Component::set_timeout(uint32_t timeout, std::function<void()> &&f) { // NOLINT
129  App.scheduler.set_timeout(this, "", timeout, std::move(f));
130 }
131 void Component::set_interval(uint32_t interval, std::function<void()> &&f) { // NOLINT
132  App.scheduler.set_interval(this, "", interval, std::move(f));
133 }
134 void Component::set_retry(uint32_t initial_wait_time, uint8_t max_attempts, std::function<RetryResult(uint8_t)> &&f,
135  float backoff_increase_factor) { // NOLINT
136  App.scheduler.set_retry(this, "", initial_wait_time, max_attempts, std::move(f), backoff_increase_factor);
137 }
138 bool Component::is_failed() { return (this->component_state_ & COMPONENT_STATE_MASK) == COMPONENT_STATE_FAILED; }
140  return (this->component_state_ & COMPONENT_STATE_MASK) == COMPONENT_STATE_LOOP ||
141  (this->component_state_ & COMPONENT_STATE_MASK) == COMPONENT_STATE_SETUP;
142 }
143 bool Component::can_proceed() { return true; }
144 bool Component::status_has_warning() const { return this->component_state_ & STATUS_LED_WARNING; }
145 bool Component::status_has_error() const { return this->component_state_ & STATUS_LED_ERROR; }
146 void Component::status_set_warning(const char *message) {
147  // Don't spam the log. This risks missing different warning messages though.
148  if ((this->component_state_ & STATUS_LED_WARNING) != 0)
149  return;
150  this->component_state_ |= STATUS_LED_WARNING;
152  ESP_LOGW(this->get_component_source(), "Warning set: %s", message);
153 }
154 void Component::status_set_error(const char *message) {
155  if ((this->component_state_ & STATUS_LED_ERROR) != 0)
156  return;
157  this->component_state_ |= STATUS_LED_ERROR;
159  ESP_LOGE(this->get_component_source(), "Error set: %s", message);
160 }
162  if ((this->component_state_ & STATUS_LED_WARNING) == 0)
163  return;
164  this->component_state_ &= ~STATUS_LED_WARNING;
165  ESP_LOGW(this->get_component_source(), "Warning cleared");
166 }
168  if ((this->component_state_ & STATUS_LED_ERROR) == 0)
169  return;
170  this->component_state_ &= ~STATUS_LED_ERROR;
171  ESP_LOGE(this->get_component_source(), "Error cleared");
172 }
173 void Component::status_momentary_warning(const std::string &name, uint32_t length) {
174  this->status_set_warning();
175  this->set_timeout(name, length, [this]() { this->status_clear_warning(); });
176 }
177 void Component::status_momentary_error(const std::string &name, uint32_t length) {
178  this->status_set_error();
179  this->set_timeout(name, length, [this]() { this->status_clear_error(); });
180 }
183  if (std::isnan(this->setup_priority_override_))
184  return this->get_setup_priority();
185  return this->setup_priority_override_;
186 }
187 void Component::set_setup_priority(float priority) { this->setup_priority_override_ = priority; }
188 
190 #if defined(USE_HOST) || defined(CLANG_TIDY)
191  bool loop_overridden = true;
192  bool call_loop_overridden = true;
193 #else
194 #pragma GCC diagnostic push
195 #pragma GCC diagnostic ignored "-Wpmf-conversions"
196  bool loop_overridden = (void *) (this->*(&Component::loop)) != (void *) (&Component::loop);
197  bool call_loop_overridden = (void *) (this->*(&Component::call_loop)) != (void *) (&Component::call_loop);
198 #pragma GCC diagnostic pop
199 #endif
200  return loop_overridden || call_loop_overridden;
201 }
202 
203 PollingComponent::PollingComponent(uint32_t update_interval) : update_interval_(update_interval) {}
204 
206  // Let the polling component subclass setup their HW.
207  this->setup();
208 
209  // init the poller
210  this->start_poller();
211 }
212 
214  // Register interval.
215  this->set_interval("update", this->get_update_interval(), [this]() { this->update(); });
216 }
217 
219  // Clear the interval to suspend component
220  this->cancel_interval("update");
221 }
222 
223 uint32_t PollingComponent::get_update_interval() const { return this->update_interval_; }
224 void PollingComponent::set_update_interval(uint32_t update_interval) { this->update_interval_ = update_interval; }
225 
227  : started_(millis()), component_(component) {}
229  uint32_t now = millis();
230  if (now - started_ > 50) {
231  const char *src = component_ == nullptr ? "<null>" : component_->get_component_source();
232  ESP_LOGW(TAG, "Component %s took a long time for an operation (%" PRIu32 " ms).", src, (now - started_));
233  ESP_LOGW(TAG, "Components should block for at most 30 ms.");
234  ;
235  }
236 }
237 
238 } // namespace esphome
void setup()
const uint32_t COMPONENT_STATE_LOOP
Definition: component.cpp:35
const uint32_t COMPONENT_STATE_FAILED
Definition: component.cpp:36
const char * name
Definition: stm32flash.h:78
void loop()
RetryResult
Definition: component.h:66
const float DATA
For components that import data from directly connected sensors like DHT.
Definition: component.cpp:19
virtual void loop()
This method will be called repeatedly.
Definition: component.cpp:50
void set_interval(const std::string &name, uint32_t interval, std::function< void()> &&f)
Set an interval function with a unique name.
Definition: component.cpp:52
const float BEFORE_CONNECTION
For components that should be initialized after WiFi and before API is connected. ...
Definition: component.cpp:25
const float AFTER_CONNECTION
For components that should be initialized after a data connection (API/MQTT) is connected.
Definition: component.cpp:27
virtual float get_loop_priority() const
priority of loop().
Definition: component.cpp:44
bool cancel_timeout(const std::string &name)
Cancel a timeout function.
Definition: component.cpp:73
const float AFTER_WIFI
For components that should be initialized after WiFi is connected.
Definition: component.cpp:26
void status_set_warning(const char *message="unspecified")
Definition: component.cpp:146
bool status_has_warning() const
Definition: component.cpp:144
bool cancel_timeout(Component *component, const std::string &name)
Definition: scheduler.cpp:45
void status_momentary_warning(const std::string &name, uint32_t length=5000)
Definition: component.cpp:173
float get_actual_setup_priority() const
Definition: component.cpp:182
void set_timeout(const std::string &name, uint32_t timeout, std::function< void()> &&f)
Set a timeout function with a unique name.
Definition: component.cpp:69
bool cancel_interval(const std::string &name)
Cancel an interval function.
Definition: component.cpp:56
const uint32_t STATUS_LED_OK
Definition: component.cpp:38
void set_setup_priority(float priority)
Definition: component.cpp:187
void defer(const std::string &name, std::function< void()> &&f)
Defer a callback to the next loop() call.
Definition: component.cpp:125
const float LATE
For components that should be initialized at the very end of the setup process.
Definition: component.cpp:28
bool has_overridden_loop() const
Definition: component.cpp:189
virtual void dump_config()
Definition: component.cpp:181
const float AFTER_BLUETOOTH
Definition: component.cpp:22
virtual void call_dump_config()
Definition: component.cpp:79
uint32_t IRAM_ATTR HOT millis()
Definition: core.cpp:25
void status_momentary_error(const std::string &name, uint32_t length=5000)
Definition: component.cpp:177
uint32_t global_state
Definition: component.cpp:42
bool status_has_error() const
Definition: component.cpp:145
virtual void call_setup()
Definition: component.cpp:78
const char *const TAG
Definition: spi.cpp:8
void set_retry(const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
Set an retry function with a unique name.
Definition: component.cpp:60
void set_retry(Component *component, const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> func, float backoff_increase_factor=1.0f)
Definition: scheduler.cpp:102
void status_set_error(const char *message="unspecified")
Definition: component.cpp:154
uint32_t get_component_state() const
Definition: component.cpp:81
const float BUS
For communication buses like i2c/spi.
Definition: component.cpp:16
virtual void setup()
Where the component&#39;s initialization should happen.
Definition: component.cpp:48
const uint32_t COMPONENT_STATE_SETUP
Definition: component.cpp:34
virtual float get_setup_priority() const
priority of setup().
Definition: component.cpp:46
void status_clear_warning()
Definition: component.cpp:161
const uint32_t COMPONENT_STATE_CONSTRUCTION
Definition: component.cpp:33
bool cancel_defer(const std::string &name)
Cancel a defer callback using the specified name, name must not be empty.
Definition: component.cpp:122
virtual void update()=0
const float PROCESSOR
For components that use data from sensors like displays.
Definition: component.cpp:20
const char * get_component_source() const
Get the integration where this component was declared as a string.
Definition: component.cpp:108
Application App
Global storage of Application pointer - only one Application can exist.
virtual bool can_proceed()
Definition: component.cpp:143
bool cancel_retry(Component *component, const std::string &name)
Definition: scheduler.cpp:133
WarnIfComponentBlockingGuard(Component *component)
Definition: component.cpp:226
const uint32_t COMPONENT_STATE_MASK
Definition: component.cpp:32
bool cancel_retry(const std::string &name)
Cancel a retry function.
Definition: component.cpp:65
virtual uint32_t get_update_interval() const
Get the update interval in ms of this sensor.
Definition: component.cpp:223
const uint32_t STATUS_LED_WARNING
Definition: component.cpp:39
uint8_t priority
void status_clear_error()
Definition: component.cpp:167
const float HARDWARE
For components that deal with hardware and are very important like GPIO switch.
Definition: component.cpp:18
void call_setup() override
Definition: component.cpp:205
virtual void mark_failed()
Mark this component as failed.
Definition: component.cpp:113
bool cancel_interval(Component *component, const std::string &name)
Definition: scheduler.cpp:78
const float IO
For components that represent GPIO pins like PCF8573.
Definition: component.cpp:17
const uint32_t STATUS_LED_ERROR
Definition: component.cpp:40
uint16_t length
Definition: tt21100.cpp:12
void set_timeout(Component *component, const std::string &name, uint32_t timeout, std::function< void()> func)
Definition: scheduler.cpp:22
This is a workaround until we can figure out a way to get the tflite-micro idf component code availab...
Definition: a01nyub.cpp:7
virtual void call_loop()
Definition: component.cpp:77
const uint32_t STATUS_LED_MASK
Definition: component.cpp:37
virtual void set_update_interval(uint32_t update_interval)
Manually set the update interval in ms for this polling object.
Definition: component.cpp:224
void set_interval(Component *component, const std::string &name, uint32_t interval, std::function< void()> func)
Definition: scheduler.cpp:48
bool state
Definition: fan.h:34