template_select.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/components/select/select.h"
#include "esphome/core/automation.h"
#include "esphome/core/component.h"
#include "esphome/core/preferences.h"
#include "esphome/core/string_ref.h"
#include "esphome/core/template_lambda.h"
 
namespace esphome::template_ {
 
// Distinct per member: two empty members of the same type cannot share an address
template<int N> struct Empty {};
class BaseTemplateSelect : public select::Select, public PollingComponent {};
 
void dump_config_helper(BaseTemplateSelect *sel_comp, bool optimistic, bool has_lambda, size_t initial_option_index,
                        bool restore_value);
void setup_initial(BaseTemplateSelect *sel_comp, size_t initial_index);
void setup_with_restore(BaseTemplateSelect *sel_comp, ESPPreferenceObject &pref, size_t initial_index);
void update_lambda(BaseTemplateSelect *sel_comp, const optional<std::string> &val);
 
 
template<bool HAS_LAMBDA, bool OPTIMISTIC, bool RESTORE_VALUE, size_t INITIAL_OPTION_INDEX>
class TemplateSelect : public BaseTemplateSelect {
 public:
  // User provided, not "= default": `new(p) TemplateSelect()` would zero-fill .bss that is already zero.
  TemplateSelect() {}
  template<typename F> void set_lambda(F &&f) {
    if constexpr (HAS_LAMBDA) {
      this->f_.set(std::forward<F>(f));
    }
  }
 
  void setup() override {
    if constexpr (!HAS_LAMBDA) {
      if constexpr (RESTORE_VALUE) {
        this->pref_ = this->template make_entity_preference<size_t>();
        setup_with_restore(this, this->pref_, INITIAL_OPTION_INDEX);
      } else {
        setup_initial(this, INITIAL_OPTION_INDEX);
      }
    }
  }
 
  void update() override {
    if constexpr (HAS_LAMBDA) {
      update_lambda(this, this->f_());
    }
  }
  void dump_config() override {
    dump_config_helper(this, OPTIMISTIC, HAS_LAMBDA, INITIAL_OPTION_INDEX, RESTORE_VALUE);
  };
  float get_setup_priority() const override { return setup_priority::HARDWARE; }
 
 protected:
  void control(size_t index) override {
    if constexpr (OPTIMISTIC)
      this->publish_state(index);
    if constexpr (RESTORE_VALUE)
      this->pref_.save(&index);
  }
  [[no_unique_address]] std::conditional_t<HAS_LAMBDA, TemplateLambda<std::string>, Empty<0>> f_{};
  [[no_unique_address]] std::conditional_t<RESTORE_VALUE, ESPPreferenceObject, Empty<1>> pref_{};
};
 
template<bool HAS_LAMBDA, bool OPTIMISTIC, bool RESTORE_VALUE, size_t INITIAL_OPTION_INDEX>
class TemplateSelectWithSetAction final
    : public TemplateSelect<HAS_LAMBDA, OPTIMISTIC, RESTORE_VALUE, INITIAL_OPTION_INDEX> {
 public:
  Trigger<StringRef> *get_set_trigger() { return &this->set_trigger_; }
 
 protected:
  void control(size_t index) override {
    this->set_trigger_.trigger(StringRef(this->option_at(index)));
    TemplateSelect<HAS_LAMBDA, OPTIMISTIC, RESTORE_VALUE, INITIAL_OPTION_INDEX>::control(index);
  }
  Trigger<StringRef> set_trigger_;
};
 
}  // namespace esphome::template_