c3dhall14  2.1.0.0
Data Structures | Macros | Enumerations | Functions
c3dhall14.h File Reference

This file contains API for 3D Hall 14 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  c3dhall14_t
 3D Hall 14 Click context object. More...
 
struct  c3dhall14_cfg_t
 3D Hall 14 Click configuration object. More...
 

Macros

#define C3DHALL14_REG_STAT1   0x00
 3D Hall 14 register map. More...
 
#define C3DHALL14_REG_X_LSB   0x01
 
#define C3DHALL14_REG_X_MSB   0x02
 
#define C3DHALL14_REG_Y_LSB   0x03
 
#define C3DHALL14_REG_Y_MSB   0x04
 
#define C3DHALL14_REG_Z_LSB   0x05
 
#define C3DHALL14_REG_Z_MSB   0x06
 
#define C3DHALL14_REG_STAT2   0x07
 
#define C3DHALL14_REG_T_LSB   0x08
 
#define C3DHALL14_REG_T_MSB   0x09
 
#define C3DHALL14_REG_CID   0x0A
 
#define C3DHALL14_REG_DID   0x0B
 
#define C3DHALL14_REG_CTRL1   0x0E
 
#define C3DHALL14_REG_CTRL2   0x0F
 
#define C3DHALL14_REG_RST   0x11
 
#define C3DHALL14_REG_CTRL3   0x14
 
#define C3DHALL14_REG_CTRL4   0x15
 
#define C3DHALL14_REG_X_THR_LSB   0x58
 
#define C3DHALL14_REG_X_THR_MSB   0x59
 
#define C3DHALL14_REG_Y_THR_LSB   0x5A
 
#define C3DHALL14_REG_Y_THR_MSB   0x5B
 
#define C3DHALL14_REG_Z_THR_LSB   0x5C
 
#define C3DHALL14_REG_Z_THR_MSB   0x5D
 
#define C3DHALL14_MODE_POWER_DOWN_0   0x00
 3D Hall 14 operating mode values. More...
 
#define C3DHALL14_MODE_SINGLE_MEAS_0   0x01
 
#define C3DHALL14_MODE_CONT_MEAS_5HZ   0x02
 
#define C3DHALL14_MODE_CONT_MEAS_10HZ   0x03
 
#define C3DHALL14_MODE_CONT_MEAS_20HZ   0x04
 
#define C3DHALL14_MODE_CONT_MEAS_50HZ   0x05
 
#define C3DHALL14_MODE_CONT_MEAS_100HZ   0x06
 
#define C3DHALL14_MODE_SELF_TEST   0x07
 
#define C3DHALL14_MODE_POWER_DOWN_1   0x08
 
#define C3DHALL14_MODE_SINGLE_MEAS_1   0x09
 
#define C3DHALL14_MODE_CONT_MEAS_200HZ   0x0A
 
#define C3DHALL14_MODE_CONT_MEAS_500HZ   0x0B
 
#define C3DHALL14_MODE_CONT_MEAS_700HZ   0x0C
 
#define C3DHALL14_MODE_CONT_MEAS_1000HZ   0x0D
 
#define C3DHALL14_MODE_CONT_MEAS_1400HZ   0x0E
 
#define C3DHALL14_MODE_POWER_DOWN_2   0x0F
 
#define C3DHALL14_MODE_MASK   0x0F
 
#define C3DHALL14_COMPANY_ID   0x94
 3D Hall 14 identification values. More...
 
#define C3DHALL14_DEVICE_ID   0xAA
 
#define C3DHALL14_RESET   0x06
 3D Hall 14 reset value. More...
 
#define C3DHALL14_STAT1_INT   0x10
 3D Hall 14 status values. More...
 
#define C3DHALL14_STAT1_RT   0x08
 
#define C3DHALL14_STAT1_DRDY   0x01
 
#define C3DHALL14_STAT2_DOR   0x08
 
#define C3DHALL14_STAT2_HOVF_Z   0x04
 
#define C3DHALL14_STAT2_HOVF_Y   0x02
 
#define C3DHALL14_STAT2_HOVF_X   0x01
 
#define C3DHALL14_DRDY_INT_ENABLE   0x01
 3D Hall 14 data ready interrupt enable macros. More...
 
