c3dhall4 2.1.0.0
3D Hall 4 Registers Settings

Settings for registers of 3D Hall 4 Click driver. More...

Macros

#define C3DHALL4_CMD_REG_WRITE   0x00
 3D Hall 4 special commands setting.
 
#define C3DHALL4_CMD_REG_READ   0x80
 
#define C3DHALL4_CMD_EREG_WRITE   0x01
 
#define C3DHALL4_CMD_EREG_READ   0x81
 
#define C3DHALL4_CMD_SPECIAL_KEY   0xA5
 
#define C3DHALL4_ADC_VREF_3V3   3.3f
 3D Hall 4 ADC VREF setting.
 
#define C3DHALL4_ADC_VREF_5V   5.0f
 
#define C3DHALL4_RANGE_20   0x00
 3D Hall 4 range/sens/offset setting.
 
#define C3DHALL4_RANGE_40   0x01
 
#define C3DHALL4_RANGE_350   0x02
 
#define C3DHALL4_RANGE_3000   0x03
 
#define C3DHALL4_RANGE_MASK   0x03
 
#define C3DHALL4_SENS_RANGE_3000   6.0f
 
#define C3DHALL4_SENS_RANGE_350   60.0f
 
#define C3DHALL4_SENS_RANGE_40   550.0f
 
#define C3DHALL4_SENS_RANGE_20   1000.0f
 
#define C3DHALL4_SENS_TEMPERATURE   168.0f
 
#define C3DHALL4_OFFSET_XYZ   32768
 
#define C3DHALL4_OFFSET_TEMPERATURE   19913
 
#define C3DHALL4_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection.
 
#define C3DHALL4_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 

Detailed Description

Settings for registers of 3D Hall 4 Click driver.

Macro Definition Documentation

◆ C3DHALL4_ADC_VREF_3V3

#define C3DHALL4_ADC_VREF_3V3   3.3f

3D Hall 4 ADC VREF setting.

Specified setting for ADC VREF of 3D Hall 4 Click driver.

◆ C3DHALL4_ADC_VREF_5V

#define C3DHALL4_ADC_VREF_5V   5.0f

◆ C3DHALL4_CMD_EREG_READ

#define C3DHALL4_CMD_EREG_READ   0x81

◆ C3DHALL4_CMD_EREG_WRITE

#define C3DHALL4_CMD_EREG_WRITE   0x01

◆ C3DHALL4_CMD_REG_READ

#define C3DHALL4_CMD_REG_READ   0x80

◆ C3DHALL4_CMD_REG_WRITE

#define C3DHALL4_CMD_REG_WRITE   0x00

3D Hall 4 special commands setting.

Specified setting for special commands of 3D Hall 4 Click driver.

◆ C3DHALL4_CMD_SPECIAL_KEY

#define C3DHALL4_CMD_SPECIAL_KEY   0xA5

◆ C3DHALL4_OFFSET_TEMPERATURE

#define C3DHALL4_OFFSET_TEMPERATURE   19913

◆ C3DHALL4_OFFSET_XYZ

#define C3DHALL4_OFFSET_XYZ   32768

◆ C3DHALL4_RANGE_20

#define C3DHALL4_RANGE_20   0x00

3D Hall 4 range/sens/offset setting.

Specified setting for range/sens/offset of 3D Hall 4 Click driver.

◆ C3DHALL4_RANGE_3000

#define C3DHALL4_RANGE_3000   0x03

◆ C3DHALL4_RANGE_350

#define C3DHALL4_RANGE_350   0x02

◆ C3DHALL4_RANGE_40

#define C3DHALL4_RANGE_40   0x01

◆ C3DHALL4_RANGE_MASK

#define C3DHALL4_RANGE_MASK   0x03

◆ C3DHALL4_SENS_RANGE_20

#define C3DHALL4_SENS_RANGE_20   1000.0f

◆ C3DHALL4_SENS_RANGE_3000

#define C3DHALL4_SENS_RANGE_3000   6.0f

◆ C3DHALL4_SENS_RANGE_350

#define C3DHALL4_SENS_RANGE_350   60.0f

◆ C3DHALL4_SENS_RANGE_40

#define C3DHALL4_SENS_RANGE_40   550.0f

◆ C3DHALL4_SENS_TEMPERATURE

#define C3DHALL4_SENS_TEMPERATURE   168.0f

◆ C3DHALL4_SET_DATA_SAMPLE_EDGE

#define C3DHALL4_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 c3dhall4_init which will set SET_SPI_DATA_SAMPLE_MIDDLE by default on the mapped mikrobus.

◆ C3DHALL4_SET_DATA_SAMPLE_MIDDLE

#define C3DHALL4_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE