text_sensor.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"
#ifdef USE_TEXT_SENSOR_FILTER
#include "esphome/components/text_sensor/filter.h"
#endif
 
#include <initializer_list>
#include <memory>
 
namespace esphome::text_sensor {
 
class TextSensor;
 
void log_text_sensor(const char *tag, const char *prefix, const char *type, TextSensor *obj);
 
#define LOG_TEXT_SENSOR(prefix, type, obj) log_text_sensor(TAG, prefix, LOG_STR_LITERAL(type), obj)
 
#define SUB_TEXT_SENSOR(name) \
 protected: \
  text_sensor::TextSensor *name##_text_sensor_{nullptr}; \
\
 public: \
  void set_##name##_text_sensor(text_sensor::TextSensor *text_sensor) { this->name##_text_sensor_ = text_sensor; }
 
class TextSensor : public EntityBase, public EntityBase_DeviceClass {
 public:
  std::string state;
 
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
  ESPDEPRECATED("Use get_raw_state() instead of .raw_state. Will be removed in 2026.6.0", "2025.12.0")
  std::string raw_state;
 
  TextSensor() = default;
  ~TextSensor() = default;
#pragma GCC diagnostic pop
 
  const std::string &get_state() const;
  const std::string &get_raw_state() const;
 
  void publish_state(const std::string &state);
  void publish_state(const char *state);
  void publish_state(const char *state, size_t len);
 
#ifdef USE_TEXT_SENSOR_FILTER
  void add_filter(Filter *filter);
 
  void add_filters(std::initializer_list<Filter *> filters);
 
  void set_filters(std::initializer_list<Filter *> filters);
 
  void clear_filters();
#endif
 
  void add_on_state_callback(std::function<void(const std::string &)> callback);
  void add_on_raw_state_callback(std::function<void(const std::string &)> callback);
 
  // ========== INTERNAL METHODS ==========
  // (In most use cases you won't need these)
 
  void internal_send_state_to_frontend(const std::string &state);
  void internal_send_state_to_frontend(const char *state, size_t len);
 
 protected:
  void notify_frontend_();
  LazyCallbackManager<void(const std::string &)> raw_callback_;  
  LazyCallbackManager<void(const std::string &)> callback_;      
 
#ifdef USE_TEXT_SENSOR_FILTER
  Filter *filter_list_{nullptr};  
#endif
};
 
}  // namespace esphome::text_sensor