adc13.h File Reference

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

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

Go to the source code of this file.

Data Structures
struct	adc13_t
	ADC 13 Click context object. More...
struct	adc13_cfg_t
	ADC 13 Click configuration object. More...

Macros
#define	ADC13_CMD_NOP   0x00
	ADC 13 commands list.
#define	ADC13_CMD_RESET   0x06
#define	ADC13_CMD_START1   0x08
#define	ADC13_CMD_STOP1   0x0A
#define	ADC13_CMD_START2   0x0C
#define	ADC13_CMD_STOP2   0x0E
#define	ADC13_CMD_RDATA1   0x12
#define	ADC13_CMD_RDATA2   0x14
#define	ADC13_CMD_SYOCAL1   0x16
#define	ADC13_CMD_SYGCAL1   0x17
#define	ADC13_CMD_SFOCAL1   0x19
#define	ADC13_CMD_SYOCAL2   0x1B
#define	ADC13_CMD_SYGCAL2   0x1C
#define	ADC13_CMD_SFOCAL2   0x1E
#define	ADC13_CMD_RREG   0x20
#define	ADC13_CMD_WREG   0x40
#define	ADC13_REG_ID   0x00
	ADC 13 register map.
#define	ADC13_REG_POWER   0x01
#define	ADC13_REG_INTERFACE   0x02
#define	ADC13_REG_MODE0   0x03
#define	ADC13_REG_MODE1   0x04
#define	ADC13_REG_MODE2   0x05
#define	ADC13_REG_INPMUX   0x06
#define	ADC13_REG_OFCAL0   0x07
#define	ADC13_REG_OFCAL1   0x08
#define	ADC13_REG_OFCAL2   0x09
#define	ADC13_REG_FSCAL0   0x0A
#define	ADC13_REG_FSCAL1   0x0B
#define	ADC13_REG_FSCAL2   0x0C
#define	ADC13_REG_IDACMUX   0x0D
#define	ADC13_REG_IDACMAG   0x0E
#define	ADC13_REG_REFMUX   0x0F
#define	ADC13_REG_TDACP   0x10
#define	ADC13_REG_TDACN   0x11
#define	ADC13_REG_GPIOCON   0x12
#define	ADC13_REG_GPIODIR   0x13
#define	ADC13_REG_GPIODAT   0x14
#define	ADC13_ID_DEV_MASK   0xE0
	ADC 13 register mask summary.
#define	ADC13_ID_REV_MASK   0x1F
#define	ADC13_POWER_RESET_MASK   0x10
#define	ADC13_POWER_VBIAS_MASK   0x02
#define	ADC13_POWER_INTREF_MASK   0x01
#define	ADC13_INTERFACE_TIMEOUT_MASK   0x08
#define	ADC13_INTERFACE_STATUS_MASK   0x04
#define	ADC13_INTERFACE_CRC_MASK   0x03
#define	ADC13_MODE0_REFREV_MASK   0x80
#define	ADC13_MODE0_RUN_MODE_MASK   0x40
#define	ADC13_MODE0_CHOP_MASK   0x30
#define	ADC13_MODE0_DELAY_MASK   0x0F
#define	ADC13_MODE1_FILTER_MASK   0xE0
#define	ADC13_MODE1_SBADC_MASK   0x10
#define	ADC13_MODE1_SBPOL_MASK   0x08
#define	ADC13_MODE1_SBMAG_MASK   0x07
#define	ADC13_MODE2_BYPASS_MASK   0x80
#define	ADC13_MODE2_GAIN_MASK   0x70
#define	ADC13_MODE2_DR_MASK   0x0F
#define	ADC13_INPMUX_MUXP_MASK   0xF0
#define	ADC13_INPMUX_MUXN_MASK   0x0F
#define	ADC13_IDACMUX_MUX2_MASK   0xF0
#define	ADC13_IDACMUX_MUX1_MASK   0x0F
#define	ADC13_IDACMAG_MAG2_MASK   0xF0
#define	ADC13_IDACMAG_MAG1_MASK   0x0F
#define	ADC13_REFMUX_RMUXP_MASK   0x38
#define	ADC13_REFMUX_RMUXN_MASK   0x07
#define	ADC13_TDACP_OUTP_MASK   0x80
#define	ADC13_TDACP_MAGP_MASK   0x1F
#define	ADC13_TDACN_OUTN_MASK   0x80
#define	ADC13_TDACN_MAGN_MASK   0x1F
#define	ADC13_REG_COUNT_MASK   0x1F
#define	ADC13_STATUS_ADC2_NEW_DATA   0x80
	ADC 13 STATUS byte field bits.
