ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
filter.h
Go to the documentation of this file.
1#pragma once
2
4#ifdef USE_TEXT_SENSOR_FILTER
5
8
9namespace esphome::text_sensor {
10
11class TextSensor;
12
18class Filter {
19 public:
28 virtual bool new_value(std::string &value) = 0;
29
31 virtual void initialize(TextSensor *parent, Filter *next);
32
33 void input(std::string value);
34
35 void output(std::string &value);
36
37 protected:
38 friend TextSensor;
39
40 Filter *next_{nullptr};
42};
43
44using lambda_filter_t = std::function<optional<std::string>(std::string)>;
45
52class LambdaFilter : public Filter {
53 public:
54 explicit LambdaFilter(lambda_filter_t lambda_filter);
55
56 bool new_value(std::string &value) override;
57
59 void set_lambda_filter(const lambda_filter_t &lambda_filter);
60
61 protected:
63};
64
71 public:
72 explicit StatelessLambdaFilter(optional<std::string> (*lambda_filter)(std::string)) : lambda_filter_(lambda_filter) {}
73
74 bool new_value(std::string &value) override {
75 auto result = this->lambda_filter_(value);
76 if (result.has_value()) {
77 value = std::move(*result);
78 return true;
79 }
80 return false;
81 }
82
83 protected:
84 optional<std::string> (*lambda_filter_)(std::string);
85};
86
88class ToUpperFilter : public Filter {
89 public:
90 bool new_value(std::string &value) override;
91};
92
94class ToLowerFilter : public Filter {
95 public:
96 bool new_value(std::string &value) override;
97};
98
100class AppendFilter : public Filter {
101 public:
102 explicit AppendFilter(const char *suffix) : suffix_(suffix) {}
103 bool new_value(std::string &value) override;
104
105 protected:
106 const char *suffix_;
107};
108
110class PrependFilter : public Filter {
111 public:
112 explicit PrependFilter(const char *prefix) : prefix_(prefix) {}
113 bool new_value(std::string &value) override;
114
115 protected:
116 const char *prefix_;
117};
118
120 const char *from;
121 const char *to;
122};
123
127class SubstituteFilter : public Filter {
128 public:
129 explicit SubstituteFilter(const Substitution *substitutions) : substitutions_(substitutions) {}
130 bool new_value(std::string &value) override;
131
132 protected:
134};
135
163class MapFilter : public Filter {
164 public:
165 explicit MapFilter(const Substitution *mappings) : mappings_(mappings) {}
166 bool new_value(std::string &value) override;
167
168 protected:
170};
171
173class ThrottleFilter : public Filter {
174 public:
175 explicit ThrottleFilter(uint32_t min_time_between_inputs) : min_time_between_inputs_(min_time_between_inputs) {}
176 bool new_value(std::string &value) override;
177
178 protected:
181};
182
186 public:
187 ThrottleWithPriorityFilter(uint32_t min_time_between_inputs, const char *const *prioritized)
188 : ThrottleFilter(min_time_between_inputs), prioritized_(prioritized) {}
189 bool new_value(std::string &value) override;
190
191 protected:
192 const char *const *prioritized_;
193};
194
197class TimeoutFilterBase : public Filter, public Component {
198 public:
199 bool new_value(std::string &value) override;
200 void loop() override;
201 float get_setup_priority() const override { return setup_priority::HARDWARE; }
202
203 protected:
204 explicit TimeoutFilterBase(uint32_t time_period) : time_period_(time_period) { this->disable_loop(); }
206 void send_(const char *text, size_t len);
207 virtual void send_timeout_value() = 0;
208
211};
212
215 public:
216 explicit TimeoutFilterLast(uint32_t time_period) : TimeoutFilterBase(time_period) {}
217 bool new_value(std::string &value) override;
218
219 protected:
220 void send_timeout_value() override { this->send_(this->last_.data(), this->last_.size()); }
221 std::string last_;
222};
223
227 public:
228 TimeoutThrottleFilter(uint32_t time_period, const char *const *prioritized)
229 : TimeoutFilterLast(time_period), prioritized_(prioritized) {}
230 bool new_value(std::string &value) override;
231
232 protected:
233 void send_timeout_value() override;
234 const char *const *prioritized_;
235 uint32_t last_input_{0}; // When the throttle stage last let a value through
236};
237
240 public:
241 TimeoutFilterConfigured(uint32_t time_period, const char *value) : TimeoutFilterBase(time_period), value_(value) {}
242
243 protected:
244 void send_timeout_value() override { this->send_(this->value_, strlen(this->value_)); }
245 const char *value_;
246};
247
248} // namespace esphome::text_sensor
249
250#endif // USE_TEXT_SENSOR_FILTER
void disable_loop()
Disable this component's loop.
A simple filter that adds a string to the end of another string.
Definition filter.h:100
bool new_value(std::string &value) override
Definition filter.cpp:66
AppendFilter(const char *suffix)
Definition filter.h:102
Apply a filter to text sensor values such as to_upper.
Definition filter.h:18
virtual bool new_value(std::string &value)=0
This will be called every time the filter receives a new value.
void output(std::string &value)
Definition filter.cpp:20
void input(std::string value)
Definition filter.cpp:15
virtual void initialize(TextSensor *parent, Filter *next)
Initialize this filter, please note this can be called more than once.
Definition filter.cpp:29
This class allows for creation of simple template filters.
Definition filter.h:52
lambda_filter_t lambda_filter_
Definition filter.h:62
LambdaFilter(lambda_filter_t lambda_filter)
Definition filter.cpp:36
void set_lambda_filter(const lambda_filter_t &lambda_filter)
Definition filter.cpp:38
bool new_value(std::string &value) override
Definition filter.cpp:40
const lambda_filter_t & get_lambda_filter() const
Definition filter.cpp:37
A filter that maps values from one set to another.
Definition filter.h:163
bool new_value(std::string &value) override
Definition filter.cpp:92
const Substitution * mappings_
Definition filter.h:169
MapFilter(const Substitution *mappings)
Definition filter.h:165
A simple filter that adds a string to the start of another string.
Definition filter.h:110
bool new_value(std::string &value) override
Definition filter.cpp:72
PrependFilter(const char *prefix)
Definition filter.h:112
Optimized lambda filter for stateless lambdas (no capture).
Definition filter.h:70
optional< std::string >(* lambda_filter_)(std::string)
Definition filter.h:84
StatelessLambdaFilter(optional< std::string >(*lambda_filter)(std::string))
Definition filter.h:72
bool new_value(std::string &value) override
Definition filter.h:74
A simple filter that replaces a substring with another substring.
Definition filter.h:127
bool new_value(std::string &value) override
Definition filter.cpp:78
SubstituteFilter(const Substitution *substitutions)
Definition filter.h:129
const Substitution * substitutions_
Definition filter.h:133
Drops a value that comes sooner than min_time_between_inputs after the last one let through.
Definition filter.h:173
bool new_value(std::string &value) override
Definition filter.cpp:115
ThrottleFilter(uint32_t min_time_between_inputs)
Definition filter.h:175
Same as ThrottleFilter, but a value in prioritized always passes.
Definition filter.h:185
ThrottleWithPriorityFilter(uint32_t min_time_between_inputs, const char *const *prioritized)
Definition filter.h:187
bool new_value(std::string &value) override
Definition filter.cpp:119
Passes every value on and, once none has come for time_period, sends one value again.
Definition filter.h:197
TimeoutFilterBase(uint32_t time_period)
Definition filter.h:204
bool new_value(std::string &value) override
Definition filter.cpp:124
float get_setup_priority() const override
Definition filter.h:201
void send_(const char *text, size_t len)
Sends text; never moves a stored string on, so it keeps its buffer.
Definition filter.cpp:138
TimeoutFilterConfigured(uint32_t time_period, const char *value)
Definition filter.h:241
Sends the last value again.
Definition filter.h:214
bool new_value(std::string &value) override
Definition filter.cpp:146
TimeoutFilterLast(uint32_t time_period)
Definition filter.h:216
Codegen use only: timeout (value last) followed by throttle_with_priority with the same period,...
Definition filter.h:226
TimeoutThrottleFilter(uint32_t time_period, const char *const *prioritized)
Definition filter.h:228
bool new_value(std::string &value) override
Definition filter.cpp:151
A simple filter that converts all text to lowercase.
Definition filter.h:94
bool new_value(std::string &value) override
Definition filter.cpp:59
A simple filter that converts all text to uppercase.
Definition filter.h:88
bool new_value(std::string &value) override
Definition filter.cpp:52
NameCopy * next
constexpr float HARDWARE
For components that deal with hardware and are very important like GPIO switch.
Definition component.h:43
std::function< optional< std::string >(std::string)> lambda_filter_t
Definition filter.h:44
uint32_t value
Definition hal.cpp:41
const void size_t len
Definition hal.h:68
static void uint32_t