adc17 2.0.0.0
adc17.h File Reference

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

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  adc17_t
 ADC 17 Click context object. More...
 
struct  adc17_cfg_t
 ADC 17 Click configuration object. More...
 

Macros

#define ADC17_REG_SETUP   0x80
 ADC 17 setup byte values.
 
#define ADC17_SETUP_VREF_VDD_REF_NC_OFF   0x00
 
#define ADC17_SETUP_VREF_EXT_REF_IN_OFF   0x20
 
#define ADC17_SETUP_VREF_INT_REF_NC_OFF   0x40
 
#define ADC17_SETUP_VREF_INT_REF_NC_ON   0x50
 
#define ADC17_SETUP_VREF_INT_REF_OUT_OFF   0x60
 
#define ADC17_SETUP_VREF_INT_REF_OUT_ON   0x70
 
#define ADC17_SETUP_CLK_INT   0x00
 
#define ADC17_SETUP_CLK_EXT   0x08
 
#define ADC17_SETUP_UNIPOLAR   0x00
 
#define ADC17_SETUP_BIPOLAR   0x04
 
#define ADC17_SETUP_RST_RESET   0x00
 
#define ADC17_SETUP_RST_NO_ACTION   0x02
 
#define ADC17_REG_CONFIG   0x00
 ADC 17 config byte values.
 
#define ADC17_CONFIG_SCAN_AIN0_TO_CS0   0x00
 
#define ADC17_CONFIG_SCAN_CS0_8_TIMES   0x20
 
#define ADC17_CONFIG_SCAN_CS0   0x60
 
#define ADC17_CONFIG_CS0_AIN0   0x00
 
#define ADC17_CONFIG_CS0_AIN1   0x02
 
#define ADC17_CONFIG_DIFFERENTIAL   0x00
 
#define ADC17_CONFIG_SINGLE_ENDED   0x01
 
#define ADC17_REG_BIT_MASK   0x80
 ADC 17 register bit mask.
 
#define ADC17_SETUP_VREF_BIT_MASK   0x70
 
#define ADC17_SETUP_CLK_BIT_MASK   0x08
 
#define ADC17_SETUP_UNI_BIP_BIT_MASK   0x04
 
#define ADC17_SETUP_RST_BIT_MASK   0x02
 
#define ADC17_CONFIG_SCAN_BIT_MASK   0x60
 
#define ADC17_CONFIG_CS0_BIT_MASK   0x02
 
#define ADC17_CONFIG_SGL_DIF_BIT_MASK   0x01
 
#define ADC17_CHANNEL_0   0
 ADC 17 channel selection values.
 
#define ADC17_CHANNEL_1   1
 
#define ADC17_RESOLUTION   0x0FFF
 ADC 17 calculation values.
 
#define ADC17_VREF   2.048
 
#define ADC17_SET_DEV_ADDR   0x36
 ADC 17 device address setting.
 
#define ADC17_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  adc17_return_value_t { ADC17_OK = 0 , ADC17_ERROR = -1 }
 ADC 17 Click return value data. More...
 

Functions

void adc17_cfg_setup (adc17_cfg_t *cfg)
 ADC 17 configuration object setup function.
 
err_t adc17_init (adc17_t *ctx, adc17_cfg_t *cfg)
 ADC 17 initialization function.
 
err_t adc17_default_cfg (adc17_t *ctx)
 ADC 17 default configuration function.
 
err_t adc17_write_setup_byte (adc17_t *ctx, uint8_t setup_byte)
 ADC 17 write setup byte function.
 
err_t adc17_write_config_byte (adc17_t *ctx, uint8_t config_byte)
 ADC 17 write config byte function.
 
err_t adc17_set_channel (adc17_t *ctx, uint8_t channel)
 ADC 17 set channel function.
 
err_t adc17_get_voltage (adc17_t *ctx, float *voltage)
 ADC 17 get voltage function.
 

Detailed Description

This file contains API for ADC 17 Click Driver.

Enumeration Type Documentation

◆ adc17_return_value_t

ADC 17 Click return value data.

Predefined enum values for driver return values.

Enumerator
ADC17_OK 
ADC17_ERROR