This file contains API for HOD CAP Click Driver. More...

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

Data Structures
struct	hodcap_t
	HOD CAP Click context object. More...

struct	hodcap_cfg_t
	HOD CAP Click configuration object. More...

struct	hodcap_status_t
	HOD CAP Click status object. More...

Macros
#define	HODCAP_REG_SENSOR_ID 0x01
	HOD CAP description register.

#define	HODCAP_REG_STATUS 0x02

#define	HODCAP_REG_I_DATA 0x03

#define	HODCAP_REG_Q_DATA 0x04

#define	HODCAP_REG_ADC_STATUS 0x05

#define	HODCAP_REG_EDIV 0x20

#define	HODCAP_REG_FREQ 0x21

#define	HODCAP_REG_TXV 0x22

#define	HODCAP_REG_MUX_CTRL 0x23

#define	HODCAP_REG_SDG 0x24

#define	HODCAP_REG_CBG 0x25

#define	HODCAP_REG_DCLK 0x26

#define	HODCAP_REG_PGA 0x27

#define	HODCAP_REG_PGA_OFFSET_I 0x28

#define	HODCAP_REG_PGA_OFFSET_Q 0x29

#define	HODCAP_REG_ADCTL 0x2A

#define	HODCAP_REG_BLANK 0x2B

#define	HODCAP_REG_DIAG_MUX_CTRL 0x2C

#define	HODCAP_REG_QUICK_READ 0x90

#define	HODCAP_CMD_WRITE 0x10
	HOD CAP description command.

#define	HODCAP_CMD_READ 0x00

#define	HODCAP_CMD_QUICK_READ 0x90

#define	HODCAP_SENSOR_ID 0xA431u
	HOD CAP sensor ID value.

#define	HODCAP_ADC_DATA_READY 0x0001u
	HOD CAP ADC data ready value.

#define	HODCAP_SET_EDIV_12 0x0000u
	HOD CAP division factor values.

#define	HODCAP_SET_EDIV_11 0x0001u

#define	HODCAP_SET_EDIV_10 0x0002u

#define	HODCAP_SET_EDIV_9 0x0003u

#define	HODCAP_SET_EDIV_8 0x0004u

#define	HODCAP_SET_EDIV_7 0x0005u

#define	HODCAP_SET_EDIV_6 0x0006u

#define	HODCAP_SET_EDIV_5 0x0007u

#define	HODCAP_SET_EDIV_4 0x0008u

#define	HODCAP_SET_EDIV_3 0x0009u

#define	HODCAP_SET_EDIV_2 0x000Au

#define	HODCAP_SET_EDIV_1 0x000Bu

#define	HODCAP_SET_EDIV_BIT_MASK 0x000Fu

#define	HODCAP_SET_FREQ_45_45KHZ 0x0000u
	HOD CAP sine wave generator frequency values.

#define	HODCAP_SET_FREQ_71_4KHZ 0x0001u

#define	HODCAP_SET_FREQ_100KHZ 0x0002u

#define	HODCAP_SET_FREQ_125KHZ 0x0003u

#define	HODCAP_SET_TXV_0V 0x0000u
	HOD CAP transmitter output AC voltage values.

#define	HODCAP_SET_TXV_0_5V 0x0001u

#define	HODCAP_SET_TXV_1V 0x0002u

#define	HODCAP_SET_MUX_CTRL_MODE_OPEN 0x0000u
	HOD CAP MUX Control values.

#define	HODCAP_SET_MUX_CTRL_MODE_SENSOR_DRV 0x0001u

#define	HODCAP_SET_MUX_CTRL_MODE_COMMON 0x0002u

#define	HODCAP_SET_MUX_CTRL_MODE_NO_OP 0x0003u

#define	HODCAP_SET_MUX_CTRL_SEL_SEN0 0x0000u

#define	HODCAP_SET_MUX_CTRL_SEL_SEN1 0x0004u

#define	HODCAP_SET_MUX_CTRL_SEL_SEN2 0x0008u

