ads1015.hpp

/*
 * Author: Marc Graham <marc@m2ag.net>
 * Copyright (c) 2015 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 "ads1x15.hpp"
#include "upm/iADC.hpp"

#define ADS1015_VREF 2.048

/*=========================================================================
    CONVERSION DELAY (in microS)
    -----------------------------------------------------------------------*/
    #define ADS1015_CONVERSIONDELAY         (8000)
/*=========================================================================*/


/*=========================================================================
    CONFIG REGISTER

  -----------------------------------------------------------------------*/

#define ADS1015_DR_MASK      (0x00E0)
#define ADS1015_DR_128SPS    (0x0000)  // 128 samples per second
#define ADS1015_DR_250SPS    (0x0020)  // 250 samples per second
#define ADS1015_DR_490SPS    (0x0040)  // 490 samples per second
#define ADS1015_DR_920SPS    (0x0060)  // 920 samples per second
#define ADS1015_DR_1600SPS   (0x0080)  // 1600 samples per second (default)
#define ADS1015_DR_2400SPS   (0x00A0)  // 2400 samples per second
#define ADS1015_DR_3300SPS   (0x00C0)  // 3300 samples per second

/*=========================================================================*/

namespace upm {
    class ADS1015 : public ADS1X15, public IADC {

        public:

        typedef enum ADSSAMPLERATE {
         SPS_128           = ADS1015_DR_128SPS,
         SPS_250           = ADS1015_DR_250SPS,
         SPS_490           = ADS1015_DR_490SPS,
         SPS_920           = ADS1015_DR_920SPS,
         SPS_1600          = ADS1015_DR_1600SPS,
         SPS_2400          = ADS1015_DR_2400SPS,
         SPS_3300          = ADS1015_DR_3300SPS
        } ADSSAMPLERATE;


            ADS1015 (int bus, uint8_t address = 0x48, float vref = ADS1015_VREF);

            ~ADS1015 ();

            void setSPS(ADSSAMPLERATE rate = SPS_1600);

            unsigned int getNumInputs();

            uint16_t getRawValue(unsigned int input);

            float getVoltage(unsigned int input);

            unsigned int getResolutionInBits();

            const char* getModuleName();


        protected:
            float getMultiplier(void);
            void setDelay(void);

        private:
            ADS1X15::ADSMUXMODE getMuxMode(unsigned int input);

    };
}