hodcap 2.1.0.0
HOD CAP Registers Settings

Settings for registers of HOD CAP Click driver. More...

Macros

#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
 

Detailed Description

Settings for registers of HOD CAP Click driver.

Macro Definition Documentation

◆ HODCAP_ADC_DATA_READY

#define HODCAP_ADC_DATA_READY   0x0001u

HOD CAP ADC data ready value.

ADC data ready value of HOD CAP Click driver.

◆ HODCAP_SENSOR_ID

#define HODCAP_SENSOR_ID   0xA431u

HOD CAP sensor ID value.

Specified sensor ID value of HOD CAP Click driver.

◆ HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_16

#define HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_16   0x0020u

◆ HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_4

#define HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_4   0x0000u

◆ HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_8

#define HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_8   0x0010u

◆ HODCAP_SET_ADCTL_CS_CLK_1000KHZ

#define HODCAP_SET_ADCTL_CS_CLK_1000KHZ   0x0008u

◆ HODCAP_SET_ADCTL_CS_CLK_250KHZ

#define HODCAP_SET_ADCTL_CS_CLK_250KHZ   0x0000u

◆ HODCAP_SET_ADCTL_CS_CLK_500KHZ

#define HODCAP_SET_ADCTL_CS_CLK_500KHZ   0x0004u

◆ HODCAP_SET_ADCTL_MODE_BIT_MASK

#define HODCAP_SET_ADCTL_MODE_BIT_MASK   0x0003u

◆ HODCAP_SET_ADCTL_MODE_RESET_STOP

#define HODCAP_SET_ADCTL_MODE_RESET_STOP   0x0000u

HOD CAP ADC control values.

ADC control values of HOD CAP Click driver.

◆ HODCAP_SET_ADCTL_MODE_START_CONT_CONVO

#define HODCAP_SET_ADCTL_MODE_START_CONT_CONVO   0x0002u

◆ HODCAP_SET_ADCTL_MODE_START_SINGLE_CONVO

#define HODCAP_SET_ADCTL_MODE_START_SINGLE_CONVO   0x0001u

◆ HODCAP_SET_ADCTL_MODE_STOP_CURRENT_CONVO

#define HODCAP_SET_ADCTL_MODE_STOP_CURRENT_CONVO   0x0003u

◆ HODCAP_SET_ADCTL_TS_400US

#define HODCAP_SET_ADCTL_TS_400US   0x0000u

◆ HODCAP_SET_ADCTL_TS_576US

#define HODCAP_SET_ADCTL_TS_576US   0x0040u

◆ HODCAP_SET_ADCTL_TS_664US

#define HODCAP_SET_ADCTL_TS_664US   0x0080u

◆ HODCAP_SET_DATA_SAMPLE_EDGE

#define HODCAP_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE

Data sample selection.

This macro sets data samples for SPI modules.

Note
Available only on Microchip PIC family devices. This macro will set data sampling for all SPI modules on MCU. Can be overwritten with hodcap_init which will set SET_SPI_DATA_SAMPLE_MIDDLE by default on the mapped mikrobus.

◆ HODCAP_SET_DATA_SAMPLE_MIDDLE

#define HODCAP_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE

◆ HODCAP_SET_DEFAULT_PGA_OFFSET_I

#define HODCAP_SET_DEFAULT_PGA_OFFSET_I   96

HOD CAP PGA I/Q offset values.

PGA I/Q offset values of HOD CAP Click driver.

◆ HODCAP_SET_DEFAULT_PGA_OFFSET_Q

#define HODCAP_SET_DEFAULT_PGA_OFFSET_Q   144

◆ HODCAP_SET_EDIV_1

#define HODCAP_SET_EDIV_1   0x000Bu

◆ HODCAP_SET_EDIV_10

#define HODCAP_SET_EDIV_10   0x0002u

◆ HODCAP_SET_EDIV_11

#define HODCAP_SET_EDIV_11   0x0001u

◆ HODCAP_SET_EDIV_12

#define HODCAP_SET_EDIV_12   0x0000u

HOD CAP division factor values.

Division factor values of HOD CAP Click driver.

◆ HODCAP_SET_EDIV_2

#define HODCAP_SET_EDIV_2   0x000Au

◆ HODCAP_SET_EDIV_3

#define HODCAP_SET_EDIV_3   0x0009u

◆ HODCAP_SET_EDIV_4

#define HODCAP_SET_EDIV_4   0x0008u

◆ HODCAP_SET_EDIV_5

#define HODCAP_SET_EDIV_5   0x0007u

◆ HODCAP_SET_EDIV_6

#define HODCAP_SET_EDIV_6   0x0006u

◆ HODCAP_SET_EDIV_7

#define HODCAP_SET_EDIV_7   0x0005u

◆ HODCAP_SET_EDIV_8

#define HODCAP_SET_EDIV_8   0x0004u

◆ HODCAP_SET_EDIV_9