#define	HODCAP_SET_MUX_CTRL_SEL_SEN3 0x000Cu

#define	HODCAP_SET_MUX_CTRL_SEL_SEN4 0x0010u

#define	HODCAP_SET_MUX_CTRL_SEL_SEN5 0x0014u

#define	HODCAP_SET_MUX_CTRL_SEL_SEN6 0x0018u

#define	HODCAP_SET_MUX_CTRL_SEL_SEN7 0x001Cu

#define	HODCAP_SET_MUX_CTRL_SEL_SEN8 0x0020u

#define	HODCAP_SET_MUX_CTRL_SEL_SEN9 0x0024u

#define	HODCAP_SET_MUX_CTRL_SEL_NONE 0x0028u

#define	HODCAP_SET_MUX_CTRL_SEL_VAR_SEN 0x002Cu

#define	HODCAP_SET_MUX_CTRL_SEL_BIT_MASK 0x003Cu

#define	HODCAP_TOTAL_NUMBER_OF_CHANNELS 10
	HOD CAP total number of channels value.

#define	HODCAP_SET_PGA_GAIN_36 0x0000u
	HOD CAP PGA voltage gain control values.

#define	HODCAP_SET_PGA_GAIN_24 0x0001u

#define	HODCAP_SET_PGA_GAIN_16 0x0002u

#define	HODCAP_SET_PGA_GAIN_10_67 0x0003u

#define	HODCAP_SET_PGA_GAIN_7_11 0x0004u

#define	HODCAP_SET_PGA_GAIN_4_74 0x0005u

#define	HODCAP_SET_PGA_GAIN_3_16 0x0006u

#define	HODCAP_SET_PGA_GAIN_2_11 0x0007u

#define	HODCAP_SET_DEFAULT_PGA_OFFSET_I 96
	HOD CAP PGA I/Q offset values.

#define	HODCAP_SET_DEFAULT_PGA_OFFSET_Q 144

#define	HODCAP_SET_ADCTL_MODE_RESET_STOP 0x0000u
	HOD CAP ADC control values.

#define	HODCAP_SET_ADCTL_MODE_START_SINGLE_CONVO 0x0001u

#define	HODCAP_SET_ADCTL_MODE_START_CONT_CONVO 0x0002u

#define	HODCAP_SET_ADCTL_MODE_STOP_CURRENT_CONVO 0x0003u

#define	HODCAP_SET_ADCTL_MODE_BIT_MASK 0x0003u

#define	HODCAP_SET_ADCTL_CS_CLK_250KHZ 0x0000u

#define	HODCAP_SET_ADCTL_CS_CLK_500KHZ 0x0004u

#define	HODCAP_SET_ADCTL_CS_CLK_1000KHZ 0x0008u

#define	HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_4 0x0000u

#define	HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_8 0x0010u

#define	HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_16 0x0020u

#define	HODCAP_SET_ADCTL_TS_400US 0x0000u

#define	HODCAP_SET_ADCTL_TS_576US 0x0040u

#define	HODCAP_SET_ADCTL_TS_664US 0x0080u

#define	HODCAP_SET_MUX_CTRL_PLUS_SEN0 0x0000u
	HOD CAP diagnostic MUX control values.

#define	HODCAP_SET_MUX_CTRL_PLUS_SEN1 0x0001u

#define	HODCAP_SET_MUX_CTRL_PLUS_SEN2 0x0002u

#define	HODCAP_SET_MUX_CTRL_PLUS_SEN3 0x0003u

#define	HODCAP_SET_MUX_CTRL_PLUS_SEN4 0x0004u

#define	HODCAP_SET_MUX_CTRL_PLUS_SEN5 0x0005u

#define	HODCAP_SET_MUX_CTRL_PLUS_SEN6 0x0006u

#define	HODCAP_SET_MUX_CTRL_PLUS_SEN7 0x0007u

#define	HODCAP_SET_MUX_CTRL_PLUS_SEN8 0x0008u

