adc14 2.1.0.0
adc14.h File Reference

This file contains API for ADC 14 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Go to the source code of this file.

Data Structures

struct  adc14_t
 ADC 14 Click context object. More...
 
struct  adc14_cfg_t
 ADC 14 Click configuration object. More...
 

Macros

#define ADC14_MEASURE_NUM   100
 ADC 14 default value of the internal voltage reference.
 
#define ADC14_RESOLUTION_12BIT   0x0FFFu
 
#define ADC14_RES_DIVIDER   4096.0f
 
#define ADC14_CONVERT_V_T_MV   1000.0f
 
#define ADC14_INT_VREF_2_048V   2.048f
 ADC 14 default value of the internal voltage reference.
 
#define ADC14_EXT_VREF_0V   0.0f
 ADC 14 limits values of the external voltage reference.
 
#define ADC14_EXT_VREF_3_3V   3.3f
 
#define ADC14_MEASURE_NUM   100
 ADC 14 default value of the internal voltage reference.
 
#define ADC14_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection.
 
#define ADC14_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 
#define ADC14_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  adc14_return_value_t { ADC14_OK = 0 , ADC14_ERROR = -1 }
 ADC 14 Click return value data. More...
 

Functions

void adc14_cfg_setup (adc14_cfg_t *cfg)
 ADC 14 configuration object setup function.
 
err_t adc14_init (adc14_t *ctx, adc14_cfg_t *cfg)
 ADC 14 initialization function.
 
void adc14_device_shutdown (adc14_t *ctx)
 ADC 14 device shutdown function.
 
void adc14_device_power_up (adc14_t *ctx)
 ADC 14 device shutdown function.
 
err_t adc14_read_conversion_data (adc14_t *ctx, uint16_t *adc_data)
 ADC 14 read conversion data function.
 
err_t adc14_get_voltage (adc14_t *ctx, float *voltage)
 ADC 14 get voltage function.
 
err_t adc14_set_vref (adc14_t *ctx, float vref)
 ADC 14 set voltage reference function.
 

Detailed Description

This file contains API for ADC 14 Click Driver.

Enumeration Type Documentation

◆ adc14_return_value_t

ADC 14 Click return value data.

Predefined enum values for driver return values.

Enumerator
ADC14_OK 
ADC14_ERROR