#define HODCAP_SET_EDIV_9   0x0003u

◆ HODCAP_SET_EDIV_BIT_MASK

#define HODCAP_SET_EDIV_BIT_MASK   0x000Fu

◆ HODCAP_SET_FREQ_100KHZ

#define HODCAP_SET_FREQ_100KHZ   0x0002u

◆ HODCAP_SET_FREQ_125KHZ

#define HODCAP_SET_FREQ_125KHZ   0x0003u

◆ HODCAP_SET_FREQ_45_45KHZ

#define HODCAP_SET_FREQ_45_45KHZ   0x0000u

HOD CAP sine wave generator frequency values.

Sine wave generator frequency values of HOD CAP Click driver.

◆ HODCAP_SET_FREQ_71_4KHZ

#define HODCAP_SET_FREQ_71_4KHZ   0x0001u

◆ HODCAP_SET_MUX_CTRL_MINUS_NONE

#define HODCAP_SET_MUX_CTRL_MINUS_NONE   0x00F0u

◆ HODCAP_SET_MUX_CTRL_MINUS_SEN0

#define HODCAP_SET_MUX_CTRL_MINUS_SEN0   0x0000u

◆ HODCAP_SET_MUX_CTRL_MINUS_SEN1

#define HODCAP_SET_MUX_CTRL_MINUS_SEN1   0x0010u

◆ HODCAP_SET_MUX_CTRL_MINUS_SEN2

#define HODCAP_SET_MUX_CTRL_MINUS_SEN2   0x0020u

◆ HODCAP_SET_MUX_CTRL_MINUS_SEN3

#define HODCAP_SET_MUX_CTRL_MINUS_SEN3   0x0030u

◆ HODCAP_SET_MUX_CTRL_MINUS_SEN4

#define HODCAP_SET_MUX_CTRL_MINUS_SEN4   0x0040u

◆ HODCAP_SET_MUX_CTRL_MINUS_SEN5

#define HODCAP_SET_MUX_CTRL_MINUS_SEN5   0x0050u

◆ HODCAP_SET_MUX_CTRL_MINUS_SEN6

#define HODCAP_SET_MUX_CTRL_MINUS_SEN6   0x0060u

◆ HODCAP_SET_MUX_CTRL_MINUS_SEN7

#define HODCAP_SET_MUX_CTRL_MINUS_SEN7   0x0070u

◆ HODCAP_SET_MUX_CTRL_MINUS_SEN8

#define HODCAP_SET_MUX_CTRL_MINUS_SEN8   0x0080u

◆ HODCAP_SET_MUX_CTRL_MINUS_SEN9

#define HODCAP_SET_MUX_CTRL_MINUS_SEN9   0x0090u

◆ HODCAP_SET_MUX_CTRL_MINUS_VAR_SEN

#define HODCAP_SET_MUX_CTRL_MINUS_VAR_SEN   0x00B0u

◆ HODCAP_SET_MUX_CTRL_MODE_COMMON

#define HODCAP_SET_MUX_CTRL_MODE_COMMON   0x0002u

◆ HODCAP_SET_MUX_CTRL_MODE_NO_OP

#define HODCAP_SET_MUX_CTRL_MODE_NO_OP   0x0003u

◆ HODCAP_SET_MUX_CTRL_MODE_OPEN

#define HODCAP_SET_MUX_CTRL_MODE_OPEN   0x0000u

HOD CAP MUX Control values.

MUX Control values of HOD CAP Click driver.

◆ HODCAP_SET_MUX_CTRL_MODE_SENSOR_DRV

#define HODCAP_SET_MUX_CTRL_MODE_SENSOR_DRV   0x0001u

◆ HODCAP_SET_MUX_CTRL_PLUS_NONE

#define HODCAP_SET_MUX_CTRL_PLUS_NONE   0x000Fu

◆ HODCAP_SET_MUX_CTRL_PLUS_SEN0

#define HODCAP_SET_MUX_CTRL_PLUS_SEN0   0x0000u

HOD CAP diagnostic MUX control values.

Diagnostic MUX control values of HOD CAP Click driver.

◆ HODCAP_SET_MUX_CTRL_PLUS_SEN1

#define HODCAP_SET_MUX_CTRL_PLUS_SEN1   0x0001u

◆ HODCAP_SET_MUX_CTRL_PLUS_SEN2

#define HODCAP_SET_MUX_CTRL_PLUS_SEN2   0x0002u

◆ HODCAP_SET_MUX_CTRL_PLUS_SEN3

#define HODCAP_SET_MUX_CTRL_PLUS_SEN3   0x0003u

◆ HODCAP_SET_MUX_CTRL_PLUS_SEN4

#define HODCAP_SET_MUX_CTRL_PLUS_SEN4   0x0004u

◆ HODCAP_SET_MUX_CTRL_PLUS_SEN5

#define HODCAP_SET_MUX_CTRL_PLUS_SEN5   0x0005u