#define	HODCAP_SET_MUX_CTRL_PLUS_SEN9 0x0009u

#define	HODCAP_SET_MUX_CTRL_PLUS_VAR_SEN 0x000Bu

#define	HODCAP_SET_MUX_CTRL_PLUS_NONE 0x000Fu

#define	HODCAP_SET_MUX_CTRL_MINUS_SEN0 0x0000u

#define	HODCAP_SET_MUX_CTRL_MINUS_SEN1 0x0010u

#define	HODCAP_SET_MUX_CTRL_MINUS_SEN2 0x0020u

#define	HODCAP_SET_MUX_CTRL_MINUS_SEN3 0x0030u

#define	HODCAP_SET_MUX_CTRL_MINUS_SEN4 0x0040u

#define	HODCAP_SET_MUX_CTRL_MINUS_SEN5 0x0050u

#define	HODCAP_SET_MUX_CTRL_MINUS_SEN6 0x0060u

#define	HODCAP_SET_MUX_CTRL_MINUS_SEN7 0x0070u

#define	HODCAP_SET_MUX_CTRL_MINUS_SEN8 0x0080u

#define	HODCAP_SET_MUX_CTRL_MINUS_SEN9 0x0090u

#define	HODCAP_SET_MUX_CTRL_MINUS_VAR_SEN 0x00B0u

#define	HODCAP_SET_MUX_CTRL_MINUS_NONE 0x00F0u

#define	HODCAP_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.

#define	HODCAP_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE

#define	HODCAP_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	hodcap_return_value_t { HODCAP_OK = 0 , HODCAP_ERROR = -1 }
	HOD CAP Click return value data. More...

Functions
void	hodcap_cfg_setup (hodcap_cfg_t *cfg)
	HOD CAP configuration object setup function.

err_t	hodcap_init (hodcap_t ctx, hodcap_cfg_t cfg)
	HOD CAP initialization function.

err_t	hodcap_default_cfg (hodcap_t *ctx)
	HOD CAP default configuration function.

err_t	hodcap_generic_write (hodcap_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	HOD CAP data writing function.

err_t	hodcap_generic_read (hodcap_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	HOD CAP data reading function.

err_t	hodcap_write_reg (hodcap_t *ctx, uint8_t reg, uint16_t data_in)
	HOD CAP write register function.

err_t	hodcap_read_reg (hodcap_t ctx, uint8_t reg, uint16_t data_out)
	HOD CAP read register function.

err_t	hodcap_get_sensor_id (hodcap_t ctx, uint16_t sensor_id)
	HOD CAP gets sensor ID function.

err_t	hodcap_get_status (hodcap_t ctx, hodcap_status_t status)
	HOD CAP gets sensor status function.

err_t	hodcap_check_adc_data_ready (hodcap_t ctx, uint16_t data_ready)
	HOD CAP check ADC data ready function.

err_t	hodcap_set_adc_op_mode (hodcap_t *ctx, uint16_t adc_op_mode)
	HOD CAP sets the ADC operation mode function.

err_t	hodcap_mux_channel_selection (hodcap_t *ctx, uint8_t sen_pos)
	HOD CAP MUX channel selection function.

err_t	hodcap_get_i_q_data (hodcap_t ctx, uint16_t i_data, uint16_t *q_data)
	HOD CAP gets the I and Q data function.

err_t	hodcap_wait_adc_data_ready (hodcap_t *ctx)
	HOD CAP wait ADC data ready function.

void	hodcap_set_clk_state (hodcap_t *ctx, uint8_t clk_state)
	HOD CAP set CLK pin state function.

Detailed Description

This file contains API for HOD CAP Click Driver.

Enumeration Type Documentation

◆ hodcap_return_value_t

enum hodcap_return_value_t

HOD CAP Click return value data.

Predefined enum values for driver return values.

Enumerator
HODCAP_OK
HODCAP_ERROR

Data Structures

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ hodcap_return_value_t