ESPHome 2026.1.5
Loading...
Searching...
No Matches
select.cpp
Go to the documentation of this file.
1#include "select.h"
4#include "esphome/core/log.h"
5#include <cstring>
6
7namespace esphome::select {
8
9static const char *const TAG = "select";
10
11void Select::publish_state(const std::string &state) { this->publish_state(state.c_str()); }
12
13void Select::publish_state(const char *state) {
14 auto index = this->index_of(state);
15 if (index.has_value()) {
16 this->publish_state(index.value());
17 } else {
18 ESP_LOGE(TAG, "'%s': Invalid option %s", this->get_name().c_str(), state);
19 }
20}
21
22void Select::publish_state(size_t index) {
23 if (!this->has_index(index)) {
24 ESP_LOGE(TAG, "'%s': Invalid index %zu", this->get_name().c_str(), index);
25 return;
26 }
27 const char *option = this->option_at(index);
28 this->set_has_state(true);
29 this->active_index_ = index;
30#pragma GCC diagnostic push
31#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
32 this->state = option; // Update deprecated member for backward compatibility
33#pragma GCC diagnostic pop
34 ESP_LOGD(TAG, "'%s' >> %s (%zu)", this->get_name().c_str(), option, index);
35 this->state_callback_.call(index);
36#if defined(USE_SELECT) && defined(USE_CONTROLLER_REGISTRY)
38#endif
39}
40
42 return this->has_state() ? StringRef(this->option_at(this->active_index_)) : StringRef();
43}
44
45void Select::add_on_state_callback(std::function<void(size_t)> &&callback) {
46 this->state_callback_.add(std::move(callback));
47}
48
49bool Select::has_option(const std::string &option) const { return this->index_of(option.c_str()).has_value(); }
50
51bool Select::has_option(const char *option) const { return this->index_of(option).has_value(); }
52
53bool Select::has_index(size_t index) const { return index < this->size(); }
54
55size_t Select::size() const {
56 const auto &options = traits.get_options();
57 return options.size();
58}
59
60optional<size_t> Select::index_of(const char *option, size_t len) const {
61 const auto &options = traits.get_options();
62 for (size_t i = 0; i < options.size(); i++) {
63 if (strncmp(options[i], option, len) == 0 && options[i][len] == '\0') {
64 return i;
65 }
66 }
67 return {};
68}
69
71 if (this->has_state()) {
72 return this->active_index_;
73 }
74 return {};
75}
76
77optional<std::string> Select::at(size_t index) const {
78 if (this->has_index(index)) {
79 const auto &options = traits.get_options();
80 return std::string(options.at(index));
81 }
82 return {};
83}
84
85const char *Select::option_at(size_t index) const { return traits.get_options().at(index); }
86
87} // namespace esphome::select
static void notify_select_update(select::Select *obj)
const StringRef & get_name() const
void set_has_state(bool state)
bool has_state() const
size_t size() const
Definition helpers.h:345
T & at(size_t i)
Access element with bounds checking (matches std::vector behavior) Note: No exception thrown on out o...
Definition helpers.h:355
StringRef is a reference to a string owned by something else.
Definition string_ref.h:26
bool has_value() const
Definition optional.h:92
const char * option_at(size_t index) const
Return the option value at the provided index offset (as const char* from flash).
Definition select.cpp:85
optional< size_t > active_index() const
Return the (optional) index offset of the currently active option.
Definition select.cpp:70
LazyCallbackManager< void(size_t)> state_callback_
Definition select.h:117
size_t size() const
Return the number of options in this select component.
Definition select.cpp:55
optional< std::string > at(size_t index) const
Return the (optional) option value at the provided index offset.
Definition select.cpp:77
bool has_option(const std::string &option) const
Return whether this select component contains the provided option.
Definition select.cpp:49
optional< size_t > index_of(const char *option, size_t len) const
Find the (optional) index offset of the provided option value.
Definition select.cpp:60
bool has_index(size_t index) const
Return whether this select component contains the provided index offset.
Definition select.cpp:53
void add_on_state_callback(std::function< void(size_t)> &&callback)
Definition select.cpp:45
SelectTraits traits
Definition select.h:33
StringRef current_option() const
Return the currently selected option, or empty StringRef if no state.
Definition select.cpp:41
void publish_state(const std::string &state)
Definition select.cpp:11
const FixedVector< const char * > & get_options() const
uint8_t options
bool state
Definition fan.h:0
std::string size_t len
Definition helpers.h:595