ESPHome  2024.11.0
pulse_meter_sensor.h
Go to the documentation of this file.
1 #pragma once
2 
5 #include "esphome/core/hal.h"
6 #include "esphome/core/helpers.h"
7 
8 #include <cinttypes>
9 
10 namespace esphome {
11 namespace pulse_meter {
12 
13 class PulseMeterSensor : public sensor::Sensor, public Component {
14  public:
18  };
19 
20  void set_pin(InternalGPIOPin *pin) { this->pin_ = pin; }
21  void set_filter_us(uint32_t filter) { this->filter_us_ = filter; }
22  void set_timeout_us(uint32_t timeout) { this->timeout_us_ = timeout; }
25 
26  void set_total_pulses(uint32_t pulses);
27 
28  void setup() override;
29  void loop() override;
30  float get_setup_priority() const override;
31  void dump_config() override;
32 
33  protected:
34  static void edge_intr(PulseMeterSensor *sensor);
35  static void pulse_intr(PulseMeterSensor *sensor);
36 
37  InternalGPIOPin *pin_{nullptr};
38  uint32_t filter_us_ = 0;
39  uint32_t timeout_us_ = 1000000UL * 60UL * 5UL;
42 
43  // Variables used in the loop
44  enum class MeterState { INITIAL, RUNNING, TIMED_OUT };
46  bool peeked_edge_ = false;
47  uint32_t total_pulses_ = 0;
49 
50  // This struct (and the two pointers) are used to pass data between the ISR and loop.
51  // These two pointers are exchanged each loop.
52  // Therefore you can't use data in the pointer to loop receives to set values in the pointer to loop sends.
53  // As a result it's easiest if you only use these pointers to send data from the ISR to the loop.
54  // (except for resetting the values)
55  struct State {
56  uint32_t last_detected_edge_us_ = 0;
57  uint32_t last_rising_edge_us_ = 0;
58  uint32_t count_ = 0;
59  };
61  volatile State *set_ = state_;
62  volatile State *get_ = state_ + 1;
63 
64  // Only use these variables in the ISR
66 
68  struct EdgeState {
69  uint32_t last_sent_edge_us_ = 0;
70  };
72 
74  struct PulseState {
75  uint32_t last_intr_ = 0;
76  bool latched_ = false;
77  bool last_pin_val_ = false;
78  };
80 };
81 
82 } // namespace pulse_meter
83 } // namespace esphome
Copy of GPIOPin that is safe to use from ISRs (with no virtual functions)
Definition: gpio.h:66
static void edge_intr(PulseMeterSensor *sensor)
BedjetMode mode
BedJet operating mode.
Definition: bedjet_codec.h:183
static void pulse_intr(PulseMeterSensor *sensor)
void set_filter_mode(InternalFilterMode mode)
Implementation of SPI Controller mode.
Definition: a01nyub.cpp:7
Base-class for all sensors.
Definition: sensor.h:57
esphome::sensor::Sensor * sensor
Definition: statsd.h:38
void set_total_sensor(sensor::Sensor *sensor)