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
|
/*
* Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
* Copyright (c) 2014 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#pragma once
#include <string>
#include <math.h>
#include <mraa/aio.h>
#include <mraa/gpio.h>
namespace upm {
#define NUMBER_OF_SAMPLES 500
#define ADC_RESOLUTION 1024
#define SUPPLYVOLTAGE 5100
#define CURRENT_RATIO 2000.0
#define HIGH 1
#define LOW 0
#define TRUE HIGH
#define FALSE LOW
/**
* @brief ECS1030 Electricity Sensor library
* @defgroup ecs1030 libupm-ecs1030
* @ingroup sparkfun analog electric
*/
/**
* @library ecs1030
* @sensor ecs1030
* @comname ECS1030 Non-Invasive Current Sensor
* @type electric
* @man sparkfun
* @web https://www.sparkfun.com/products/11005
* @con analog
*
* @brief API for the ECS1030 Non-Invasive Current/Electricity Sensor
*
* This non-invasive current sensor can be clamped around the supply line of
* an electrical load to tell you how much current is passing through it. It
* does this by acting as an inductor and responding to the magnetic field
* around a current-carrying conductor. This particular current sensor
* measures a load up to 30 A, which makes it great for building your own
* energy monitors.
*
* @image html ecs1030.jpg
* <br><em>ECS1030 Sensor image provided by SparkFun* under
* <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>
* CC BY-NC-SA-3.0</a>.</em>
*
* @snippet ecs1030.cxx Interesting
*/
class ECS1030 {
public:
static const uint8_t DELAY_MS = 20000 / NUMBER_OF_SAMPLES; /* 1/50Hz is 20ms period */
static const uint8_t VOLT_M = 5.1 / 1023;
static const uint8_t R_LOAD = 2000.0 / CURRENT_RATIO;
/**
* Instantiates an ECS1030 object
*
* @param pinNumber Number of the data pin
*/
ECS1030 (uint8_t pinNumber);
/**
* ECS1030 object destructor; basically, it closes the GPIO.
*/
~ECS1030 ();
/**
* Returns electric current data for a sampled period
*/
double getCurrency_A ();
/**
* Returns power data for a sampled period
*/
double getPower_A ();
/**
* Returns electric current data for a sampled period
*/
double getCurrency_B ();
/**
* Returns power data for a sampled period
*/
double getPower_B ();
/**
* Returns the name of the component
*/
std::string name() {
return m_name;
}
private:
std::string m_name;
mraa_aio_context m_dataPinCtx;
double m_calibration;
int m_lastSample;
double m_lastFilter;
int m_sample;
double m_filteredSample;
};
}
|
