ESPHome 2025.5.0
Loading...
Searching...
No Matches
text_sensor.h
Go to the documentation of this file.
1#pragma once
2
7
8#include <vector>
9
10namespace esphome {
11namespace text_sensor {
12
13#define LOG_TEXT_SENSOR(prefix, type, obj) \
14 if ((obj) != nullptr) { \
15 ESP_LOGCONFIG(TAG, "%s%s '%s'", prefix, LOG_STR_LITERAL(type), (obj)->get_name().c_str()); \
16 if (!(obj)->get_device_class().empty()) { \
17 ESP_LOGCONFIG(TAG, "%s Device Class: '%s'", prefix, (obj)->get_device_class().c_str()); \
18 } \
19 if (!(obj)->get_icon().empty()) { \
20 ESP_LOGCONFIG(TAG, "%s Icon: '%s'", prefix, (obj)->get_icon().c_str()); \
21 } \
22 if (!(obj)->unique_id().empty()) { \
23 ESP_LOGV(TAG, "%s Unique ID: '%s'", prefix, (obj)->unique_id().c_str()); \
24 } \
25 }
26
27#define SUB_TEXT_SENSOR(name) \
28 protected: \
29 text_sensor::TextSensor *name##_text_sensor_{nullptr}; \
30\
31 public: \
32 void set_##name##_text_sensor(text_sensor::TextSensor *text_sensor) { this->name##_text_sensor_ = text_sensor; }
33
35 public:
37 std::string get_state() const;
39 std::string get_raw_state() const;
40
41 void publish_state(const std::string &state);
42
44 void add_filter(Filter *filter);
45
47 void add_filters(const std::vector<Filter *> &filters);
48
50 void set_filters(const std::vector<Filter *> &filters);
51
53 void clear_filters();
54
55 void add_on_state_callback(std::function<void(std::string)> callback);
57 void add_on_raw_state_callback(std::function<void(std::string)> callback);
58
59 std::string state;
60 std::string raw_state;
61
62 // ========== INTERNAL METHODS ==========
63 // (In most use cases you won't need these)
68 virtual std::string unique_id();
69
70 bool has_state();
71
72 void internal_send_state_to_frontend(const std::string &state);
73
74 protected:
75 CallbackManager<void(std::string)> raw_callback_;
76 CallbackManager<void(std::string)> callback_;
77
78 Filter *filter_list_{nullptr};
79
80 bool has_state_{false};
81};
82
83} // namespace text_sensor
84} // namespace esphome
Apply a filter to text sensor values such as to_upper.
Definition filter.h:20
void internal_send_state_to_frontend(const std::string &state)
void add_filter(Filter *filter)
Add a filter to the filter chain. Will be appended to the back.
CallbackManager< void(std::string)> callback_
Storage for filtered state callbacks.
Definition text_sensor.h:76
void clear_filters()
Clear the entire filter chain.
void add_filters(const std::vector< Filter * > &filters)
Add a list of vectors to the back of the filter chain.
std::string get_state() const
Getter-syntax for .state.
virtual std::string unique_id()
Override this method to set the unique ID of this sensor.
Filter * filter_list_
Store all active filters.
Definition text_sensor.h:78
CallbackManager< void(std::string)> raw_callback_
Storage for raw state callbacks.
Definition text_sensor.h:75
void add_on_raw_state_callback(std::function< void(std::string)> callback)
Add a callback that will be called every time the sensor sends a raw value.
void set_filters(const std::vector< Filter * > &filters)
Clear the filters and replace them by filters.
void add_on_state_callback(std::function< void(std::string)> callback)
std::string get_raw_state() const
Getter-syntax for .raw_state.
void publish_state(const std::string &state)
Providing packet encoding functions for exchanging data with a remote host.
Definition a01nyub.cpp:7