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"
#include "esphome/components/sensor/filter.h"
 
#include <vector>
#include <memory>
 
namespace esphome {
namespace sensor {
 
#define LOG_SENSOR(prefix, type, obj) \
  if ((obj) != nullptr) { \
    ESP_LOGCONFIG(TAG, \
                  "%s%s '%s'\n" \
                  "%s  State Class: '%s'\n" \
                  "%s  Unit of Measurement: '%s'\n" \
                  "%s  Accuracy Decimals: %d", \
                  prefix, LOG_STR_LITERAL(type), (obj)->get_name().c_str(), prefix, \
                  state_class_to_string((obj)->get_state_class()).c_str(), prefix, \
                  (obj)->get_unit_of_measurement().c_str(), prefix, (obj)->get_accuracy_decimals()); \
    if (!(obj)->get_device_class().empty()) { \
      ESP_LOGCONFIG(TAG, "%s  Device Class: '%s'", prefix, (obj)->get_device_class().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()); \
    } \
    if ((obj)->get_force_update()) { \
      ESP_LOGV(TAG, "%s  Force Update: YES", prefix); \
    } \
  }
 
#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,
};
 
std::string state_class_to_string(StateClass state_class);
 
class Sensor : public EntityBase, public EntityBase_DeviceClass, public EntityBase_UnitOfMeasurement {
 public:
  explicit Sensor();
 
  int8_t get_accuracy_decimals();
  void set_accuracy_decimals(int8_t accuracy_decimals);
 
  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; }
 
  void add_filter(Filter *filter);
 
  void add_filters(const std::vector<Filter *> &filters);
 
  void set_filters(const std::vector<Filter *> &filters);
 
  void clear_filters();
 
  float get_state() const;
  float get_raw_state() const;
 
  void publish_state(float state);
 
  // ========== INTERNAL METHODS ==========
  // (In most use cases you won't need these)
  void add_on_state_callback(std::function<void(float)> &&callback);
  void add_on_raw_state_callback(std::function<void(float)> &&callback);
 
  float state;
 
  float raw_state;
 
  virtual std::string unique_id();
 
  void internal_send_state_to_frontend(float state);
 
 protected:
  std::unique_ptr<CallbackManager<void(float)>> raw_callback_;  
  CallbackManager<void(float)> callback_;                       
 
  Filter *filter_list_{nullptr};  
 
  // 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 sensor
}  // namespace esphome