ESPHome  2024.10.2
ade7953_base.cpp
Go to the documentation of this file.
1 #include "ade7953_base.h"
2 #include "esphome/core/log.h"
3 
4 #include <cinttypes>
5 
6 namespace esphome {
7 namespace ade7953_base {
8 
9 static const char *const TAG = "ade7953";
10 
11 static const float ADE_POWER_FACTOR = 154.0f;
12 static const float ADE_WATTSEC_POWER_FACTOR = ADE_POWER_FACTOR * ADE_POWER_FACTOR / 3600;
13 
15  if (this->irq_pin_ != nullptr) {
16  this->irq_pin_->setup();
17  }
18 
19  // The chip might take up to 100ms to initialise
20  this->set_timeout(100, [this]() {
21  // this->ade_write_8(0x0010, 0x04);
22  this->ade_write_8(0x00FE, 0xAD);
23  this->ade_write_16(0x0120, 0x0030);
24  // Set gains
25  this->ade_write_8(PGA_V_8, pga_v_);
26  this->ade_write_8(PGA_IA_8, pga_ia_);
27  this->ade_write_8(PGA_IB_8, pga_ib_);
28  this->ade_write_32(AVGAIN_32, vgain_);
29  this->ade_write_32(AIGAIN_32, aigain_);
30  this->ade_write_32(BIGAIN_32, bigain_);
31  this->ade_write_32(AWGAIN_32, awgain_);
32  this->ade_write_32(BWGAIN_32, bwgain_);
33  // Read back gains for debugging
34  this->ade_read_8(PGA_V_8, &pga_v_);
35  this->ade_read_8(PGA_IA_8, &pga_ia_);
36  this->ade_read_8(PGA_IB_8, &pga_ib_);
37  this->ade_read_32(AVGAIN_32, &vgain_);
38  this->ade_read_32(AIGAIN_32, &aigain_);
39  this->ade_read_32(BIGAIN_32, &bigain_);
40  this->ade_read_32(AWGAIN_32, &awgain_);
41  this->ade_read_32(BWGAIN_32, &bwgain_);
42  this->last_update_ = millis();
43  this->is_setup_ = true;
44  });
45 }
46 
48  LOG_PIN(" IRQ Pin: ", irq_pin_);
49  LOG_UPDATE_INTERVAL(this);
50  LOG_SENSOR(" ", "Voltage Sensor", this->voltage_sensor_);
51  LOG_SENSOR(" ", "Current A Sensor", this->current_a_sensor_);
52  LOG_SENSOR(" ", "Current B Sensor", this->current_b_sensor_);
53  LOG_SENSOR(" ", "Power Factor A Sensor", this->power_factor_a_sensor_);
54  LOG_SENSOR(" ", "Power Factor B Sensor", this->power_factor_b_sensor_);
55  LOG_SENSOR(" ", "Apparent Power A Sensor", this->apparent_power_a_sensor_);
56  LOG_SENSOR(" ", "Apparent Power B Sensor", this->apparent_power_b_sensor_);
57  LOG_SENSOR(" ", "Active Power A Sensor", this->active_power_a_sensor_);
58  LOG_SENSOR(" ", "Active Power B Sensor", this->active_power_b_sensor_);
59  LOG_SENSOR(" ", "Rective Power A Sensor", this->reactive_power_a_sensor_);
60  LOG_SENSOR(" ", "Reactive Power B Sensor", this->reactive_power_b_sensor_);
61  ESP_LOGCONFIG(TAG, " USE_ACC_ENERGY_REGS: %d", this->use_acc_energy_regs_);
62  ESP_LOGCONFIG(TAG, " PGA_V_8: 0x%X", pga_v_);
63  ESP_LOGCONFIG(TAG, " PGA_IA_8: 0x%X", pga_ia_);
64  ESP_LOGCONFIG(TAG, " PGA_IB_8: 0x%X", pga_ib_);
65  ESP_LOGCONFIG(TAG, " VGAIN_32: 0x%08jX", (uintmax_t) vgain_);
66  ESP_LOGCONFIG(TAG, " AIGAIN_32: 0x%08jX", (uintmax_t) aigain_);
67  ESP_LOGCONFIG(TAG, " BIGAIN_32: 0x%08jX", (uintmax_t) bigain_);
68  ESP_LOGCONFIG(TAG, " AWGAIN_32: 0x%08jX", (uintmax_t) awgain_);
69  ESP_LOGCONFIG(TAG, " BWGAIN_32: 0x%08jX", (uintmax_t) bwgain_);
70 }
71 
72 #define ADE_PUBLISH_(name, val, factor) \
73  if (err == 0 && this->name##_sensor_) { \
74  float value = (val) / (factor); \
75  this->name##_sensor_->publish_state(value); \
76  }
77 #define ADE_PUBLISH(name, val, factor) ADE_PUBLISH_(name, val, factor)
78 
80  if (!this->is_setup_)
81  return;
82 
83  bool err;
84 
85  uint32_t interrupts_a = 0;
86  uint32_t interrupts_b = 0;
87  if (this->irq_pin_ != nullptr) {
88  // Read and reset interrupts
89  this->ade_read_32(0x032E, &interrupts_a);
90  this->ade_read_32(0x0331, &interrupts_b);
91  }
92 
93  uint32_t val;
94  uint16_t val_16;
95  uint16_t reg;
96 
97  // Power factor
98  err = this->ade_read_16(0x010A, &val_16);
99  ADE_PUBLISH(power_factor_a, (int16_t) val_16, (0x7FFF / 100.0f));
100  err = this->ade_read_16(0x010B, &val_16);
101  ADE_PUBLISH(power_factor_b, (int16_t) val_16, (0x7FFF / 100.0f));
102 
103  float pf = ADE_POWER_FACTOR;
104  if (this->use_acc_energy_regs_) {
105  const uint32_t now = millis();
106  const auto diff = now - this->last_update_;
107  this->last_update_ = now;
108  // prevent DIV/0
109  pf = ADE_WATTSEC_POWER_FACTOR * (diff < 10 ? 10 : diff) / 1000;
110  ESP_LOGVV(TAG, "ADE7953::update() diff=%" PRIu32 " pf=%f", diff, pf);
111  }
112 
113  // Apparent power
114  reg = this->use_acc_energy_regs_ ? 0x0322 : 0x0310;
115  err = this->ade_read_32(reg, &val);
116  ADE_PUBLISH(apparent_power_a, (int32_t) val, pf);
117  err = this->ade_read_32(reg + 1, &val);
118  ADE_PUBLISH(apparent_power_b, (int32_t) val, pf);
119 
120  // Active power
121  reg = this->use_acc_energy_regs_ ? 0x031E : 0x0312;
122  err = this->ade_read_32(reg, &val);
123  ADE_PUBLISH(active_power_a, (int32_t) val, pf);
124  err = this->ade_read_32(reg + 1, &val);
125  ADE_PUBLISH(active_power_b, (int32_t) val, pf);
126 
127  // Reactive power
128  reg = this->use_acc_energy_regs_ ? 0x0320 : 0x0314;
129  err = this->ade_read_32(reg, &val);
130  ADE_PUBLISH(reactive_power_a, (int32_t) val, pf);
131  err = this->ade_read_32(reg + 1, &val);
132  ADE_PUBLISH(reactive_power_b, (int32_t) val, pf);
133 
134  // Current
135  err = this->ade_read_32(0x031A, &val);
136  ADE_PUBLISH(current_a, (uint32_t) val, 100000.0f);
137  err = this->ade_read_32(0x031B, &val);
138  ADE_PUBLISH(current_b, (uint32_t) val, 100000.0f);
139 
140  // Voltage
141  err = this->ade_read_32(0x031C, &val);
142  ADE_PUBLISH(voltage, (uint32_t) val, 26000.0f);
143 
144  // Frequency
145  err = this->ade_read_16(0x010E, &val_16);
146  ADE_PUBLISH(frequency, 223750.0f, 1 + val_16);
147 }
148 
149 } // namespace ade7953_base
150 } // namespace esphome
sensor::Sensor * apparent_power_b_sensor_
Definition: ade7953_base.h:93
sensor::Sensor * voltage_sensor_
Definition: ade7953_base.h:88
virtual bool ade_read_32(uint16_t reg, uint32_t *value)=0
sensor::Sensor * reactive_power_a_sensor_
Definition: ade7953_base.h:96
sensor::Sensor * power_factor_b_sensor_
Definition: ade7953_base.h:99
void set_timeout(const std::string &name, uint32_t timeout, std::function< void()> &&f)
Set a timeout function with a unique name.
Definition: component.cpp:69
mopeka_std_values val[4]
virtual void setup()=0
virtual bool ade_write_32(uint16_t reg, uint32_t value)=0
uint32_t IRAM_ATTR HOT millis()
Definition: core.cpp:25
sensor::Sensor * active_power_b_sensor_
Definition: ade7953_base.h:95
virtual bool ade_read_8(uint16_t reg, uint8_t *value)=0
sensor::Sensor * power_factor_a_sensor_
Definition: ade7953_base.h:98
uint16_le_t frequency
Definition: bl0942.h:72
InternalGPIOPin * irq_pin_
Definition: ade7953_base.h:86
virtual bool ade_write_16(uint16_t reg, uint16_t value)=0
sensor::Sensor * reactive_power_b_sensor_
Definition: ade7953_base.h:97
sensor::Sensor * current_b_sensor_
Definition: ade7953_base.h:91
sensor::Sensor * active_power_a_sensor_
Definition: ade7953_base.h:94
Implementation of SPI Controller mode.
Definition: a01nyub.cpp:7
virtual bool ade_read_16(uint16_t reg, uint16_t *value)=0
sensor::Sensor * apparent_power_a_sensor_
Definition: ade7953_base.h:92
sensor::Sensor * current_a_sensor_
Definition: ade7953_base.h:90
virtual bool ade_write_8(uint16_t reg, uint8_t value)=0