src/ecs1030/ecs1030.h

   1 /*
   2  * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
   3  * Copyright (c) 2014 Intel Corporation.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24 #pragma once
  25
  26 #include <string>
  27 #include <math.h>
  28 #include <mraa/aio.h>
  29 #include <mraa/gpio.h>
  30
  31 #define NUMBER_OF_SAMPLES  500
  32 #define ADC_RESOLUTION     1024
  33 #define SUPPLYVOLTAGE      5100
  34 #define CURRENT_RATIO      2000.0
  35
  36 #define HIGH               1
  37 #define LOW                0
  38
  39 #define TRUE               HIGH
  40 #define FALSE              LOW
  41
  42 namespace upm {
  43     class ECS1030 {
  44         public:
  45             static const uint8_t DELAY_MS  = 20000 / NUMBER_OF_SAMPLES; /* 1/50Hz is 20ms period */
  46             static const uint8_t VOLT_M    = 5.1 / 1023;
  47             static const uint8_t R_LOAD    = 2000.0 / CURRENT_RATIO;
  48
  49             /**
  50              * Instanciates a ECS1030 (current sensor) object
  51              *
  52              * @param pinNumber number of the data pin
  53              */
  54             ECS1030 (uint8_t pinNumber);
  55
  56             /**
  57              * ECS1030 object destructor, basicaly it close the GPIO.
  58              */
  59             ~ECS1030 ();
  60
  61             /**
  62              * Return currency data for the sampled period
  63              */
  64             double getCurrency_A ();
  65
  66             /**
  67              * Return power data for the sampled period
  68              */
  69             double getPower_A ();
  70
  71             /**
  72              * Return currency data for the sampled period
  73              */
  74             double getCurrency_B ();
  75
  76             /**
  77              * Return power data for the sampled period
  78              */
  79             double getPower_B ();
  80
  81             /**
  82              * Return name of the component
  83              */
  84             std::string name() {
  85                 return m_name;
  86             }
  87         private:
  88             std::string         m_name;
  89             mraa_aio_context    m_dataPinCtx;
  90
  91             double              m_calibration;
  92             int                 m_lastSample;
  93             double              m_lastFilter;
  94             int                 m_sample;
  95             double              m_filteredSample;
  96     };
  97 }