upm  1.6.0
Sensor/Actuator repository for libmraa (v1.9.0)
ads1015.hpp
1 /*
2  * Author: Marc Graham <marc@m2ag.net>
3  * Copyright (c) 2015 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 /*=========================================================================*/
25 
26 #pragma once
27 
28 #include "ads1x15.hpp"
29 #include "interfaces/iADC.hpp"
30 
31 #define ADS1015_VREF 2.048
32 
33 /*=========================================================================
34  CONVERSION DELAY (in microS)
35  -----------------------------------------------------------------------*/
36  #define ADS1015_CONVERSIONDELAY (8000)
37 /*=========================================================================*/
38 
39 
40 /*=========================================================================
41  CONFIG REGISTER
42 
43  -----------------------------------------------------------------------*/
44 
45 #define ADS1015_DR_MASK (0x00E0)
46 #define ADS1015_DR_128SPS (0x0000) // 128 samples per second
47 #define ADS1015_DR_250SPS (0x0020) // 250 samples per second
48 #define ADS1015_DR_490SPS (0x0040) // 490 samples per second
49 #define ADS1015_DR_920SPS (0x0060) // 920 samples per second
50 #define ADS1015_DR_1600SPS (0x0080) // 1600 samples per second (default)
51 #define ADS1015_DR_2400SPS (0x00A0) // 2400 samples per second
52 #define ADS1015_DR_3300SPS (0x00C0) // 3300 samples per second
53 
54 /*=========================================================================*/
55 
56 namespace upm {
88  class ADS1015 : public ADS1X15, public IADC {
89 
90  public:
91 
105  typedef enum ADSSAMPLERATE {
106  SPS_128 = ADS1015_DR_128SPS,
107  SPS_250 = ADS1015_DR_250SPS,
108  SPS_490 = ADS1015_DR_490SPS,
109  SPS_920 = ADS1015_DR_920SPS,
110  SPS_1600 = ADS1015_DR_1600SPS,
111  SPS_2400 = ADS1015_DR_2400SPS,
112  SPS_3300 = ADS1015_DR_3300SPS
113  } ADSSAMPLERATE;
114 
115 
126  ADS1015 (int bus, uint8_t address = 0x48, float vref = ADS1015_VREF);
127 
131  ~ADS1015 ();
132 
140  void setSPS(ADSSAMPLERATE rate = SPS_1600);
141 
147  unsigned int getNumInputs();
148 
154  uint16_t getRawValue(unsigned int input);
155 
161  float getVoltage(unsigned int input);
162 
168  unsigned int getResolutionInBits();
169 
175  const char* getModuleName();
176 
177 
178  protected:
179  float getMultiplier(void);
180  void setDelay(void);
181 
182  private:
183  ADS1X15::ADSMUXMODE getMuxMode(unsigned int input);
184 
185  };
186 }
ADSSAMPLERATE
uint16_t enum containing values representing the sample rate of the device.
Definition: ads1015.hpp:105
unsigned int getResolutionInBits()
Definition: ads1015.cxx:72
unsigned int getNumInputs()
Definition: ads1015.cxx:67
uint16_t getRawValue(unsigned int input)
Definition: ads1015.cxx:77
Definition: ads1x15.hpp:113
void setSPS(ADSSAMPLERATE rate=SPS_1600)
Definition: ads1015.cxx:33
ADS1015(int bus, uint8_t address=0x48, float vref=ADS1015_VREF)
Definition: ads1015.cxx:37
C++ API for the kxtj3 driver.
Definition: a110x.hpp:29
API for ADS1015.
Definition: ads1015.hpp:88
ADSMUXMODE
uint16_t enum containing values used for selecting ADS1X15 read operations.
Definition: ads1x15.hpp:152
~ADS1015()
Definition: ads1015.cxx:58
Interface for ADC Sensors.
Definition: iADC.hpp:36
float getVoltage(unsigned int input)
Definition: ads1015.cxx:87
const char * getModuleName()
Definition: ads1015.cxx:61