#include #include "esphome/core/component.h" #include "esphome/core/helpers.h" #include "esphome/core/esphal.h" #include "esphome/core/log.h" #include "esphome/core/application.h" namespace esphome { static const char *TAG = "component"; namespace setup_priority { const float BUS = 1000.0f; const float IO = 900.0f; const float HARDWARE = 800.0f; const float DATA = 600.0f; const float PROCESSOR = 400.0; const float WIFI = 250.0f; const float AFTER_WIFI = 200.0f; const float AFTER_CONNECTION = 100.0f; const float LATE = -100.0f; } // namespace setup_priority const uint32_t COMPONENT_STATE_MASK = 0xFF; const uint32_t COMPONENT_STATE_CONSTRUCTION = 0x00; const uint32_t COMPONENT_STATE_SETUP = 0x01; const uint32_t COMPONENT_STATE_LOOP = 0x02; const uint32_t COMPONENT_STATE_FAILED = 0x03; const uint32_t STATUS_LED_MASK = 0xFF00; const uint32_t STATUS_LED_OK = 0x0000; const uint32_t STATUS_LED_WARNING = 0x0100; const uint32_t STATUS_LED_ERROR = 0x0200; uint32_t global_state = 0; float Component::get_loop_priority() const { return 0.0f; } float Component::get_setup_priority() const { return setup_priority::DATA; } void Component::setup() {} void Component::loop() {} void Component::set_interval(const std::string &name, uint32_t interval, std::function &&f) { // NOLINT const uint32_t now = millis(); // only put offset in lower half uint32_t offset = 0; if (interval != 0) offset = (random_uint32() % interval) / 2; ESP_LOGVV(TAG, "set_interval(name='%s', interval=%u, offset=%u)", name.c_str(), interval, offset); if (!name.empty()) { this->cancel_interval(name); } struct TimeFunction function = { .name = name, .type = TimeFunction::INTERVAL, .interval = interval, .last_execution = now - interval - offset, .f = std::move(f), .remove = false, }; this->time_functions_.push_back(function); } bool Component::cancel_interval(const std::string &name) { // NOLINT return this->cancel_time_function_(name, TimeFunction::INTERVAL); } void Component::set_timeout(const std::string &name, uint32_t timeout, std::function &&f) { // NOLINT const uint32_t now = millis(); ESP_LOGVV(TAG, "set_timeout(name='%s', timeout=%u)", name.c_str(), timeout); if (!name.empty()) { this->cancel_timeout(name); } struct TimeFunction function = { .name = name, .type = TimeFunction::TIMEOUT, .interval = timeout, .last_execution = now, .f = std::move(f), .remove = false, }; this->time_functions_.push_back(function); } bool Component::cancel_timeout(const std::string &name) { // NOLINT return this->cancel_time_function_(name, TimeFunction::TIMEOUT); } void Component::call_loop() { this->loop_internal_(); this->loop(); } bool Component::cancel_time_function_(const std::string &name, TimeFunction::Type type) { // NOLINTNEXTLINE for (auto iter = this->time_functions_.begin(); iter != this->time_functions_.end(); iter++) { if (!iter->remove && iter->name == name && iter->type == type) { ESP_LOGVV(TAG, "Removing old time function %s.", iter->name.c_str()); iter->remove = true; return true; } } return false; } void Component::call_setup() { this->setup_internal_(); this->setup(); } uint32_t Component::get_component_state() const { return this->component_state_; } void Component::loop_internal_() { this->component_state_ &= ~COMPONENT_STATE_MASK; this->component_state_ |= COMPONENT_STATE_LOOP; for (unsigned int i = 0; i < this->time_functions_.size(); i++) { // NOLINT const uint32_t now = millis(); TimeFunction *tf = &this->time_functions_[i]; if (tf->should_run(now)) { #ifdef ESPHOME_LOG_HAS_VERY_VERBOSE const char *type = tf->type == TimeFunction::INTERVAL ? "interval" : (tf->type == TimeFunction::TIMEOUT ? "timeout" : "defer"); ESP_LOGVV(TAG, "Running %s '%s':%u with interval=%u last_execution=%u (now=%u)", type, tf->name.c_str(), i, tf->interval, tf->last_execution, now); #endif tf->f(); // The vector might have reallocated due to new items tf = &this->time_functions_[i]; if (tf->type == TimeFunction::INTERVAL && tf->interval != 0) { const uint32_t amount = (now - tf->last_execution) / tf->interval; tf->last_execution += (amount * tf->interval); } else if (tf->type == TimeFunction::DEFER || tf->type == TimeFunction::TIMEOUT) { tf->remove = true; } } } this->time_functions_.erase(std::remove_if(this->time_functions_.begin(), this->time_functions_.end(), [](const TimeFunction &tf) -> bool { return tf.remove; }), this->time_functions_.end()); } void Component::setup_internal_() { this->component_state_ &= ~COMPONENT_STATE_MASK; this->component_state_ |= COMPONENT_STATE_SETUP; } void Component::mark_failed() { ESP_LOGE(TAG, "Component was marked as failed."); this->component_state_ &= ~COMPONENT_STATE_MASK; this->component_state_ |= COMPONENT_STATE_FAILED; this->status_set_error(); } void Component::defer(std::function &&f) { this->defer("", std::move(f)); } // NOLINT bool Component::cancel_defer(const std::string &name) { // NOLINT return this->cancel_time_function_(name, TimeFunction::DEFER); } void Component::defer(const std::string &name, std::function &&f) { // NOLINT if (!name.empty()) { this->cancel_defer(name); } struct TimeFunction function = { .name = name, .type = TimeFunction::DEFER, .interval = 0, .last_execution = 0, .f = std::move(f), .remove = false, }; this->time_functions_.push_back(function); } void Component::set_timeout(uint32_t timeout, std::function &&f) { // NOLINT this->set_timeout("", timeout, std::move(f)); } void Component::set_interval(uint32_t interval, std::function &&f) { // NOLINT this->set_interval("", interval, std::move(f)); } bool Component::is_failed() { return (this->component_state_ & COMPONENT_STATE_MASK) == COMPONENT_STATE_FAILED; } bool Component::can_proceed() { return true; } bool Component::status_has_warning() { return this->component_state_ & STATUS_LED_WARNING; } bool Component::status_has_error() { return this->component_state_ & STATUS_LED_ERROR; } void Component::status_set_warning() { this->component_state_ |= STATUS_LED_WARNING; App.app_state_ |= STATUS_LED_WARNING; } void Component::status_set_error() { this->component_state_ |= STATUS_LED_ERROR; App.app_state_ |= STATUS_LED_ERROR; } void Component::status_clear_warning() { this->component_state_ &= ~STATUS_LED_WARNING; } void Component::status_clear_error() { this->component_state_ &= ~STATUS_LED_ERROR; } void Component::status_momentary_warning(const std::string &name, uint32_t length) { this->status_set_warning(); this->set_timeout(name, length, [this]() { this->status_clear_warning(); }); } void Component::status_momentary_error(const std::string &name, uint32_t length) { this->status_set_error(); this->set_timeout(name, length, [this]() { this->status_clear_error(); }); } void Component::dump_config() {} float Component::get_actual_setup_priority() const { return this->setup_priority_override_.value_or(this->get_setup_priority()); } void Component::set_setup_priority(float priority) { this->setup_priority_override_ = priority; } PollingComponent::PollingComponent(uint32_t update_interval) : Component(), update_interval_(update_interval) {} void PollingComponent::call_setup() { // Call component internal setup. this->setup_internal_(); // Let the polling component subclass setup their HW. this->setup(); // Register interval. this->set_interval("update", this->get_update_interval(), [this]() { this->update(); }); } uint32_t PollingComponent::get_update_interval() const { return this->update_interval_; } void PollingComponent::set_update_interval(uint32_t update_interval) { this->update_interval_ = update_interval; } const std::string &Nameable::get_name() const { return this->name_; } void Nameable::set_name(const std::string &name) { this->name_ = name; this->calc_object_id_(); } Nameable::Nameable(const std::string &name) : name_(name) { this->calc_object_id_(); } const std::string &Nameable::get_object_id() { return this->object_id_; } bool Nameable::is_internal() const { return this->internal_; } void Nameable::set_internal(bool internal) { this->internal_ = internal; } void Nameable::calc_object_id_() { this->object_id_ = sanitize_string_whitelist(to_lowercase_underscore(this->name_), HOSTNAME_CHARACTER_WHITELIST); // FNV-1 hash this->object_id_hash_ = fnv1_hash(this->object_id_); } uint32_t Nameable::get_object_id_hash() { return this->object_id_hash_; } bool Component::TimeFunction::should_run(uint32_t now) const { if (this->remove) return false; if (this->type == DEFER) return true; return this->interval != 4294967295UL && now - this->last_execution > this->interval; } } // namespace esphome