upm  1.6.0
Sensor/Actuator repository for libmraa (v1.9.0)
grovevdiv.hpp
1 /*
2  * Author: Jon Trulson <jtrulson@ics.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 <iostream>
28 #include <stdint.h>
29 #include <mraa/aio.h>
30 
31 // reference voltage in millivolts
32 #define GROVEVDIV_VREF 4980
33 
34 // default ADC resolution
35 #define GROVEVDIV_ADC_RES 1024
36 
37 namespace upm {
62  class GroveVDiv {
63  public:
69  GroveVDiv(int pin);
70 
74  ~GroveVDiv();
75 
82  unsigned int value(unsigned int samples);
83 
94  float computedValue(uint8_t gain, unsigned int val, int vref=GROVEVDIV_VREF,
95  int res=GROVEVDIV_ADC_RES);
96 
97  private:
98  mraa_aio_context m_aio;
99  };
100 }
unsigned int value(unsigned int samples)
Definition: grovevdiv.cxx:49
float computedValue(uint8_t gain, unsigned int val, int vref=GROVEVDIV_VREF, int res=GROVEVDIV_ADC_RES)
Definition: grovevdiv.cxx:63
GroveVDiv(int pin)
Definition: grovevdiv.cxx:34
C++ API for the kxtj3 driver.
Definition: a110x.hpp:29
~GroveVDiv()
Definition: grovevdiv.cxx:44
API for the Grove Voltage Divider Sensor.
Definition: grovevdiv.hpp:62