#define	ADC13_STATUS_ADC1_NEW_DATA   0x40
#define	ADC13_STATUS_EXTCLK_EXTERNAL   0x20
#define	ADC13_STATUS_REF_ALM_LOW_REF   0x10
#define	ADC13_STATUS_PGAL_ALM_LOW_VOLTAGE   0x08
#define	ADC13_STATUS_PGAH_ALM_HIGH_VOLTAGE   0x04
#define	ADC13_STATUS_PGAD_ALM_DIFF_RANGE   0x02
#define	ADC13_STATUS_RESET_OCCURRED   0x01
#define	ADC13_POWER_RESET_NO_NEW_RESET   0
	ADC 13 POWER register setting.
#define	ADC13_POWER_RESET_OCCURRED   1
#define	ADC13_POWER_VBIAS_DISABLE   0
#define	ADC13_POWER_VBIAS_ENABLE   1
#define	ADC13_POWER_INTREF_DISABLE   0
#define	ADC13_POWER_INTREF_ENABLE   1
#define	ADC13_INTERFACE_TIMEOUT_DISABLE   0
	ADC 13 INTERFACE register setting.
#define	ADC13_INTERFACE_TIMEOUT_ENABLE   1
#define	ADC13_INTERFACE_STATUS_DISABLE   0
#define	ADC13_INTERFACE_STATUS_ENABLE   1
#define	ADC13_INTERFACE_CRC_DISABLE   0
#define	ADC13_INTERFACE_CRC_ENABLE_CHECKSUM   1
#define	ADC13_INTERFACE_CRC_ENABLE_CRC   2
#define	ADC13_MODE0_REFREV_NORMAL   0
	ADC 13 MODE0 register setting.
#define	ADC13_MODE0_REFREV_REVERSE   1
#define	ADC13_MODE0_RUN_MODE_CONTINUOUS   0
#define	ADC13_MODE0_RUN_MODE_ONE_SHOT   1
#define	ADC13_MODE0_CHOP_DISABLE   0
#define	ADC13_MODE0_CHOP_ENABLE   1
#define	ADC13_MODE0_CHOP_IDAC_ENABLE   2
#define	ADC13_MODE0_CHOP_AND_IDAC_ENABLE   3
#define	ADC13_MODE0_DELAY_NO_DELAY   0
#define	ADC13_MODE0_DELAY_8p7uS   1
#define	ADC13_MODE0_DELAY_17uS   2
#define	ADC13_MODE0_DELAY_35uS   3
#define	ADC13_MODE0_DELAY_69uS   4
#define	ADC13_MODE0_DELAY_139uS   5
#define	ADC13_MODE0_DELAY_278uS   6
#define	ADC13_MODE0_DELAY_555uS   7
#define	ADC13_MODE0_DELAY_1p1mS   8
#define	ADC13_MODE0_DELAY_2p2mS   9
#define	ADC13_MODE0_DELAY_4p4mS   10
#define	ADC13_MODE0_DELAY_8p8mS   11
#define	ADC13_MODE1_FILTER_SINC1_MODE   0
	ADC 13 MODE1 register setting.
