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/components/text_sensor/filter.h"

#include <vector>

namespace esphome {
namespace text_sensor {

#define LOG_TEXT_SENSOR(prefix, type, obj) \
  if ((obj) != nullptr) { \
    ESP_LOGCONFIG(TAG, "%s%s '%s'", prefix, LOG_STR_LITERAL(type), (obj)->get_name().c_str()); \
    if (!(obj)->get_icon().empty()) { \
      ESP_LOGCONFIG(TAG, "%s  Icon: '%s'", prefix, (obj)->get_icon().c_str()); \
    } \
    if (!(obj)->unique_id().empty()) { \
      ESP_LOGV(TAG, "%s  Unique ID: '%s'", prefix, (obj)->unique_id().c_str()); \
    } \
  }

#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:
  explicit TextSensor();
  explicit TextSensor(const std::string &name);

  std::string get_state() const;
  std::string get_raw_state() const;

  void publish_state(const std::string &state);

  void add_filter(Filter *filter);

  void add_filters(const std::vector<Filter *> &filters);

  void set_filters(const std::vector<Filter *> &filters);

  void clear_filters();

  void add_on_state_callback(std::function<void(std::string)> callback);
  void add_on_raw_state_callback(std::function<void(std::string)> callback);

  std::string state;
  std::string raw_state;

  // ========== INTERNAL METHODS ==========
  // (In most use cases you won't need these)
  virtual std::string unique_id();

  bool has_state();

  void internal_send_state_to_frontend(const std::string &state);

 protected:
  CallbackManager<void(std::string)> raw_callback_;  
  CallbackManager<void(std::string)> callback_;      

  Filter *filter_list_{nullptr};  

  bool has_state_{false};
};

}  // namespace text_sensor
}  // namespace esphome