Hall Current 14 Click Driver

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

Topics
	Hall Current 14 Registers Settings
	Settings for registers of Hall Current 14 Click driver.
	Hall Current 14 MikroBUS Map
	MikroBUS pin mapping of Hall Current 14 Click driver.

Functions
void	hallcurrent14_cfg_setup (hallcurrent14_cfg_t *cfg)
	Hall Current 14 configuration object setup function.
void	hallcurrent14_drv_interface_selection (hallcurrent14_cfg_t *cfg, hallcurrent14_drv_t drv_sel)
	Hall Current 14 driver interface setup function.
err_t	hallcurrent14_init (hallcurrent14_t *ctx, hallcurrent14_cfg_t *cfg)
	Hall Current 14 initialization function.
err_t	hallcurrent14_read_raw_adc (hallcurrent14_t *ctx, uint16_t *raw_adc)
	Hall Current 14 read raw ADC value function.
err_t	hallcurrent14_read_voltage (hallcurrent14_t *ctx, float *voltage)
	Hall Current 14 read voltage level function.
err_t	hallcurrent14_set_vref (hallcurrent14_t *ctx, float vref)
	Hall Current 14 set vref function.
err_t	hallcurrent14_read_current (hallcurrent14_t *ctx, float *current)
	Hall Current 14 read current function.

Detailed Description

API for configuring and manipulating Hall Current 14 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

hallcurrent14_cfg_setup()

void hallcurrent14_cfg_setup

(

hallcurrent14_cfg_t *

cfg

)

Hall Current 14 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See hallcurrent14_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

hallcurrent14_drv_interface_selection()

void hallcurrent14_drv_interface_selection	(	hallcurrent14_cfg_t *	cfg,
		hallcurrent14_drv_t	drv_sel )

Hall Current 14 driver interface setup function.

This function sets a serial driver interface which will be used further in the click driver.

Parameters

[out]	cfg	: Click configuration structure. See hallcurrent14_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See hallcurrent14_drv_t object definition for detailed explanation.

Returns

Nothing.

Note

This driver selection should be call before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

hallcurrent14_init()

err_t hallcurrent14_init	(	hallcurrent14_t *	ctx,
		hallcurrent14_cfg_t *	cfg )

Hall Current 14 initialization function.

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

Parameters

[out]	ctx	: Click context object. See hallcurrent14_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See hallcurrent14_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

hallcurrent14_read_current()

err_t hallcurrent14_read_current	(	hallcurrent14_t *	ctx,
		float *	current )

Hall Current 14 read current function.

This function reads the input current level [A] based on HALLCURRENT14_NUM_CONVERSIONS of voltage measurements.

Parameters

[in]	ctx	: Click context object. See hallcurrent14_t object definition for detailed explanation.
[out]	current	: Input current level [A].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

For better accuracy, set the voltage reference by using the hallcurrent14_set_vref function, and increase the number of conversions by modifying the HALLCURRENT14_NUM_CONVERSIONS macro.

hallcurrent14_read_raw_adc()

err_t hallcurrent14_read_raw_adc	(	hallcurrent14_t *	ctx,
		uint16_t *	raw_adc )

Hall Current 14 read raw ADC value function.

This function reads raw ADC value.

Parameters

[in]	ctx	: Click context object. See hallcurrent14_t object definition for detailed explanation.
[out]	raw_adc	: Output ADC result.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

hallcurrent14_read_voltage()

err_t hallcurrent14_read_voltage	(	hallcurrent14_t *	ctx,
		float *	voltage )

Hall Current 14 read voltage level function.

This function reads raw ADC value and converts it to proportional voltage level.

Parameters

[in]	ctx	: Click context object. See hallcurrent14_t object definition for detailed explanation.
[out]	voltage	: Output voltage level [V].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

The conversion to voltage depends on the entered reference voltage.

hallcurrent14_set_vref()

err_t hallcurrent14_set_vref	(	hallcurrent14_t *	ctx,
		float	vref )

Hall Current 14 set vref function.

This function sets the voltage reference for Hall Current 14 click driver.

Parameters

[in]	ctx	: Click context object. See hallcurrent14_t object definition for detailed explanation.
[in]	vref	: Reference voltage (volts).

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

The default voltage reference set with hallcurrent14_init is 5V.