#define	ADC13_MODE1_FILTER_SINC2_MODE   1
#define	ADC13_MODE1_FILTER_SINC3_MODE   2
#define	ADC13_MODE1_FILTER_SINC4_MODE   3
#define	ADC13_MODE1_FILTER_FIR_MODE   4
#define	ADC13_MODE1_SBADC_ADC1_OUT   0
#define	ADC13_MODE1_SBADC_ADC2_OUT   1
#define	ADC13_MODE1_SBPOL_PULLUP_MODE   0
#define	ADC13_MODE1_SBPOL_PULLDOWN_MODE   1
#define	ADC13_MODE1_SBMAG_NO_CURR_NO_RES   0
#define	ADC13_MODE1_SBMAG_0p5uA_CURR   1
#define	ADC13_MODE1_SBMAG_2uA_CURR   2
#define	ADC13_MODE1_SBMAG_10uA_CURR   3
#define	ADC13_MODE1_SBMAG_50uA_CURR   4
#define	ADC13_MODE1_SBMAG_200uA_CURR   5
#define	ADC13_MODE1_SBMAG_10MOHM_RES   6
#define	ADC13_MODE2_BYPASS_PGA_ENABLED   0
	ADC 13 MODE2 register setting.
#define	ADC13_MODE2_BYPASS_PGA_BYPASSED   1
#define	ADC13_MODE2_GAIN_1   0
#define	ADC13_MODE2_GAIN_2   1
#define	ADC13_MODE2_GAIN_4   2
#define	ADC13_MODE2_GAIN_8   3
#define	ADC13_MODE2_GAIN_16   4
#define	ADC13_MODE2_GAIN_32   5
#define	ADC13_MODE2_DR_2p5SPS   0
#define	ADC13_MODE2_DR_5SPS   1
#define	ADC13_MODE2_DR_10SPS   2
#define	ADC13_MODE2_DR_16p6SPS   3
#define	ADC13_MODE2_DR_20SPS   4
#define	ADC13_MODE2_DR_50SPS   5
#define	ADC13_MODE2_DR_60SPS   6
#define	ADC13_MODE2_DR_100SPS   7
#define	ADC13_MODE2_DR_400SPS   8
#define	ADC13_MODE2_DR_1200SPS   9
#define	ADC13_MODE2_DR_2400SPS   10
#define	ADC13_MODE2_DR_4800SPS   11
#define	ADC13_MODE2_DR_7200SPS   12
#define	ADC13_MODE2_DR_14400SPS   13
#define	ADC13_MODE2_DR_19200SPS   14
#define	ADC13_MODE2_DR_38400SPS   15
#define	ADC13_INPMUX_MUXP_AIN0   0
	ADC 13 INPMUX register setting.
#define	ADC13_INPMUX_MUXP_AIN1   1
#define	ADC13_INPMUX_MUXP_AIN2   2
#define	ADC13_INPMUX_MUXP_AIN3   3
#define	ADC13_INPMUX_MUXP_AIN4   4
#define	ADC13_INPMUX_MUXP_AIN5   5
#define	ADC13_INPMUX_MUXP_AIN6   6
#define	ADC13_INPMUX_MUXP_AIN7   7
#define	ADC13_INPMUX_MUXP_AIN8   8
#define	ADC13_INPMUX_MUXP_AIN9   9
#define	ADC13_INPMUX_MUXP_AINCOM   10
#define	ADC13_INPMUX_MUXP_TEMP_SENSOR_POS   11
#define	ADC13_INPMUX_MUXP_AN_POW_SUPP_POS   12
#define	ADC13_INPMUX_MUXP_DIG_POW_SUPP_POS   13
#define	ADC13_INPMUX_MUXP_TDAC_POS   14
#define	ADC13_INPMUX_MUXP_FLOAT   15
#define	ADC13_INPMUX_MUXN_AIN0   0
#define	ADC13_INPMUX_MUXN_AIN1   1
#define	ADC13_INPMUX_MUXN_AIN2   2
#define	ADC13_INPMUX_MUXN_AIN3   3
#define	ADC13_INPMUX_MUXN_AIN4   4
#define	ADC13_INPMUX_MUXN_AIN5   5
#define	ADC13_INPMUX_MUXN_AIN6   6
#define	ADC13_INPMUX_MUXN_AIN7   7
#define	ADC13_INPMUX_MUXN_AIN8   8
#define	ADC13_INPMUX_MUXN_AIN9   9
#define	ADC13_INPMUX_MUXN_AINCOM   10
#define	ADC13_INPMUX_MUXN_TEMP_SENSOR_NEG   11
#define	ADC13_INPMUX_MUXN_AN_POW_SUPP_NEG   12
#define	ADC13_INPMUX_MUXN_DIG_POW_SUPP_NEG   13
#define	ADC13_INPMUX_MUXN_TDAC_NEG   14
#define	ADC13_INPMUX_MUXN_FLOAT   15
#define	ADC13_IDACMUX_MUX2_AIN0   0
	ADC 13 IDACMUX register setting.
