hierodule/hierodule__adc_8h_source.html

#ifndef __HIERODULE_ADC_H

#define __HIERODULE_ADC_H


#ifdef __cplusplus

extern "C"

{

#endif


#define HIERODULE_ADC_SMOOTHENING_FILTER


#include <main.h>

#include <stdlib.h>


typedef struct

{

    ADC_TypeDef *_ADC;

    uint16_t Data;

    #ifdef HIERODULE_ADC_SMOOTHENING_FILTER

    double FilterWeight;

    #endif

    void (*Data_Handler)(uint16_t);

} HIERODULE_ADC_Wrapper;


HIERODULE_ADC_Wrapper **HIERODULE_ADC_InitWrapper(ADC_TypeDef *_ADC,

    void (*ISR)(uint16_t));


void HIERODULE_ADC_ReleaseWrapper(HIERODULE_ADC_Wrapper *Wrapper);


void HIERODULE_ADC_Enable(HIERODULE_ADC_Wrapper *Wrapper);


void HIERODULE_ADC_Disable(HIERODULE_ADC_Wrapper *Wrapper);


#ifdef __cplusplus

}

#endif


#endif /* __HIERODULE_ADC_H */

HIERODULE_ADC_InitWrapper
HIERODULE_ADC_Wrapper ** HIERODULE_ADC_InitWrapper(ADC_TypeDef *_ADC, void(*ISR)(uint16_t))
Initializes a wrapper for the specified ADC peripheral.
Definition hierodule_adc.c:67

HIERODULE_ADC_Enable
void HIERODULE_ADC_Enable(HIERODULE_ADC_Wrapper *Wrapper)
Updates relevant control register bits to start ADC action.
Definition hierodule_adc.c:118

HIERODULE_ADC_ReleaseWrapper
void HIERODULE_ADC_ReleaseWrapper(HIERODULE_ADC_Wrapper *Wrapper)
Frees the memory allocated to an ADC wrapper.
Definition hierodule_adc.c:108

HIERODULE_ADC_Disable
void HIERODULE_ADC_Disable(HIERODULE_ADC_Wrapper *Wrapper)
Updates relevant control register bits to stop ADC action.
Definition hierodule_adc.c:146

Wrapper
HIERODULE_USB_Wrapper Wrapper
Extern declaration for the wrapper instance in the source file.
Definition hierodule_usb.c:27

HIERODULE_ADC_Wrapper
Struct that keeps variables for the ADC data, a pointer to the ADC peripheral and a pointer to the IS...
Definition hierodule_adc.h:47

HIERODULE_ADC_Wrapper::_ADC
ADC_TypeDef * _ADC
Pointer to the ADC peripheral.
Definition hierodule_adc.h:51

HIERODULE_ADC_Wrapper::FilterWeight
double FilterWeight
Filter weight for the smoothening filter.
Definition hierodule_adc.h:61

HIERODULE_ADC_Wrapper::Data
uint16_t Data
Variable to assign the received ADC data.
Definition hierodule_adc.h:55