◆ HODCAP_SET_MUX_CTRL_PLUS_SEN6

#define HODCAP_SET_MUX_CTRL_PLUS_SEN6   0x0006u

◆ HODCAP_SET_MUX_CTRL_PLUS_SEN7

#define HODCAP_SET_MUX_CTRL_PLUS_SEN7   0x0007u

◆ HODCAP_SET_MUX_CTRL_PLUS_SEN8

#define HODCAP_SET_MUX_CTRL_PLUS_SEN8   0x0008u

◆ HODCAP_SET_MUX_CTRL_PLUS_SEN9

#define HODCAP_SET_MUX_CTRL_PLUS_SEN9   0x0009u

◆ HODCAP_SET_MUX_CTRL_PLUS_VAR_SEN

#define HODCAP_SET_MUX_CTRL_PLUS_VAR_SEN   0x000Bu

◆ HODCAP_SET_MUX_CTRL_SEL_BIT_MASK

#define HODCAP_SET_MUX_CTRL_SEL_BIT_MASK   0x003Cu

◆ HODCAP_SET_MUX_CTRL_SEL_NONE

#define HODCAP_SET_MUX_CTRL_SEL_NONE   0x0028u

◆ HODCAP_SET_MUX_CTRL_SEL_SEN0

#define HODCAP_SET_MUX_CTRL_SEL_SEN0   0x0000u

◆ HODCAP_SET_MUX_CTRL_SEL_SEN1

#define HODCAP_SET_MUX_CTRL_SEL_SEN1   0x0004u

◆ HODCAP_SET_MUX_CTRL_SEL_SEN2

#define HODCAP_SET_MUX_CTRL_SEL_SEN2   0x0008u

◆ HODCAP_SET_MUX_CTRL_SEL_SEN3

#define HODCAP_SET_MUX_CTRL_SEL_SEN3   0x000Cu

◆ HODCAP_SET_MUX_CTRL_SEL_SEN4

#define HODCAP_SET_MUX_CTRL_SEL_SEN4   0x0010u

◆ HODCAP_SET_MUX_CTRL_SEL_SEN5

#define HODCAP_SET_MUX_CTRL_SEL_SEN5   0x0014u

◆ HODCAP_SET_MUX_CTRL_SEL_SEN6

#define HODCAP_SET_MUX_CTRL_SEL_SEN6   0x0018u

◆ HODCAP_SET_MUX_CTRL_SEL_SEN7

#define HODCAP_SET_MUX_CTRL_SEL_SEN7   0x001Cu

◆ HODCAP_SET_MUX_CTRL_SEL_SEN8

#define HODCAP_SET_MUX_CTRL_SEL_SEN8   0x0020u

◆ HODCAP_SET_MUX_CTRL_SEL_SEN9

#define HODCAP_SET_MUX_CTRL_SEL_SEN9   0x0024u

◆ HODCAP_SET_MUX_CTRL_SEL_VAR_SEN

#define HODCAP_SET_MUX_CTRL_SEL_VAR_SEN   0x002Cu

◆ HODCAP_SET_PGA_GAIN_10_67

#define HODCAP_SET_PGA_GAIN_10_67   0x0003u

◆ HODCAP_SET_PGA_GAIN_16

#define HODCAP_SET_PGA_GAIN_16   0x0002u

◆ HODCAP_SET_PGA_GAIN_24

#define HODCAP_SET_PGA_GAIN_24   0x0001u

◆ HODCAP_SET_PGA_GAIN_2_11

#define HODCAP_SET_PGA_GAIN_2_11   0x0007u

◆ HODCAP_SET_PGA_GAIN_36

#define HODCAP_SET_PGA_GAIN_36   0x0000u

HOD CAP PGA voltage gain control values.

PGA voltage gain control values of HOD CAP Click driver.

◆ HODCAP_SET_PGA_GAIN_3_16

#define HODCAP_SET_PGA_GAIN_3_16   0x0006u

◆ HODCAP_SET_PGA_GAIN_4_74

#define HODCAP_SET_PGA_GAIN_4_74   0x0005u

◆ HODCAP_SET_PGA_GAIN_7_11

#define HODCAP_SET_PGA_GAIN_7_11   0x0004u

◆ HODCAP_SET_TXV_0_5V

#define HODCAP_SET_TXV_0_5V   0x0001u

◆ HODCAP_SET_TXV_0V

#define HODCAP_SET_TXV_0V   0x0000u

HOD CAP transmitter output AC voltage values.

Transmitter output AC voltage values of HOD CAP Click driver.

◆ HODCAP_SET_TXV_1V

#define HODCAP_SET_TXV_1V   0x0002u

◆ HODCAP_TOTAL_NUMBER_OF_CHANNELS

#define HODCAP_TOTAL_NUMBER_OF_CHANNELS   10

HOD CAP total number of channels value.

Total number of channels value of HOD CAP Click driver.