#define	ADC13_IDACMUX_MUX2_AIN1   1
#define	ADC13_IDACMUX_MUX2_AIN2   2
#define	ADC13_IDACMUX_MUX2_AIN3   3
#define	ADC13_IDACMUX_MUX2_AIN4   4
#define	ADC13_IDACMUX_MUX2_AIN5   5
#define	ADC13_IDACMUX_MUX2_AIN6   6
#define	ADC13_IDACMUX_MUX2_AIN7   7
#define	ADC13_IDACMUX_MUX2_AIN8   8
#define	ADC13_IDACMUX_MUX2_AIN9   9
#define	ADC13_IDACMUX_MUX2_AINCOM   10
#define	ADC13_IDACMUX_MUX2_NO_CONNECTION   11
#define	ADC13_IDACMUX_MUX1_AIN0   0
#define	ADC13_IDACMUX_MUX1_AIN1   1
#define	ADC13_IDACMUX_MUX1_AIN2   2
#define	ADC13_IDACMUX_MUX1_AIN3   3
#define	ADC13_IDACMUX_MUX1_AIN4   4
#define	ADC13_IDACMUX_MUX1_AIN5   5
#define	ADC13_IDACMUX_MUX1_AIN6   6
#define	ADC13_IDACMUX_MUX1_AIN7   7
#define	ADC13_IDACMUX_MUX1_AIN8   8
#define	ADC13_IDACMUX_MUX1_AIN9   9
#define	ADC13_IDACMUX_MUX1_AINCOM   10
#define	ADC13_IDACMUX_MUX1_NO_CONNECTION   11
#define	ADC13_IDACMAG_MAG2_OFF   0
	ADC 13 IDACMAG register setting.
#define	ADC13_IDACMAG_MAG2_50uA   1
#define	ADC13_IDACMAG_MAG2_100uA   2
#define	ADC13_IDACMAG_MAG2_250uA   3
#define	ADC13_IDACMAG_MAG2_500uA   4
#define	ADC13_IDACMAG_MAG2_750uA   5
#define	ADC13_IDACMAG_MAG2_1000uA   6
#define	ADC13_IDACMAG_MAG2_1500uA   7
#define	ADC13_IDACMAG_MAG2_2000uA   8
#define	ADC13_IDACMAG_MAG2_2500uA   9
#define	ADC13_IDACMAG_MAG2_3000uA   10
#define	ADC13_IDACMAG_MAG1_OFF   0
#define	ADC13_IDACMAG_MAG1_50uA   1
#define	ADC13_IDACMAG_MAG1_100uA   2
#define	ADC13_IDACMAG_MAG1_250uA   3
#define	ADC13_IDACMAG_MAG1_500uA   4
#define	ADC13_IDACMAG_MAG1_750uA   5
#define	ADC13_IDACMAG_MAG1_1000uA   6
#define	ADC13_IDACMAG_MAG1_1500uA   7
#define	ADC13_IDACMAG_MAG1_2000uA   8
#define	ADC13_IDACMAG_MAG1_2500uA   9
#define	ADC13_IDACMAG_MAG1_3000uA   10
#define	ADC13_REFMUX_RMUXP_INTERNAL   0
	ADC 13 REFMUX register setting.
