c3dhall11 2.0.0.0
Data Structures | Macros | Enumerations | Functions
c3dhall11.h File Reference

This file contains API for 3D Hall 11 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  c3dhall11_data_t
 3D Hall 11 Click data object. More...
 
struct  c3dhall11_t
 3D Hall 11 Click context object. More...
 
struct  c3dhall11_cfg_t
 3D Hall 11 Click configuration object. More...
 

Macros

#define C3DHALL11_REG_DEVICE_CONFIG_1   0x00
 3D Hall 11 register list.
 
#define C3DHALL11_REG_DEVICE_CONFIG_2   0x01
 
#define C3DHALL11_REG_SENSOR_CONFIG_1   0x02
 
#define C3DHALL11_REG_SENSOR_CONFIG_2   0x03
 
#define C3DHALL11_REG_X_THR_CONFIG   0x04
 
#define C3DHALL11_REG_Y_THR_CONFIG   0x05
 
#define C3DHALL11_REG_Z_THR_CONFIG   0x06
 
#define C3DHALL11_REG_T_CONFIG   0x07
 
#define C3DHALL11_REG_INT_CONFIG_1   0x08
 
#define C3DHALL11_REG_MAG_GAIN_CONFIG   0x09
 
#define C3DHALL11_REG_MAG_OFFSET_CONFIG_1   0x0A
 
#define C3DHALL11_REG_MAG_OFFSET_CONFIG_2   0x0B
 
#define C3DHALL11_REG_I2C_ADDRESS   0x0C
 
#define C3DHALL11_REG_DEVICE_ID   0x0D
 
#define C3DHALL11_REG_MANUFACTURER_ID_LSB   0x0E
 
#define C3DHALL11_REG_MANUFACTURER_ID_MSB   0x0F
 
#define C3DHALL11_REG_T_MSB_RESULT   0x10
 
#define C3DHALL11_REG_T_LSB_RESULT   0x11
 
#define C3DHALL11_REG_X_MSB_RESULT   0x12
 
#define C3DHALL11_REG_X_LSB_RESULT   0x13
 
#define C3DHALL11_REG_Y_MSB_RESULT   0x14
 
#define C3DHALL11_REG_Y_LSB_RESULT   0x15
 
#define C3DHALL11_REG_Z_MSB_RESULT   0x16
 
#define C3DHALL11_REG_Z_LSB_RESULT   0x17
 
#define C3DHALL11_REG_CONV_STATUS   0x18
 
#define C3DHALL11_REG_ANGLE_RESULT_MSB   0x19
 
#define C3DHALL11_REG_ANGLE_RESULT_LSB   0x1A
 
#define C3DHALL11_REG_MAGNITUDE_RESULT   0x1B
 
#define C3DHALL11_REG_DEVICE_STATUS   0x1C
 
#define C3DHALL11_CRC_DISABLE   0x00
 3D Hall 11 DEVICE_CONFIG_1 register settings.
 
#define C3DHALL11_CRC_ENABLE   0x80
 
#define C3DHALL11_CRC_EN_BIT_MASK   0x80
 
#define C3DHALL11_MAG_TEMPCO_0   0x00
 
#define C3DHALL11_MAG_TEMPCO_0p12   0x20
 
#define C3DHALL11_MAG_TEMPCO_0p2   0x60
 
#define C3DHALL11_MAG_TEMPCO_BIT_MASK   0x60
 
#define C3DHALL11_CONV_AVG_1X   0x00
 
#define C3DHALL11_CONV_AVG_2X   0x04
 
#define C3DHALL11_CONV_AVG_4X   0x08
 
#define C3DHALL11_CONV_AVG_8X   0x0C
 
#define C3DHALL11_CONV_AVG_16X   0x10
 
#define C3DHALL11_CONV_AVG_32X   0x14
 
#define C3DHALL11_CONV_AVG_BIT_MASK   0x1C
 
#define C3DHALL11_I2C_RD_STANDARD   0x00
 
#define C3DHALL11_I2C_RD_1_BYTE_16BIT   0x01
 
#define C3DHALL11_I2C_RD_1_BYTE_8BIT   0x02
 
#define C3DHALL11_I2C_RD_BIT_MASK   0x03
 
#define C3DHALL11_THR_HYST_2S_COMPLEMENT   0x00
 3D Hall 11 DEVICE_CONFIG_2 register settings.
 
#define C3DHALL11_THR_HYST_7LSB   0x20
 
#define C3DHALL11_THR_HYST_BIT_MASK   0xE0
 
#define C3DHALL11_LP_LN_ACTUVE_CURRENT_MODE   0x00
 
#define C3DHALL11_LP_LN_NOISE_MODE   0x10
 
#define C3DHALL11_LP_LN_BIT_MASK   0x10
 
#define C3DHALL11_I2C_GLITCH_FILTER_ON   0x00
 
#define C3DHALL11_I2C_GLITCH_FILTER_OFF   0x08
 
#define C3DHALL11_I2C_GLITCH_FILTER_BIT_MASK   0x08
 