#define C3DHALL14_DRDY_INT_DISABLE   0x00
 
#define C3DHALL14_DRDY_INT_EN_MASK   0x08
 
#define C3DHALL14_TEMPERATURE_RES   50.0f
 3D Hall 14 temperature sensor macros. More...
 
#define C3DHALL14_TEMPERATURE_ENABLE   0x01
 
#define C3DHALL14_TEMPERATURE_DISABLE   0x00
 
#define C3DHALL14_TEMPERATURE_EN_MASK   0x20
 
#define C3DHALL14_MAG_FLUX_RES_H   1.5f
 3D Hall 14 magnetic flux resolution. More...
 
#define C3DHALL14_MAG_FLUX_RES_L   0.15f
 
#define C3DHALL14_RANGE_HIGH_LOW_CURRENT   0x00
 
#define C3DHALL14_RANGE_HIGH_LOW_NOISE   0x01
 
#define C3DHALL14_RANGE_LOW_LOW_NOISE   0x02
 
#define C3DHALL14_RANGE_MASK   0xE0
 
#define C3DHALL14_RANGE_SHIFT   5
 
#define C3DHALL14_DEVICE_ADDRESS   0x60
 3D Hall 14 device address setting. More...
 
#define C3DHALL14_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  c3dhall14_return_value_t { C3DHALL14_OK = 0, C3DHALL14_ERROR = -1 }
 3D Hall 14 Click return value data. More...
 

Functions

void c3dhall14_cfg_setup (c3dhall14_cfg_t *cfg)
 3D Hall 14 configuration object setup function. More...
 
err_t c3dhall14_init (c3dhall14_t *ctx, c3dhall14_cfg_t *cfg)
 3D Hall 14 initialization function. More...
 
err_t c3dhall14_default_cfg (c3dhall14_t *ctx)
 3D Hall 14 default configuration function. More...
 
err_t c3dhall14_mem_write_single (c3dhall14_t *ctx, uint8_t reg, uint8_t data_in)
 3D Hall 14 mem write single function. More...
 
err_t c3dhall14_mem_write_multi (c3dhall14_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 3D Hall 14 mem write multi function. More...
 
err_t c3dhall14_mem_direct_read (c3dhall14_t *ctx, uint8_t *data_out, uint8_t len)
 3D Hall 14 mem direct read function. More...
 
err_t c3dhall14_mem_read (c3dhall14_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 3D Hall 14 mem read function. More...
 
err_t c3dhall14_check_communication (c3dhall14_t *ctx)
 3D Hall 14 check communication function. More...
 
uint8_t c3dhall14_get_int_pin (c3dhall14_t *ctx)
 3D Hall 14 get int pin function. More...
 
err_t c3dhall14_check_data_ready (c3dhall14_t *ctx)
 3D Hall 14 check data ready function. More...
 
err_t c3dhall14_get_magnetic_flux (c3dhall14_t *ctx, float *x_axis, float *y_axis, float *z_axis)
 3D Hall 14 get magnetic flux function. More...
 
err_t c3dhall14_get_temperature (c3dhall14_t *ctx, float *temperature)
 3D Hall 14 get temperature function. More...
 
err_t c3dhall14_reset (c3dhall14_t *ctx)
 3D Hall 14 reset function. More...
 
err_t c3dhall14_set_operating_mode (c3dhall14_t *ctx, uint8_t mode)
 3D Hall 14 set operating mode function. More...
 
err_t c3dhall14_set_range (c3dhall14_t *ctx, uint8_t range)
 3D Hall 14 set range function. More...
 
err_t c3dhall14_enable_temp_sensor (c3dhall14_t *ctx, uint8_t enable)
 3D Hall 14 enable temp sensor function. More...
 
err_t c3dhall14_enable_drdy_int (c3dhall14_t *ctx, uint8_t enable)
 3D Hall 14 enable drdy int function. More...
 

Detailed Description

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

Enumeration Type Documentation

◆ c3dhall14_return_value_t

3D Hall 14 Click return value data.

Predefined enum values for driver return values.

Enumerator
C3DHALL14_OK 
C3DHALL14_ERROR