#define	ADC13_REFMUX_RMUXP_EXT_AIN0   1
#define	ADC13_REFMUX_RMUXP_EXT_AIN2   2
#define	ADC13_REFMUX_RMUXP_EXT_AIN4   3
#define	ADC13_REFMUX_RMUXP_INTERNAL_AVDD   4
#define	ADC13_REFMUX_RMUXN_INTERNAL   0
#define	ADC13_REFMUX_RMUXN_EXT_AIN1   1
#define	ADC13_REFMUX_RMUXN_EXT_AIN3   2
#define	ADC13_REFMUX_RMUXN_EXT_AIN5   3
#define	ADC13_REFMUX_RMUXN_INTERNAL_AVSS   4
#define	ADC13_TDACP_OUTP_NO_CONNECTION   0
	ADC 13 TDACP register setting.
#define	ADC13_TDACP_OUTP_AIN6   1
#define	ADC13_TDACP_MAGP_4p5V   9
#define	ADC13_TDACP_MAGP_3p5V   8
#define	ADC13_TDACP_MAGP_3V   7
#define	ADC13_TDACP_MAGP_2p75V   6
#define	ADC13_TDACP_MAGP_2p625V   5
#define	ADC13_TDACP_MAGP_2p5625V   4
#define	ADC13_TDACP_MAGP_2p53125V   3
#define	ADC13_TDACP_MAGP_2p515625V   2
#define	ADC13_TDACP_MAGP_2p5078125V   1
#define	ADC13_TDACP_MAGP_2p5V   0
#define	ADC13_TDACP_MAGP_2p4921875V   17
#define	ADC13_TDACP_MAGP_2p484375V   18
#define	ADC13_TDACP_MAGP_2p46875V   19
#define	ADC13_TDACP_MAGP_2p4375V   20
#define	ADC13_TDACP_MAGP_2p375V   21
#define	ADC13_TDACP_MAGP_2p25V   22
#define	ADC13_TDACP_MAGP_2V   23
#define	ADC13_TDACP_MAGP_1p5V   24
#define	ADC13_TDACP_MAGP_0p5V   25
#define	ADC13_TDACN_OUTN_NO_CONNECTION   0
	ADC 13 TDACN register setting.
#define	ADC13_TDACN_OUTN_AIN7   1
#define	ADC13_TDACN_MAGN_4p5V   9
#define	ADC13_TDACN_MAGN_3p5V   8
#define	ADC13_TDACN_MAGN_3V   7
#define	ADC13_TDACN_MAGN_2p75V   6
#define	ADC13_TDACN_MAGN_2p625V   5
#define	ADC13_TDACN_MAGN_2p5625V   4
#define	ADC13_TDACN_MAGN_2p53125V   3
#define	ADC13_TDACN_MAGN_2p515625V   2
#define	ADC13_TDACN_MAGN_2p5078125V   1
#define	ADC13_TDACN_MAGN_2p5V   0
#define	ADC13_TDACN_MAGN_2p4921875V   17
#define	ADC13_TDACN_MAGN_2p484375V   18
#define	ADC13_TDACN_MAGN_2p46875V   19
#define	ADC13_TDACN_MAGN_2p4375V   20
#define	ADC13_TDACN_MAGN_2p375V   21
#define	ADC13_TDACN_MAGN_2p25V   22
#define	ADC13_TDACN_MAGN_2V   23
#define	ADC13_TDACN_MAGN_1p5V   24
#define	ADC13_TDACN_MAGN_0p5V   25
#define	ADC13_GPIO0   0x01
	ADC 13 GPIO pin high setting.
#define	ADC13_GPIO1   0x02
#define	ADC13_GPIO2   0x04
#define	ADC13_GPIO3   0x08
#define	ADC13_GPIO4   0x10
#define	ADC13_GPIO5   0x20
#define	ADC13_GPIO6   0x40
#define	ADC13_GPIO7   0x80
#define	ADC13_VREF_INTERNAL   2.5
	Voltage reference.
#define	ADC13_VREF_INTERNAL_AVDD   5
#define	ADC13_VREF_3V3   3.3
#define	ADC13_VREF_5V   5
#define	ADC13_CHECKSUM_CONSTANT   0x9B
	Checksum constant.
#define	ADC13_TEMP_MILIVOLTS   122.4
	Temperature constant.
