-
Notifications
You must be signed in to change notification settings - Fork 2
/
ACS7xx_Allegro.h
111 lines (93 loc) · 4.47 KB
/
ACS7xx_Allegro.h
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
/**************************************************************************/
/*!
@file ACS7xx_Allegro.h
@author SOSAndroid.fr (E. Ha.)
@section HISTORY
v1.0 - First release
v1.1 - Moving exponential average + robustness
v1.2 - Modify the constructor call to avoid some errors
Set of methods to use measurements from ACS7xx sensors from Allegro Micro
All those methods are made to be called periodically
@section LICENSE
Software License Agreement (BSD License)
Copyright (c) 2013, SOSAndroid.fr (E. Ha.)
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holders nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**************************************************************************/
#ifndef _ACS7XX_ALLEGRO_H_
#define _ACS7XX_ALLEGRO_H_
#if ARDUINO >= 100
#include <Arduino.h>
#else
#include <WProgram.h>
#endif
// Enabling debug - comment to disable / normal operations
//#define SERIAL_DEBUG
// Default values - default is ACS712-20A
#define ACS7XX_BIDIR_DEFAULT true //Is the sensor bidirectional ?
#define ACS7XX_PIN_DEFAULT 0 //Pin used for measurements - default A0 from Mega 2650
#define ACS7XX_SENSITIVITY_DEFAULT 0.1 //Sensitivity of the sensor in V/A (divide per 1000 the datasheet value)
#define ACS7XX_FACTOR_VALUE 1000 // adjust the unit read. For instance, a sensitivity in V/A and a 1000 factor provides a mA reading. 1 => A, 1000 => mA
// Default Arduino values
#define BOARD_MEASURED_OFFSET 1 //ADC may shift its measurement. For instance a shitfted value of 1 out of 1024 steps represents 0.05A for ACS712. In perfect world, BOARD_MEASURED_OFFSET should be 0
#define BOARD_VOLTAGE_DEFAULT 5.0 //Power supply voltage
#define BOARD_ADC_DEPTH 1024.0 // 10bits: 1024.0, 12bits: 4096.0, 14bits: 16384.0
// Moving Exponential Average init values
#define EXP_MOVAVG_N 30 //history length impact on moving average impact - keep in mind the moving average will be impacted by the measurement frequency too
#define EXP_MOVAVG_LOOP 1 //number of measurements before starting mobile Average - starting with a simple average - 1 allows a quick start. Value must be 1 minimum
class ACS7XX_ALLEGRO {
public:
ACS7XX_ALLEGRO(void);
ACS7XX_ALLEGRO(boolean bidir, int pintoread, double voltage, double sensitivity);
void begin(void);
void instantCurrent(double *current); //calculates in mA
void ampereHourCount(double *mamperehc); // mAh
void resetCounters(void); // reset all counters
void updateMillis(void); // when starting a new cycle, we need to init Lastmillis
void updateCounters(void);
void getAHCount(double *mahcount);
void getCoulombCount(double *ccount);
void printDebugDeviceInit(void);
double getMovingAvgExp(void);
void resetMovingAvgExp(void);
private:
unsigned long _lastMillis;
double _lastCurrent;
double _lastAmperehour;
double _lastCoulomb;
double _AHCounter;
double _CoulombCounter;
boolean _bidir;
int _pintoread;
double _voltage;
double _voltage_offset;
double _factor_value;
double _sensitivity;
double _resolution;
int _adc_offset;
double _movavgexp_val;
double _movavgexp_alpha;
int _movavgexp_loop;
void movingAvgExp(double current);
};
#endif