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/log.h"
#ifdef USE_SENSOR_FILTER
#include "esphome/components/sensor/filter.h"
#endif
 
#include <initializer_list>
#include <memory>
 
namespace esphome::sensor {
 
class Sensor;
 
void log_sensor(const char *tag, const char *prefix, const char *type, Sensor *obj);
 
#define LOG_SENSOR(prefix, type, obj) log_sensor(TAG, prefix, LOG_STR_LITERAL(type), obj)
 
#define SUB_SENSOR(name) \
 protected: \
  sensor::Sensor *name##_sensor_{nullptr}; \
\
 public: \
  void set_##name##_sensor(sensor::Sensor *sensor) { this->name##_sensor_ = sensor; }
 
enum StateClass : uint8_t {
  STATE_CLASS_NONE = 0,
  STATE_CLASS_MEASUREMENT = 1,
  STATE_CLASS_TOTAL_INCREASING = 2,
  STATE_CLASS_TOTAL = 3,
  STATE_CLASS_MEASUREMENT_ANGLE = 4
};
constexpr uint8_t STATE_CLASS_LAST = static_cast<uint8_t>(STATE_CLASS_MEASUREMENT_ANGLE);
 
const LogString *state_class_to_string(StateClass state_class);
 
class Sensor : public EntityBase {
 public:
  explicit Sensor();
 
  int8_t get_accuracy_decimals();
  void set_accuracy_decimals(int8_t accuracy_decimals);
  bool has_accuracy_decimals() const { return this->sensor_flags_.has_accuracy_override; }
 
  StateClass get_state_class();
  void set_state_class(StateClass state_class);
 
  bool get_force_update() const { return sensor_flags_.force_update; }
  void set_force_update(bool force_update) { sensor_flags_.force_update = force_update; }
 
#ifdef USE_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
 
  float get_state() const { return this->state; }
  float get_raw_state() const {
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
    return this->raw_state;
#pragma GCC diagnostic pop
  }
 
  void publish_state(float state);
 
  // ========== INTERNAL METHODS ==========
  // (In most use cases you won't need these)
  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_SENSOR_FILTER
    this->raw_callback_.add(std::forward<F>(callback));
#else
    this->callback_.add(std::forward<F>(callback));
#endif
  }
 
  float 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.10.0", "2026.4.0")
  float raw_state;
#pragma GCC diagnostic pop
 
  void internal_send_state_to_frontend(float state);
 
 protected:
#ifdef USE_SENSOR_FILTER
  LazyCallbackManager<void(float)> raw_callback_;  
#endif
  LazyCallbackManager<void(float)> callback_;  
 
#ifdef USE_SENSOR_FILTER
  Filter *filter_list_{nullptr};  
#endif
 
  // Group small members together to avoid padding
  int8_t accuracy_decimals_{-1};              
  StateClass state_class_{STATE_CLASS_NONE};  
 
  // Bit-packed flags for sensor-specific settings
  struct SensorFlags {
    uint8_t has_accuracy_override : 1;
    uint8_t has_state_class_override : 1;
    uint8_t force_update : 1;
    uint8_t reserved : 5;  // Reserved for future use
  } sensor_flags_{};
};
 
}  // namespace esphome::sensor