#define C3DHALL11_TRIGGER_MODE_CMD   0x00
 
#define C3DHALL11_TRIGGER_MODE_INT   0x04
 
#define C3DHALL11_TRIGGER_MODE_BIT_MASK   0x04
 
#define C3DHALL11_OPERATING_MODE_STANDBY   0x00
 
#define C3DHALL11_OPERATING_MODE_SLEEP   0x01
 
#define C3DHALL11_OPERATING_MODE_CONTINUOUS   0x02
 
#define C3DHALL11_OPERATING_MODE_WS   0x03
 
#define C3DHALL11_OPERATING_MODE_BIT_MASK   0x03
 
#define C3DHALL11_MAG_CH_EN_DISABLE   0x00
 3D Hall 11 SENSOR_CONFIG_1 register settings.
 
#define C3DHALL11_MAG_CH_EN_ENABLE_X   0x10
 
#define C3DHALL11_MAG_CH_EN_ENABLE_Y   0x20
 
#define C3DHALL11_MAG_CH_EN_ENABLE_XY   0x30
 
#define C3DHALL11_MAG_CH_EN_ENABLE_Z   0x40
 
#define C3DHALL11_MAG_CH_EN_ENABLE_ZX   0x50
 
#define C3DHALL11_MAG_CH_EN_ENABLE_YZ   0x60
 
#define C3DHALL11_MAG_CH_EN_ENABLE_XYZ   0x70
 
#define C3DHALL11_MAG_CH_EN_ENABLE_XYX   0x80
 
#define C3DHALL11_MAG_CH_EN_ENABLE_YXY   0x90
 
#define C3DHALL11_MAG_CH_EN_ENABLE_YZY   0xA0
 
#define C3DHALL11_MAG_CH_EN_ENABLE_XZX   0xB0
 
#define C3DHALL11_MAG_CH_EN_BIT_MASK   0xF0
 
#define C3DHALL11_SLEEPTIME_1MS   0x00
 
#define C3DHALL11_SLEEPTIME_5MS   0x01
 
#define C3DHALL11_SLEEPTIME_10MS   0x02
 
#define C3DHALL11_SLEEPTIME_15MS   0x03
 
#define C3DHALL11_SLEEPTIME_20MS   0x04
 
#define C3DHALL11_SLEEPTIME_30MS   0x05
 
#define C3DHALL11_SLEEPTIME_50MS   0x06
 
#define C3DHALL11_SLEEPTIME_100MS   0x07
 
#define C3DHALL11_SLEEPTIME_500MS   0x08
 
#define C3DHALL11_SLEEPTIME_1000MS   0x09
 
#define C3DHALL11_SLEEPTIME_2000MS   0x0A
 
#define C3DHALL11_SLEEPTIME_5000MS   0x0B
 
#define C3DHALL11_SLEEPTIME_20000MS   0x0C
 
#define C3DHALL11_SLEEPTIME_BIT_MASK   0x0F
 
#define C3DHALL11_THRX_COUNT_1   0x00
 3D Hall 11 SENSOR_CONFIG_2 register settings.
 
#define C3DHALL11_THRX_COUNT_4   0x40
 
#define C3DHALL11_THRX_COUNT_BIT_MASK   0x40
 
#define C3DHALL11_MAG_THR_DIR_ABOVE   0x00
 
#define C3DHALL11_MAG_THR_DIR_BELOW   0x20
 
#define C3DHALL11_MAG_THR_DIR_BIT_MASK   0x20
 
#define C3DHALL11_MAG_GAIN_CH_1   0x00
 
#define C3DHALL11_MAG_GAIN_CH_2   0x10
 
#define C3DHALL11_MAG_GAIN_CH_BIT_MASK   0x10
 
#define C3DHALL11_ANGLE_EN_NO_ANGLE   0x00
 
#define C3DHALL11_ANGLE_EN_XY_ANGLE   0x04
 
#define C3DHALL11_ANGLE_EN_YZ_ANGLE   0x08
 
#define C3DHALL11_ANGLE_EN_XZ_ANGLE   0x0C
 
#define C3DHALL11_ANGLE_EN_BIT_MASK   0x0C
 
#define C3DHALL11_X_Y_RANGE_40mT   0x00
 
#define C3DHALL11_X_Y_RANGE_80mT   0x02
 
#define C3DHALL11_X_Y_RANGE_BIT_MASK   0x02
 
#define C3DHALL11_Z_RANGE_40mT   0x00
 
#define C3DHALL11_Z_RANGE_80mT   0x01
 
#define C3DHALL11_Z_RANGE_BIT_MASK   0x01
 
#define C3DHALL11_T_THR_CONFIG_BIT_MASK   0xFE
 3D Hall 11 T_CONFIG register settings.
 
#define C3DHALL11_T_CH_EN_DISABLE   0x00
 
#define C3DHALL11_T_CH_EN_ENABLE   0x01
 
#define C3DHALL11_T_CH_EN_BIT_MASK   0x01
 
