-
Notifications
You must be signed in to change notification settings - Fork 48
/
HLW8012.cpp
241 lines (189 loc) · 6.67 KB
/
HLW8012.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/*
HLW8012
Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <Arduino.h>
#include "HLW8012.h"
void HLW8012::begin(
unsigned char cf_pin,
unsigned char cf1_pin,
unsigned char sel_pin,
unsigned char currentWhen,
bool use_interrupts,
unsigned long pulse_timeout
) {
_cf_pin = cf_pin;
_cf1_pin = cf1_pin;
_sel_pin = sel_pin;
_current_mode = currentWhen;
_use_interrupts = use_interrupts;
_pulse_timeout = pulse_timeout;
pinMode(_cf_pin, INPUT_PULLUP);
pinMode(_cf1_pin, INPUT_PULLUP);
pinMode(_sel_pin, OUTPUT);
_calculateDefaultMultipliers();
_mode = _current_mode;
digitalWrite(_sel_pin, _mode);
}
void HLW8012::setMode(hlw8012_mode_t mode) {
_mode = (mode == MODE_CURRENT) ? _current_mode : 1 - _current_mode;
digitalWrite(_sel_pin, _mode);
if (_use_interrupts) {
_last_cf1_interrupt = _first_cf1_interrupt = micros();
}
}
hlw8012_mode_t HLW8012::getMode() {
return (_mode == _current_mode) ? MODE_CURRENT : MODE_VOLTAGE;
}
hlw8012_mode_t HLW8012::toggleMode() {
hlw8012_mode_t new_mode = getMode() == MODE_CURRENT ? MODE_VOLTAGE : MODE_CURRENT;
setMode(new_mode);
return new_mode;
}
double HLW8012::getCurrent() {
// Power measurements are more sensitive to switch offs,
// so we first check if power is 0 to set _current to 0 too
if (_power == 0) {
_current_pulse_width = 0;
} else if (_use_interrupts) {
_checkCF1Signal();
} else if (_mode == _current_mode) {
_current_pulse_width = pulseIn(_cf1_pin, HIGH, _pulse_timeout);
}
_current = (_current_pulse_width > 0) ? _current_multiplier / _current_pulse_width / 2 : 0;
return _current;
}
unsigned int HLW8012::getVoltage() {
if (_use_interrupts) {
_checkCF1Signal();
} else if (_mode != _current_mode) {
_voltage_pulse_width = pulseIn(_cf1_pin, HIGH, _pulse_timeout);
}
_voltage = (_voltage_pulse_width > 0) ? _voltage_multiplier / _voltage_pulse_width / 2 : 0;
return _voltage;
}
unsigned int HLW8012::getActivePower() {
if (_use_interrupts) {
_checkCFSignal();
} else {
_power_pulse_width = pulseIn(_cf_pin, HIGH, _pulse_timeout);
}
_power = (_power_pulse_width > 0) ? _power_multiplier / _power_pulse_width / 2 : 0;
return _power;
}
unsigned int HLW8012::getApparentPower() {
double current = getCurrent();
unsigned int voltage = getVoltage();
return voltage * current;
}
unsigned int HLW8012::getReactivePower() {
unsigned int active = getActivePower();
unsigned int apparent = getApparentPower();
if (apparent > active) {
return sqrt(apparent * apparent - active * active);
} else {
return 0;
}
}
double HLW8012::getPowerFactor() {
unsigned int active = getActivePower();
unsigned int apparent = getApparentPower();
if (active > apparent) return 1;
if (apparent == 0) return 0;
return (double) active / apparent;
}
unsigned long HLW8012::getEnergy() {
// Counting pulses only works in IRQ mode
if (!_use_interrupts) return 0;
/*
Pulse count is directly proportional to energy:
P = m*f (m=power multiplier, f = Frequency)
f = N/t (N=pulse count, t = time)
E = P*t = m*N (E=energy)
*/
return _pulse_count * _power_multiplier / 1000000. / 2;
}
void HLW8012::resetEnergy() {
_pulse_count = 0;
}
void HLW8012::expectedCurrent(double value) {
if (_current == 0) getCurrent();
if (_current > 0) _current_multiplier *= (value / _current);
}
void HLW8012::expectedVoltage(unsigned int value) {
if (_voltage == 0) getVoltage();
if (_voltage > 0) _voltage_multiplier *= ((double) value / _voltage);
}
void HLW8012::expectedActivePower(unsigned int value) {
if (_power == 0) getActivePower();
if (_power > 0) _power_multiplier *= ((double) value / _power);
}
void HLW8012::resetMultipliers() {
_calculateDefaultMultipliers();
}
void HLW8012::setResistors(double current, double voltage_upstream, double voltage_downstream) {
if (voltage_downstream > 0) {
_current_resistor = current;
_voltage_resistor = (voltage_upstream + voltage_downstream) / voltage_downstream;
_calculateDefaultMultipliers();
}
}
void ICACHE_RAM_ATTR HLW8012::cf_interrupt() {
unsigned long now = micros();
_power_pulse_width = now - _last_cf_interrupt;
_last_cf_interrupt = now;
_pulse_count++;
}
void ICACHE_RAM_ATTR HLW8012::cf1_interrupt() {
unsigned long now = micros();
if ((now - _first_cf1_interrupt) > _pulse_timeout) {
unsigned long pulse_width;
if (_last_cf1_interrupt == _first_cf1_interrupt) {
pulse_width = 0;
} else {
pulse_width = now - _last_cf1_interrupt;
}
if (_mode == _current_mode) {
_current_pulse_width = pulse_width;
} else {
_voltage_pulse_width = pulse_width;
}
_mode = 1 - _mode;
digitalWrite(_sel_pin, _mode);
_first_cf1_interrupt = now;
}
_last_cf1_interrupt = now;
}
void HLW8012::_checkCFSignal() {
if ((micros() - _last_cf_interrupt) > _pulse_timeout) _power_pulse_width = 0;
}
void HLW8012::_checkCF1Signal() {
if ((micros() - _last_cf1_interrupt) > _pulse_timeout) {
if (_mode == _current_mode) {
_current_pulse_width = 0;
} else {
_voltage_pulse_width = 0;
}
toggleMode();
}
}
// These are the multipliers for current, voltage and power as per datasheet
// These values divided by output period (in useconds) give the actual value
// For power a frequency of 1Hz means around 12W
// For current a frequency of 1Hz means around 15mA
// For voltage a frequency of 1Hz means around 0.5V
void HLW8012::_calculateDefaultMultipliers() {
_current_multiplier = ( 1000000.0 * 512 * V_REF / _current_resistor / 24.0 / F_OSC );
_voltage_multiplier = ( 1000000.0 * 512 * V_REF * _voltage_resistor / 2.0 / F_OSC );
_power_multiplier = ( 1000000.0 * 128 * V_REF * V_REF * _voltage_resistor / _current_resistor / 48.0 / F_OSC );
}