c3dhall6 2.0.0.0
Functions
Public function

Functions

void c3dhall6_cfg_setup (c3dhall6_cfg_t *cfg)
 Config Object Initialization function. More...
 
C3DHALL6_RETVAL c3dhall6_init (c3dhall6_t *ctx, c3dhall6_cfg_t *cfg)
 Initialization function. More...
 
void c3dhall6_default_cfg (c3dhall6_t *ctx)
 Click Default Configuration function. More...
 
void c3dhall6_generic_transfer (c3dhall6_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function. More...
 
void c3dhall6_spi_get (c3dhall6_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t n_bytes)
 Getting raw data function. More...
 
void c3dhall6_set_reference_values (c3dhall6_t *ctx, float reference_voltage, float ref_adc_ch0, float ref_adc_ch1, float ref_adc_ch2, float ref_adc_ch3)
 Setting reference values function. More...
 
void c3dhall6_get_adc_value (c3dhall6_t *ctx, uint8_t channel_no, uint16_t *adc_value)
 Getting ADC value on each channel function. More...
 
void c3dhall6_get_volt (c3dhall6_t *ctx, uint8_t channel_no, float *channel_voltage)
 Getting voltage on each channel function. More...
 
void c3dhall6_get_angle_deg (c3dhall6_t *ctx, uint8_t die, float *angle_value)
 GGetting angle value function. More...
 
void c3dhall6_get_angle_rad (c3dhall6_t *ctx, uint8_t die, float *angle_value)
 GGetting angle value function. More...
 

Detailed Description

Function Documentation

◆ c3dhall6_cfg_setup()

void c3dhall6_cfg_setup ( c3dhall6_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.

◆ c3dhall6_default_cfg()

void c3dhall6_default_cfg ( c3dhall6_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

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

◆ c3dhall6_generic_transfer()

void c3dhall6_generic_transfer ( c3dhall6_t ctx,
uint8_t *  wr_buf,
uint16_t  wr_len,
uint8_t *  rd_buf,
uint16_t  rd_len 
)

Generic transfer function.

Parameters
ctxClick object.
wr_bufWrite data buffer
wr_lenNumber of byte in write data buffer
rd_bufRead data buffer
rd_lenNumber of byte in read data buffer

@description Generic SPI transfer, for sending and receiving packages

◆ c3dhall6_get_adc_value()

void c3dhall6_get_adc_value ( c3dhall6_t ctx,
uint8_t  channel_no,
uint16_t *  adc_value 
)

Getting ADC value on each channel function.

Parameters
ctxClick object.
channel_noChannel number (channels: CH0, CH1, CH2, CH3).
adc_valueADC value on selected channel.

@description This function reads ADC value on selected channel.

◆ c3dhall6_get_angle_deg()

void c3dhall6_get_angle_deg ( c3dhall6_t ctx,
uint8_t  die,
float *  angle_value 
)

GGetting angle value function.

Parameters
ctxClick object.
dieDevice uses two dies for measurement (dies: die A, die B).
angle_valueCalculated angle value (range: from -180 to 180 degrees).

@description This function reads ADC values for selected die and calculates angle value in degrees.

◆ c3dhall6_get_angle_rad()

void c3dhall6_get_angle_rad ( c3dhall6_t ctx,
uint8_t  die,
float *  angle_value 
)

GGetting angle value function.

Parameters
ctxClick object.
dieDevice uses two dies for measurement (dies: die A, die B).
angle_valueCalculated angle value (range: from -1 to 1 pi radians).

@description This function reads ADC values for selected die and calculates angle value in radians.

◆ c3dhall6_get_volt()

void c3dhall6_get_volt ( c3dhall6_t ctx,
uint8_t  channel_no,
float *  channel_voltage 
)

Getting voltage on each channel function.

Parameters
ctxClick object.
channel_noChannel number (channels: CH0, CH1, CH2, CH3).
channel_voltagevoltage value on selected channel.

@description This function reads ADC value on selected channel and converts that value to Volts or miliVolts - depending on reference voltage setting.

◆ c3dhall6_init()

C3DHALL6_RETVAL c3dhall6_init ( c3dhall6_t ctx,
c3dhall6_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ c3dhall6_set_reference_values()

void c3dhall6_set_reference_values ( c3dhall6_t ctx,
float  reference_voltage,
float  ref_adc_ch0,
float  ref_adc_ch1,
float  ref_adc_ch2,
float  ref_adc_ch3 
)

Setting reference values function.

Parameters
ctxClick object.
reference_voltageReference voltage in Volts or miliVolts ( measure this voltage between GND and 3V3 pin ).
ref_adc_ch0Reference adc value from channel 0 - perform adc measurement on channel 0 with no permanent magnet.
ref_adc_ch1Reference adc value from channel 1 - perform adc measurement on channel 1 with no permanent magnet.
ref_adc_ch2Reference adc value from channel 2 - perform adc measurement on channel 2 with no permanent magnet.
ref_adc_ch3Reference adc value from channel 3 - perform adc measurement on channel 3 with no permanent magnet.

@description This function sets reference values for voltage and angle calculations.

◆ c3dhall6_spi_get()

void c3dhall6_spi_get ( c3dhall6_t ctx,
uint8_t *  data_in,
uint8_t *  data_out,
uint8_t  n_bytes 
)

Getting raw data function.

Parameters
ctxClick object.
data_inInput data buffer.
data_outOutput data buffer.
n_bytesNumber of bytes to transfer.

@description This function gets raw data from device.