Analog2Digital.h

Go to the documentation of this file.

/*
    Analog2Digital.h - A library for analog-to-digital conversions.
    For AVR ATMega328p (Arduino Uno) and ATMega2560 (Arduino Mega).
    This is part of the AVRTools library.
    Copyright (c) 2014 Igor Mikolic-Torreira.  All right reserved.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/


#ifndef Analog2Digital_h
#define Analog2Digital_h

#include <stdint.h>

#include "GpioPinMacros.h"


#if defined(__AVR_ATmega2560__)


enum A2DVoltageReference
{
    kA2dReferenceAREF = 0x00,    
    kA2dReferenceAVCC = 0x01,    
    kA2dReference11V  = 0x02,    
    kA2dReference256V = 0x03     
};

#else

enum A2DVoltageReference
{
    kA2dReferenceAREF = 0x00,    // 0x00 -> AREF pin, internal VREF turned off
    kA2dReferenceAVCC = 0x01,    // 0x01 -> AVCC pin, internal VREF turned off
    kA2dReference11V  = 0x03     // 0x03 -> Internal 1.1V VREF
};

#endif


/*
    The following macro is not intended for end-user use; it is needed to support the pin naming
    macros in conjunction with the C/C++ preprocessor's re-scanning rules.
*/

#define _readGpioPinAnalog( ddr, port, pin, nbr, adc, ocr, com, tccr )      readA2D( adc )




#define readGpioPinAnalog( pinName )                                        _readGpioPinAnalog( pinName )


int readA2D( int8_t channel );



inline uint16_t readGpioPinAnalogV( const GpioPinVariable& pinVar )
{
    return readA2D( pinVar.adcNbr() );
}


void initA2D( uint8_t ref = kA2dReferenceAVCC );



void turnOffA2D();


void setA2DVoltageReference( A2DVoltageReference ref );



inline void setA2DVoltageReferenceAREF()
{ setA2DVoltageReference( kA2dReferenceAREF ); }



inline void setA2DVoltageReferenceAVCC()
{ setA2DVoltageReference( kA2dReferenceAVCC ); }



inline void setA2DVoltageReference11V()
{ setA2DVoltageReference( kA2dReference11V ); }


#if defined(__AVR_ATmega2560__)


inline void setA2DVoltageReference256V()
{ setA2DVoltageReference( kA2dReference256V ); }

#endif



int readA2D( int8_t channel );

#endif