ESPHome 2025.9.0-dev
Loading...
Searching...
No Matches
atm90e32.h
Go to the documentation of this file.
1#pragma once
2
3#include <unordered_map>
4#include "atm90e32_reg.h"
11
12namespace esphome {
13namespace atm90e32 {
14
16 public spi::SPIDevice<spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_HIGH,
17 spi::CLOCK_PHASE_TRAILING, spi::DATA_RATE_1MHZ> {
18 public:
19 static const uint8_t PHASEA = 0;
20 static const uint8_t PHASEB = 1;
21 static const uint8_t PHASEC = 2;
22 const char *phase_labels[3] = {"A", "B", "C"};
23 // these registers are not sucessive, so we can't just do 'base + phase'
24 const uint16_t voltage_gain_registers[3] = {ATM90E32_REGISTER_UGAINA, ATM90E32_REGISTER_UGAINB,
25 ATM90E32_REGISTER_UGAINC};
26 const uint16_t current_gain_registers[3] = {ATM90E32_REGISTER_IGAINA, ATM90E32_REGISTER_IGAINB,
27 ATM90E32_REGISTER_IGAINC};
28 const uint16_t voltage_offset_registers[3] = {ATM90E32_REGISTER_UOFFSETA, ATM90E32_REGISTER_UOFFSETB,
29 ATM90E32_REGISTER_UOFFSETC};
30 const uint16_t current_offset_registers[3] = {ATM90E32_REGISTER_IOFFSETA, ATM90E32_REGISTER_IOFFSETB,
31 ATM90E32_REGISTER_IOFFSETC};
32 const uint16_t power_offset_registers[3] = {ATM90E32_REGISTER_POFFSETA, ATM90E32_REGISTER_POFFSETB,
33 ATM90E32_REGISTER_POFFSETC};
34 const uint16_t reactive_power_offset_registers[3] = {ATM90E32_REGISTER_QOFFSETA, ATM90E32_REGISTER_QOFFSETB,
35 ATM90E32_REGISTER_QOFFSETC};
36 const uint16_t over_voltage_flags[3] = {ATM90E32_STATUS_S0_OVPHASEAST, ATM90E32_STATUS_S0_OVPHASEBST,
37 ATM90E32_STATUS_S0_OVPHASECST};
38 const uint16_t voltage_sag_flags[3] = {ATM90E32_STATUS_S1_SAGPHASEAST, ATM90E32_STATUS_S1_SAGPHASEBST,
39 ATM90E32_STATUS_S1_SAGPHASECST};
40 const uint16_t phase_loss_flags[3] = {ATM90E32_STATUS_S1_PHASELOSSAST, ATM90E32_STATUS_S1_PHASELOSSBST,
41 ATM90E32_STATUS_S1_PHASELOSSCST};
42 void loop() override;
43 void setup() override;
44 void dump_config() override;
45 float get_setup_priority() const override;
46 void update() override;
47 void set_voltage_sensor(int phase, sensor::Sensor *obj) { this->phase_[phase].voltage_sensor_ = obj; }
48 void set_current_sensor(int phase, sensor::Sensor *obj) { this->phase_[phase].current_sensor_ = obj; }
49 void set_power_sensor(int phase, sensor::Sensor *obj) { this->phase_[phase].power_sensor_ = obj; }
50 void set_reactive_power_sensor(int phase, sensor::Sensor *obj) { this->phase_[phase].reactive_power_sensor_ = obj; }
51 void set_apparent_power_sensor(int phase, sensor::Sensor *obj) { this->phase_[phase].apparent_power_sensor_ = obj; }
53 this->phase_[phase].forward_active_energy_sensor_ = obj;
54 }
56 this->phase_[phase].reverse_active_energy_sensor_ = obj;
57 }
58 void set_power_factor_sensor(int phase, sensor::Sensor *obj) { this->phase_[phase].power_factor_sensor_ = obj; }
59 void set_phase_angle_sensor(int phase, sensor::Sensor *obj) { this->phase_[phase].phase_angle_sensor_ = obj; }
61 this->phase_[phase].harmonic_active_power_sensor_ = obj;
62 }
63 void set_peak_current_sensor(int phase, sensor::Sensor *obj) { this->phase_[phase].peak_current_sensor_ = obj; }
64 void set_volt_gain(int phase, uint16_t gain) {
65 this->phase_[phase].voltage_gain_ = gain;
66 this->has_config_voltage_gain_[phase] = true;
67 }
68 void set_ct_gain(int phase, uint16_t gain) {
69 this->phase_[phase].ct_gain_ = gain;
70 this->has_config_current_gain_[phase] = true;
71 }
72 void set_voltage_offset(uint8_t phase, int16_t offset) {
73 this->offset_phase_[phase].voltage_offset_ = offset;
74 this->has_config_voltage_offset_[phase] = true;
75 }
76 void set_current_offset(uint8_t phase, int16_t offset) {
77 this->offset_phase_[phase].current_offset_ = offset;
78 this->has_config_current_offset_[phase] = true;
79 }
80 void set_active_power_offset(uint8_t phase, int16_t offset) {
81 this->power_offset_phase_[phase].active_power_offset = offset;
82 this->has_config_active_power_offset_[phase] = true;
83 }
84 void set_reactive_power_offset(uint8_t phase, int16_t offset) {
85 this->power_offset_phase_[phase].reactive_power_offset = offset;
86 this->has_config_reactive_power_offset_[phase] = true;
87 }
88 void set_freq_sensor(sensor::Sensor *freq_sensor) { freq_sensor_ = freq_sensor; }
90 void set_chip_temperature_sensor(sensor::Sensor *chip_temperature_sensor) {
91 chip_temperature_sensor_ = chip_temperature_sensor;
92 }
93 void set_line_freq(int freq) { line_freq_ = freq; }
94 void set_current_phases(int phases) { current_phases_ = phases; }
95 void set_pga_gain(uint16_t gain) { pga_gain_ = gain; }
103 int16_t calibrate_offset(uint8_t phase, bool voltage);
104 int16_t calibrate_power_offset(uint8_t phase, bool reactive);
106#ifdef USE_NUMBER
107 void set_reference_voltage(uint8_t phase, number::Number *ref_voltage) { ref_voltages_[phase] = ref_voltage; }
108 void set_reference_current(uint8_t phase, number::Number *ref_current) { ref_currents_[phase] = ref_current; }
109#endif
110 float get_reference_voltage(uint8_t phase) {
111#ifdef USE_NUMBER
112 return (phase >= 0 && phase < 3 && ref_voltages_[phase]) ? ref_voltages_[phase]->state : 120.0; // Default voltage
113#else
114 return 120.0; // Default voltage
115#endif
116 }
117 float get_reference_current(uint8_t phase) {
118#ifdef USE_NUMBER
119 return (phase >= 0 && phase < 3 && ref_currents_[phase]) ? ref_currents_[phase]->state : 5.0f; // Default current
120#else
121 return 5.0f; // Default current
122#endif
123 }
124 bool using_saved_calibrations_ = false; // Track if stored calibrations are being used
125#ifdef USE_TEXT_SENSOR
126 void check_phase_status();
127 void check_freq_status();
128 void check_over_current();
130 this->phase_status_text_sensor_[phase] = sensor;
131 }
133#endif
134 uint16_t calculate_voltage_threshold(int line_freq, uint16_t ugain, float multiplier);
136
137 protected:
138#ifdef USE_NUMBER
139 number::Number *ref_voltages_[3]{nullptr, nullptr, nullptr};
140 number::Number *ref_currents_[3]{nullptr, nullptr, nullptr};
141#endif
142 uint16_t read16_(uint16_t a_register);
143 uint16_t read16_transaction_(uint16_t a_register);
144 int read32_(uint16_t addr_h, uint16_t addr_l);
145 void write16_(uint16_t a_register, uint16_t val, bool validate = true);
146 float get_local_phase_voltage_(uint8_t phase);
147 float get_local_phase_current_(uint8_t phase);
148 float get_local_phase_active_power_(uint8_t phase);
149 float get_local_phase_reactive_power_(uint8_t phase);
150 float get_local_phase_apparent_power_(uint8_t phase);
151 float get_local_phase_power_factor_(uint8_t phase);
152 float get_local_phase_forward_active_energy_(uint8_t phase);
153 float get_local_phase_reverse_active_energy_(uint8_t phase);
154 float get_local_phase_angle_(uint8_t phase);
155 float get_local_phase_harmonic_active_power_(uint8_t phase);
156 float get_local_phase_peak_current_(uint8_t phase);
157 float get_phase_voltage_(uint8_t phase);
158 float get_phase_voltage_avg_(uint8_t phase);
159 float get_phase_current_(uint8_t phase);
160 float get_phase_current_avg_(uint8_t phase);
161 float get_phase_active_power_(uint8_t phase);
162 float get_phase_reactive_power_(uint8_t phase);
163 float get_phase_apparent_power_(uint8_t phase);
164 float get_phase_power_factor_(uint8_t phase);
165 float get_phase_forward_active_energy_(uint8_t phase);
166 float get_phase_reverse_active_energy_(uint8_t phase);
167 float get_phase_angle_(uint8_t phase);
168 float get_phase_harmonic_active_power_(uint8_t phase);
169 float get_phase_peak_current_(uint8_t phase);
170 float get_frequency_();
171 float get_chip_temperature_();
180 void write_offsets_to_registers_(uint8_t phase, int16_t voltage_offset, int16_t current_offset);
181 void write_power_offsets_to_registers_(uint8_t phase, int16_t p_offset, int16_t q_offset);
183 bool verify_gain_writes_();
184 bool validate_spi_read_(uint16_t expected, const char *context = nullptr);
186
219
224
226
231
233
235 uint16_t voltage_gain{1};
236 uint16_t current_gain{1};
238
240
241 bool has_config_voltage_offset_[3]{false, false, false};
242 bool has_config_current_offset_[3]{false, false, false};
243 bool has_config_active_power_offset_[3]{false, false, false};
244 bool has_config_reactive_power_offset_[3]{false, false, false};
245 bool has_config_voltage_gain_[3]{false, false, false};
246 bool has_config_current_gain_[3]{false, false, false};
247
251 std::string cs_summary_;
252
254#ifdef USE_TEXT_SENSOR
257#endif
259 uint16_t pga_gain_{0x15};
260 int line_freq_{60};
270 bool offset_calibration_mismatch_[3]{false, false, false};
271 bool power_offset_calibration_mismatch_[3]{false, false, false};
272 bool gain_calibration_mismatch_[3]{false, false, false};
273};
274
275} // namespace atm90e32
276} // namespace esphome
This class simplifies creating components that periodically check a state.
Definition component.h:425
void set_chip_temperature_sensor(sensor::Sensor *chip_temperature_sensor)
Definition atm90e32.h:90
void set_freq_sensor(sensor::Sensor *freq_sensor)
Definition atm90e32.h:88
float get_local_phase_reactive_power_(uint8_t phase)
Definition atm90e32.cpp:445
float get_phase_forward_active_energy_(uint8_t phase)
Definition atm90e32.cpp:528
void set_freq_status_text_sensor(text_sensor::TextSensor *sensor)
Definition atm90e32.h:132
float get_phase_current_avg_(uint8_t phase)
Definition atm90e32.cpp:487
float get_local_phase_apparent_power_(uint8_t phase)
Definition atm90e32.cpp:447
void write16_(uint16_t a_register, uint16_t val, bool validate=true)
Definition atm90e32.cpp:424
void set_apparent_power_sensor(int phase, sensor::Sensor *obj)
Definition atm90e32.h:51
text_sensor::TextSensor * freq_status_text_sensor_
Definition atm90e32.h:256
ESPPreferenceObject power_offset_pref_
Definition atm90e32.h:249
const uint16_t voltage_gain_registers[3]
Definition atm90e32.h:24
float get_phase_voltage_avg_(uint8_t phase)
Definition atm90e32.cpp:473
void write_power_offsets_to_registers_(uint8_t phase, int16_t p_offset, int16_t q_offset)
Definition atm90e32.cpp:810
const uint16_t current_gain_registers[3]
Definition atm90e32.h:26
float get_reference_voltage(uint8_t phase)
Definition atm90e32.h:110
number::Number * ref_voltages_[3]
Definition atm90e32.h:139
void set_power_sensor(int phase, sensor::Sensor *obj)
Definition atm90e32.h:49
struct esphome::atm90e32::ATM90E32Component::GainCalibration gain_phase_[3]
void set_current_offset(uint8_t phase, int16_t offset)
Definition atm90e32.h:76
const uint16_t current_offset_registers[3]
Definition atm90e32.h:30
static const uint8_t PHASEB
Definition atm90e32.h:20
float get_phase_reverse_active_energy_(uint8_t phase)
Definition atm90e32.cpp:539
void set_reactive_power_offset(uint8_t phase, int16_t offset)
Definition atm90e32.h:84
float get_local_phase_harmonic_active_power_(uint8_t phase)
Definition atm90e32.cpp:461
float get_phase_angle_(uint8_t phase)
Definition atm90e32.cpp:555
float get_local_phase_current_(uint8_t phase)
Definition atm90e32.cpp:441
bool validate_spi_read_(uint16_t expected, const char *context=nullptr)
void set_peak_current_sensor(int phase, sensor::Sensor *obj)
Definition atm90e32.h:63
const uint16_t reactive_power_offset_registers[3]
Definition atm90e32.h:34
const uint16_t over_voltage_flags[3]
Definition atm90e32.h:36
void set_reverse_active_energy_sensor(int phase, sensor::Sensor *obj)
Definition atm90e32.h:55
float get_phase_voltage_(uint8_t phase)
Definition atm90e32.cpp:467
void set_current_sensor(int phase, sensor::Sensor *obj)
Definition atm90e32.h:48
GainCalibration config_gain_phase_[3]
Definition atm90e32.h:239
int16_t calibrate_offset(uint8_t phase, bool voltage)
float get_local_phase_reverse_active_energy_(uint8_t phase)
Definition atm90e32.cpp:455
void set_harmonic_active_power_sensor(int phase, sensor::Sensor *obj)
Definition atm90e32.h:60
void set_current_phases(int phases)
Definition atm90e32.h:94
float get_local_phase_forward_active_energy_(uint8_t phase)
Definition atm90e32.cpp:451
OffsetCalibration config_offset_phase_[3]
Definition atm90e32.h:225
struct esphome::atm90e32::ATM90E32Component::OffsetCalibration offset_phase_[3]
void set_active_power_offset(uint8_t phase, int16_t offset)
Definition atm90e32.h:80
uint16_t calculate_voltage_threshold(int line_freq, uint16_t ugain, float multiplier)
float get_local_phase_power_factor_(uint8_t phase)
Definition atm90e32.cpp:449
float get_phase_reactive_power_(uint8_t phase)
Definition atm90e32.cpp:512
void set_enable_gain_calibration(bool flag)
Definition atm90e32.h:102
const uint16_t phase_loss_flags[3]
Definition atm90e32.h:40
float get_phase_apparent_power_(uint8_t phase)
Definition atm90e32.cpp:517
float get_local_phase_voltage_(uint8_t phase)
Definition atm90e32.cpp:439
void set_phase_status_text_sensor(uint8_t phase, text_sensor::TextSensor *sensor)
Definition atm90e32.h:129
void set_pga_gain(uint16_t gain)
Definition atm90e32.h:95
void set_reference_current(uint8_t phase, number::Number *ref_current)
Definition atm90e32.h:108
uint16_t read16_transaction_(uint16_t a_register)
Definition atm90e32.cpp:385
ESPPreferenceObject gain_calibration_pref_
Definition atm90e32.h:250
void write_offsets_to_registers_(uint8_t phase, int16_t voltage_offset, int16_t current_offset)
Definition atm90e32.cpp:794
static const uint8_t PHASEA
Definition atm90e32.h:19
struct esphome::atm90e32::ATM90E32Component::PowerOffsetCalibration power_offset_phase_[3]
float get_reference_current(uint8_t phase)
Definition atm90e32.h:117
number::Number * ref_currents_[3]
Definition atm90e32.h:140
float get_phase_peak_current_(uint8_t phase)
Definition atm90e32.cpp:560
void set_voltage_offset(uint8_t phase, int16_t offset)
Definition atm90e32.h:72
float get_phase_harmonic_active_power_(uint8_t phase)
Definition atm90e32.cpp:550
const uint16_t voltage_sag_flags[3]
Definition atm90e32.h:38
float get_phase_active_power_(uint8_t phase)
Definition atm90e32.cpp:507
PowerOffsetCalibration config_power_offset_phase_[3]
Definition atm90e32.h:232
static const uint8_t PHASEC
Definition atm90e32.h:21
const uint16_t power_offset_registers[3]
Definition atm90e32.h:32
float get_setup_priority() const override
Definition atm90e32.cpp:380
uint16_t read16_(uint16_t a_register)
Definition atm90e32.cpp:395
int read32_(uint16_t addr_h, uint16_t addr_l)
Definition atm90e32.cpp:405
sensor::Sensor * chip_temperature_sensor_
Definition atm90e32.h:258
float get_phase_power_factor_(uint8_t phase)
Definition atm90e32.cpp:522
void set_voltage_sensor(int phase, sensor::Sensor *obj)
Definition atm90e32.h:47
float get_local_phase_angle_(uint8_t phase)
Definition atm90e32.cpp:459
const uint16_t voltage_offset_registers[3]
Definition atm90e32.h:28
void set_ct_gain(int phase, uint16_t gain)
Definition atm90e32.h:68
void set_phase_angle_sensor(int phase, sensor::Sensor *obj)
Definition atm90e32.h:59
void set_reference_voltage(uint8_t phase, number::Number *ref_voltage)
Definition atm90e32.h:107
void set_power_factor_sensor(int phase, sensor::Sensor *obj)
Definition atm90e32.h:58
void set_forward_active_energy_sensor(int phase, sensor::Sensor *obj)
Definition atm90e32.h:52
void set_volt_gain(int phase, uint16_t gain)
Definition atm90e32.h:64
text_sensor::TextSensor * phase_status_text_sensor_[3]
Definition atm90e32.h:255
float get_phase_current_(uint8_t phase)
Definition atm90e32.cpp:501
void set_peak_current_signed(bool flag)
Definition atm90e32.h:89
float get_local_phase_peak_current_(uint8_t phase)
Definition atm90e32.cpp:465
void set_publish_interval_flag_(bool flag)
Definition atm90e32.h:173
int16_t calibrate_power_offset(uint8_t phase, bool reactive)
struct esphome::atm90e32::ATM90E32Component::ATM90E32Phase phase_[3]
void set_enable_offset_calibration(bool flag)
Definition atm90e32.h:101
ESPPreferenceObject offset_pref_
Definition atm90e32.h:248
void set_reactive_power_sensor(int phase, sensor::Sensor *obj)
Definition atm90e32.h:50
float get_local_phase_active_power_(uint8_t phase)
Definition atm90e32.cpp:443
Base-class for all numbers.
Definition number.h:39
Base-class for all sensors.
Definition sensor.h:59
The SPIDevice is what components using the SPI will create.
Definition spi.h:427
AlsGain501 gain
mopeka_std_values val[4]
Providing packet encoding functions for exchanging data with a remote host.
Definition a01nyub.cpp:7
uint32_t IRAM_ATTR HOT millis()
Definition core.cpp:28