select.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/component.h"
#include "esphome/core/entity_base.h"
#include "esphome/core/helpers.h"
#include "esphome/core/string_ref.h"
#include "select_call.h"
#include "select_traits.h"
 
namespace esphome::select {
 
#define LOG_SELECT(prefix, type, obj) \
  if ((obj) != nullptr) { \
    ESP_LOGCONFIG(TAG, "%s%s '%s'", prefix, LOG_STR_LITERAL(type), (obj)->get_name().c_str()); \
    LOG_ENTITY_ICON(TAG, prefix, *(obj)); \
  }
 
#define SUB_SELECT(name) \
 protected: \
  select::Select *name##_select_{nullptr}; \
\
 public: \
  void set_##name##_select(select::Select *select) { this->name##_select_ = select; }
 
class Select : public EntityBase {
 public:
  SelectTraits traits;
 
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
  ESPDEPRECATED("Use current_option() instead of .state. Will be removed in 2026.7.0", "2026.1.0")
  std::string state{};
 
  Select() = default;
  ~Select() = default;
#pragma GCC diagnostic pop
 
  void publish_state(const std::string &state);
  void publish_state(const char *state);
  void publish_state(size_t index);
 
  StringRef current_option() const;
 
  SelectCall make_call() { return SelectCall(this); }
 
  bool has_option(const std::string &option) const;
  bool has_option(const char *option) const;
 
  bool has_index(size_t index) const;
 
  size_t size() const;
 
  optional<size_t> index_of(const char *option, size_t len) const;
  optional<size_t> index_of(const std::string &option) const { return this->index_of(option.data(), option.size()); }
  optional<size_t> index_of(const char *option) const { return this->index_of(option, strlen(option)); }
 
  optional<size_t> active_index() const;
 
  optional<std::string> at(size_t index) const;
 
  const char *option_at(size_t index) const;
 
  template<typename F> void add_on_state_callback(F &&callback) {
    this->state_callback_.add(std::forward<F>(callback));
  }
 
 protected:
  friend class SelectCall;
 
  size_t active_index_{0};
 
  virtual void control(size_t index) { this->control(this->option_at(index)); }
 
  virtual void control(const std::string &value) {
    auto index = this->index_of(value);
    if (index.has_value()) {
      this->control(index.value());
    }
  }
 
  LazyCallbackManager<void(size_t)> state_callback_;
};
 
}  // namespace esphome::select