hallcurrent17 2.1.0.0
Topics | Functions
Hall Current 17 Click Driver

API for configuring and manipulating Hall Current 17 Click driver. More...

Topics

 Hall Current 17 Registers List
 List of registers of Hall Current 17 Click driver.
 
 Hall Current 17 Registers Settings
 Settings for registers of Hall Current 17 Click driver.
 
 Hall Current 17 MikroBUS Map
 MikroBUS pin mapping of Hall Current 17 Click driver.
 

Functions

void hallcurrent17_cfg_setup (hallcurrent17_cfg_t *cfg)
 Hall Current 17 configuration object setup function.
 
err_t hallcurrent17_init (hallcurrent17_t *ctx, hallcurrent17_cfg_t *cfg)
 Hall Current 17 initialization function.
 
err_t hallcurrent17_default_cfg (hallcurrent17_t *ctx)
 Hall Current 17 default configuration function.
 
void hallcurrent17_set_adc_vref (hallcurrent17_t *ctx, float vref)
 Hall Current 17 set voltage reference function.
 
err_t hallcurrent17_get_voltage (hallcurrent17_t *ctx, float *voltage)
 Hall Current 17 get voltage function.
 
err_t hallcurrent17_get_vref (hallcurrent17_t *ctx, float *adc_vref)
 Hall Current 17 get Vref function.
 
err_t hallcurrent17_get_vout (hallcurrent17_t *ctx, float *adc_vout)
 Hall Current 17 get Vout function.
 
err_t hallcurrent17_get_current (hallcurrent17_t *ctx, float *current)
 Hall Current 17 get current function.
 

Detailed Description

API for configuring and manipulating Hall Current 17 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ hallcurrent17_cfg_setup()

void hallcurrent17_cfg_setup ( hallcurrent17_cfg_t * cfg)

Hall Current 17 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See hallcurrent17_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ hallcurrent17_default_cfg()

err_t hallcurrent17_default_cfg ( hallcurrent17_t * ctx)

Hall Current 17 default configuration function.

This function executes a default configuration of Hall Current 17 click board.

Parameters
[in]ctx: Click context object. See hallcurrent17_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ hallcurrent17_get_current()

err_t hallcurrent17_get_current ( hallcurrent17_t * ctx,
float * current )

Hall Current 17 get current function.

This function reads and calculate input current value of the ACS37010LLZA-050B5, High Accuracy Current Sensor on the Hall Current 17 Click board™.

Parameters
[in]ctx: Click context object. See hallcurrent17_t object definition for detailed explanation.
[out]current: Current [A].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ hallcurrent17_get_voltage()

err_t hallcurrent17_get_voltage ( hallcurrent17_t * ctx,
float * voltage )

Hall Current 17 get voltage function.

This function reads raw ADC value and converts it to proportional voltage level of the ADC122S101, 2 Channel, 500 ksps to 1 Msps 12-Bit A/D Converter on the Hall Current 17 Click board™.

Parameters
[in]ctx: Click context object. See hallcurrent17_t object definition for detailed explanation.
[out]voltage: Output voltage [V].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ hallcurrent17_get_vout()

err_t hallcurrent17_get_vout ( hallcurrent17_t * ctx,
float * adc_vout )

Hall Current 17 get Vout function.

This function reads raw ADC value of the inputs IN1 and converts it to proportional output voltage level of the ACS37010LLZA-050B5, High Accuracy Current Sensor on the Hall Current 17 Click board™.

Parameters
[in]ctx: Click context object. See hallcurrent17_t object definition for detailed explanation.
[out]adc_vout: Output voltage level [V].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ hallcurrent17_get_vref()

err_t hallcurrent17_get_vref ( hallcurrent17_t * ctx,
float * adc_vref )

Hall Current 17 get Vref function.

This function reads raw ADC value of the inputs IN2 and converts it to proportional voltage reference level of the ACS37010LLZA-050B5, High Accuracy Current Sensor on the Hall Current 17 Click board™.

Parameters
[in]ctx: Click context object. See hallcurrent17_t object definition for detailed explanation.
[out]adc_vref: Voltage reference level [V].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ hallcurrent17_init()

err_t hallcurrent17_init ( hallcurrent17_t * ctx,
hallcurrent17_cfg_t * cfg )

Hall Current 17 initialization function.

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

Parameters
[out]ctx: Click context object. See hallcurrent17_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See hallcurrent17_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ hallcurrent17_set_adc_vref()

void hallcurrent17_set_adc_vref ( hallcurrent17_t * ctx,
float vref )

Hall Current 17 set voltage reference function.

This function sets the voltage reference of the ADC122S101, 2 Channel, 500 ksps to 1 Msps 12-Bit A/D Converter on the Hall Current 17 Click board™.

Parameters
[in]ctx: Click context object. See hallcurrent17_t object definition for detailed explanation.
[in]vref: Voltage reference.
Returns
Nothing.
Note
None.