#define	ADC13_TEMP_V_TO_MV   1000
#define	ADC13_TEMP_COEFF   0.42
#define	ADC13_TEMP_OFFSET   25.0
#define	ADC13_TEMP_HEAT_OFFSET   0.7
#define	GET_RIGHTMOST_SET_BIT(bit_mask)
	Calculate position of rightmost set bit.
#define	SET_REG_BITS(reg_data, bit_mask, in_data)
	Set reg bits macro.
#define	GET_REG_BITS(reg_data, bit_mask)   ( ( reg_data & bit_mask ) >> GET_RIGHTMOST_SET_BIT( bit_mask ) )
	Get reg bits macro.
#define	ADC13_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	ADC13_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
#define	ADC13_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	adc13_return_value_t { ADC13_OK = 0 , ADC13_ERROR = -1 }
	ADC 13 Click return value data. More...

Functions
void	adc13_cfg_setup (adc13_cfg_t *cfg)
	ADC 13 configuration object setup function.
err_t	adc13_init (adc13_t *ctx, adc13_cfg_t *cfg)
	ADC 13 initialization function.
err_t	adc13_default_cfg (adc13_t *ctx)
	ADC 13 default configuration function.
err_t	adc13_generic_write (adc13_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
	ADC 13 data writing function.
err_t	adc13_generic_read (adc13_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
	ADC 13 data reading function.
err_t	adc13_send_command (adc13_t *ctx, uint8_t cmd)
	ADC 13 send command function.
void	adc13_set_str_pin (adc13_t *ctx, uint8_t state)
	ADC 13 set STR pin function.
void	adc13_set_rst_pin (adc13_t *ctx, uint8_t state)
	ADC 13 set RST pin function.
uint8_t	adc13_get_dtr_pin (adc13_t *ctx)
	ADC 13 get DTR pin function.
void	adc13_reset_by_pin (adc13_t *ctx)
	ADC 13 reset by pin function.
err_t	adc13_reset_by_command (adc13_t *ctx)
	ADC 13 reset by command function.
void	adc13_power_down (adc13_t *ctx)
	ADC 13 power down function.
void	adc13_power_up (adc13_t *ctx)
	ADC 13 power up function.
err_t	adc13_read_register (adc13_t *ctx, uint8_t reg, uint8_t *data_out)
	ADC 13 read register function.
err_t	adc13_write_register (adc13_t *ctx, uint8_t reg, uint8_t data_in)
	ADC 13 write register function.
err_t	adc13_read_registers (adc13_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t count)
	ADC 13 read registers function.
err_t	adc13_write_registers (adc13_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t count)
	ADC 13 write registers function.
err_t	adc13_set_register_bits (adc13_t *ctx, uint8_t reg, uint8_t bit_mask, uint8_t data_in)
	ADC 13 set register bits function.
err_t	adc13_get_register_bits (adc13_t *ctx, uint8_t reg, uint8_t bit_mask, uint8_t *data_out)
	ADC 13 get register bits function.
err_t	adc13_read_raw_data (adc13_t *ctx, int32_t *data_out)
	ADC 13 read raw data function.
err_t	adc13_measure_voltage (adc13_t *ctx, float vref, float *voltage)
	ADC 13 measure voltage function.
err_t	adc13_measure_temperature (adc13_t *ctx, float *temperature)
	ADC 13 measure temperature function.
err_t	adc13_set_input_channel (adc13_t *ctx, uint8_t pos, uint8_t neg)
	ADC 13 set input channel function.
err_t	adc13_set_voltage_reference (adc13_t *ctx, uint8_t pos, uint8_t neg)
	ADC 13 set voltage reference function.
err_t	adc13_set_gain (adc13_t *ctx, uint8_t gain)
	ADC 13 set gain function.
err_t	adc13_set_sample_rate (adc13_t *ctx, uint8_t s_rate)
	ADC 13 set sample rate function.

Detailed Description

This file contains API for ADC 13 Click Driver.

Enumeration Type Documentation

adc13_return_value_t

enum adc13_return_value_t

ADC 13 Click return value data.

Predefined enum values for driver return values.

Enumerator
ADC13_OK
ADC13_ERROR