#define C3DHALL11_RSLT_INT_NO_ASSERT   0x00
 3D Hall 11 INT_CONFIG_1 register settings.
 
#define C3DHALL11_RSLT_INT_ASSERT   0x80
 
#define C3DHALL11_RSLT_INT_BIT_MASK   0x80
 
#define C3DHALL11_THRSLD_INT_NO_ASSERT   0x00
 
#define C3DHALL11_THRSLD_INT_ASSERT   0x40
 
#define C3DHALL11_THRSLD_INT_BIT_MASK   0x40
 
#define C3DHALL11_INT_STATE_LATCHED   0x00
 
#define C3DHALL11_INT_STATE_PULSE_10US   0x20
 
#define C3DHALL11_INT_STATE_BIT_MASK   0x20
 
#define C3DHALL11_INT_MODE_NO_INT   0x00
 
#define C3DHALL11_INT_MODE_INT   0x04
 
#define C3DHALL11_INT_MODE_INT_WO_I2C_BUSY   0x08
 
#define C3DHALL11_INT_MODE_SCL   0x0C
 
#define C3DHALL11_INT_MODE_SCL_WO_I2C_BUSY   0x10
 
#define C3DHALL11_INT_MODE_BIT_MASK   0x1C
 
#define C3DHALL11_MASK_INTB_ENABLE   0x00
 
#define C3DHALL11_MASK_INTB_DISABLE   0x01
 
#define C3DHALL11_MASK_INTB_BIT_MASK   0x01
 
#define C3DHALL11_DEVICE_ID   0x01
 3D Hall 11 DEVICE_ID and MANUFACTURER_ID values.
 
#define C3DHALL11_MANUFACTURER_ID_LSB   0x49
 
#define C3DHALL11_MANUFACTURER_ID_MSB   0x54
 
#define C3DHALL11_CONV_STATUS_SET_COUNT   0xE0
 3D Hall 11 CONV_STATUS register settings.
 
#define C3DHALL11_CONV_STATUS_DIAG_STATUS   0x02
 
#define C3DHALL11_CONV_STATUS_DATA_READY   0x01
 
#define C3DHALL11_DEVICE_STATUS_INTB_RB   0x10
 3D Hall 11 DEVICE_STATUS register settings.
 
#define C3DHALL11_DEVICE_STATUS_OSC_ER   0x08
 
#define C3DHALL11_DEVICE_STATUS_INT_ER   0x04
 
#define C3DHALL11_DEVICE_STATUS_OTP_CRC_ER   0x02
 
#define C3DHALL11_DEVICE_STATUS_VCC_UV_ER   0x01
 
#define C3DHALL11_TEMP_SENS_T0   25.0
 3D Hall 11 calculation values.
 
#define C3DHALL11_TEMP_ADC_T0   17508
 
#define C3DHALL11_TEMP_ADC_RESOLUTION   60.1
 
#define C3DHALL11_ANGLE_RESOLUTION   16.0
 
#define C3DHALL11_XYZ_SENSITIVITY_40mT   820.0
 
#define C3DHALL11_XYZ_SENSITIVITY_80mT   410.0
 
#define C3DHALL11_DEVICE_ADDRESS   0x35
 3D Hall 11 device address setting.
 
#define C3DHALL11_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  c3dhall11_return_value_t { C3DHALL11_OK = 0 , C3DHALL11_ERROR = -1 }
 3D Hall 11 Click return value data. More...
 

Functions

void c3dhall11_cfg_setup (c3dhall11_cfg_t *cfg)
 3D Hall 11 configuration object setup function.
 
err_t c3dhall11_init (c3dhall11_t *ctx, c3dhall11_cfg_t *cfg)
 3D Hall 11 initialization function.
 
err_t c3dhall11_default_cfg (c3dhall11_t *ctx)
 3D Hall 11 default configuration function.
 
err_t c3dhall11_generic_write (c3dhall11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 3D Hall 11 I2C writing function.
 
err_t c3dhall11_generic_read (c3dhall11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 3D Hall 11 I2C reading function.
 
err_t c3dhall11_write_register (c3dhall11_t *ctx, uint8_t reg, uint8_t data_in)
 3D Hall 11 write register function.
 
err_t c3dhall11_read_register (c3dhall11_t *ctx, uint8_t reg, uint8_t *data_out)
 3D Hall 11 read register function.
 
uint8_t c3dhall11_get_int_pin (c3dhall11_t *ctx)
 3D Hall 11 get int pin function.
 
err_t c3dhall11_check_communication (c3dhall11_t *ctx)
 3D Hall 11 check communication function.
 
err_t c3dhall11_read_data (c3dhall11_t *ctx, c3dhall11_data_t *data_out)
 3D Hall 11 read data function.
 

Detailed Description

This file contains API for 3D Hall 11 Click Driver.

Enumeration Type Documentation

◆ c3dhall11_return_value_t

enum c3dhall11_return_value_t

3D Hall 11 Click return value data.

Predefined enum values for driver return values.

Enumerator
C3DHALL11_OK 
C3DHALL11_ERROR