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"
#include "esphome/core/progmem.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:
  std::string state;
 
  // User provided, not "= default": `new(p) TextSensor()` would zero-fill .bss that is already zero.
  TextSensor() {}
  ~TextSensor() = default;
 
  const std::string &get_state() const;
  const std::string &get_raw_state() const;
 
  void publish_state(const std::string &state) { this->publish_state(state.data(), state.size()); }
  void publish_state(const char *state) { this->publish_state(state, strlen(state)); }
  void publish_state(const char *state, size_t len);
#ifdef USE_ESP8266
  void publish_state(ProgmemStr state);
#endif
 
#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
 
  template<typename F> void add_on_state_callback(F &&callback) { this->callback_.add(std::forward<F>(callback)); }
  template<typename F> void add_on_raw_state_callback(F &&callback) {
#ifdef USE_TEXT_SENSOR_FILTER
    this->raw_callback_.add(std::forward<F>(callback));
#else
    this->callback_.add(std::forward<F>(callback));
#endif
  }
 
  // ========== INTERNAL METHODS ==========
  // (In most use cases you won't need these)
 
  void internal_send_state_to_frontend(const std::string &state) {
    this->internal_send_state_to_frontend(state.data(), state.size());
  }
  void internal_send_state_to_frontend(const char *state, size_t len);
 
 protected:
  void notify_frontend_();
#ifdef USE_TEXT_SENSOR_FILTER
  std::string raw_state_;  
  LazyCallbackManager<void(const std::string &)> raw_callback_;  
#endif
  LazyCallbackManager<void(const std::string &)> callback_;  
 
#ifdef USE_TEXT_SENSOR_FILTER
  Filter *filter_list_{nullptr};  
#endif
};
 
}  // namespace esphome::text_sensor