Adc.h

Go to the documentation of this file.

/************************************************
 *
 *  CROSSCONTROL AUX API
 *
 *  Adc.h
 *
 *  Version 2.15.2.0, 2020-07-08
 *
 *  (c) CrossControl 2010-2020
 *

 *  File description: 
 *  Get current voltages from the built-in ADC
 *
 *  Use the function GetAdc() to get a handle to pass on to the other functions. 
 *  Use the method Adc_release(ADCHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include adc_example.cpp
 *
 ************************************************/

#ifndef CC_ADC_H_
#define CC_ADC_H_

#include "CCAuxErrors.h"
#include "CCPlatform.h"
#include "CCAuxTypes.h"

#ifdef __cplusplus
namespace CrossControl {
#endif

  typedef void* ADCHANDLE;

  EXTERN_C
    CCAUXDLL_API
    ADCHANDLE
    CCAUXDLL_CALLING_CONV
    GetAdc(void);

  EXTERN_C
    CCAUXDLL_API
    void 
    CCAUXDLL_CALLING_CONV
    Adc_release(ADCHANDLE);

  EXTERN_C
    CCAUXDLL_API
    eErr 
    CCAUXDLL_CALLING_CONV
    Adc_getVoltage(ADCHANDLE, VoltageEnum selection, float64_t* value);

#ifdef __cplusplus
} /* namespace CrossControl */
#endif

#endif /* CC_ADC_H_ */