c3dhall7  2.0.0.0
Functions
Public function

Functions

void c3dhall7_cfg_setup (c3dhall7_cfg_t *cfg)
 Config Object Initialization function. More...
 
C3DHALL7_RETVAL c3dhall7_init (c3dhall7_t *ctx, c3dhall7_cfg_t *cfg)
 Initialization function. More...
 
void c3dhall7_default_cfg (c3dhall7_t *ctx)
 Click Default Configuration function. More...
 
void c3dhall7_generic_write (c3dhall7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void c3dhall7_generic_read (c3dhall7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
void c3dhall7_device_reset (c3dhall7_t *ctx)
 Hardware device reset. More...
 
void c3dhall7_get_axis_data (c3dhall7_t *ctx, c3dhall7_axis_t *axis)
 Get Axis data function. More...
 
void c3dhall7_software_reset (c3dhall7_t *ctx)
 Software device reset. More...
 
void c3dhall7_configuration (c3dhall7_t *ctx, uint8_t reg, uint16_t data_in)
 Configuration function (for ctrl register). More...
 
void c3dhall7_device_info (c3dhall7_t *ctx, c3dhall7_dev_info_t *info)
 Device info function. More...
 
void c3dhall7_get_status (c3dhall7_t *ctx, c3dhall7_status_t *status)
 Measurement status function. More...
 
void c3dhall7_get_interrupt_state (c3dhall7_t *ctx, c3dhall7_int_state_t *state)
 Interrupt state function. More...
 

Detailed Description

Function Documentation

◆ c3dhall7_cfg_setup()

void c3dhall7_cfg_setup ( c3dhall7_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ c3dhall7_configuration()

void c3dhall7_configuration ( c3dhall7_t ctx,
uint8_t  reg,
uint16_t  data_in 
)

Configuration function (for ctrl register).

Parameters
ctxClick object.
regAddress where data be written.
data_inConfig data

@description This function reads data from the desired register.

◆ c3dhall7_default_cfg()

void c3dhall7_default_cfg ( c3dhall7_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for 3D Hall 7 click.

◆ c3dhall7_device_info()

void c3dhall7_device_info ( c3dhall7_t ctx,
c3dhall7_dev_info_t info 
)

Device info function.

Parameters
ctxClick object.
T_C3DHALL7_DEV_INFOTructure of device information

@description This function reads data from the desired register.

◆ c3dhall7_device_reset()

void c3dhall7_device_reset ( c3dhall7_t ctx)

Hardware device reset.

Parameters
ctxClick object.

@description This function reads data from the desired register.

◆ c3dhall7_generic_read()

void c3dhall7_generic_read ( c3dhall7_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

@description This function reads data from the desired register.

◆ c3dhall7_generic_write()

void c3dhall7_generic_write ( c3dhall7_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function writes data to the desired register.

◆ c3dhall7_get_axis_data()

void c3dhall7_get_axis_data ( c3dhall7_t ctx,
c3dhall7_axis_t axis 
)

Get Axis data function.

Parameters
ctxClick object.
T_C3DHALL7_AXISaxis structure of axis data

@description This function reads data from the desired register.

◆ c3dhall7_get_interrupt_state()

void c3dhall7_get_interrupt_state ( c3dhall7_t ctx,
c3dhall7_int_state_t state 
)

Interrupt state function.

Parameters
ctxClick object.
T_C3DHALL7_INT_STATEstructure of Interrupt pin state

@description This function reads data from the desired register.

◆ c3dhall7_get_status()

void c3dhall7_get_status ( c3dhall7_t ctx,
c3dhall7_status_t status 
)

Measurement status function.

Parameters
ctxClick object.
T_C3DHALL7_STATUSStructure of measurement status

@description This function reads data from the desired register.

◆ c3dhall7_init()

C3DHALL7_RETVAL c3dhall7_init ( c3dhall7_t ctx,
c3dhall7_cfg_t cfg 
)

Initialization function.

Parameters
c3dhall7Click object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ c3dhall7_software_reset()

void c3dhall7_software_reset ( c3dhall7_t ctx)

Software device reset.

Parameters
ctxClick object.

@description This function reads data from the desired register.