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

Topics
	Hall Current 18 Registers Settings
	Settings for registers of Hall Current 18 Click driver.

	Hall Current 18 MikroBUS Map
	MikroBUS pin mapping of Hall Current 18 Click driver.

Functions
void	hallcurrent18_cfg_setup (hallcurrent18_cfg_t *cfg)
	Hall Current 18 configuration object setup function.

void	hallcurrent18_drv_interface_selection (hallcurrent18_cfg_t *cfg, hallcurrent18_drv_t drv_sel)
	Hall Current 18 driver interface setup function.

err_t	hallcurrent18_init (hallcurrent18_t ctx, hallcurrent18_cfg_t cfg)
	Hall Current 18 initialization function.

err_t	hallcurrent18_default_cfg (hallcurrent18_t *ctx)
	Hall Current 18 default configuration function.

err_t	hallcurrent18_read_raw_adc (hallcurrent18_t ctx, uint16_t raw_adc)
	Hall Current 18 read raw ADC value function.

err_t	hallcurrent18_read_voltage (hallcurrent18_t ctx, float voltage)
	Hall Current 18 read voltage level function.

err_t	hallcurrent18_set_vref (hallcurrent18_t *ctx, float vref)
	Hall Current 18 set vref function.

err_t	hallcurrent18_read_current (hallcurrent18_t ctx, float current)
	Hall Current 18 get current function.

err_t	hallcurrent18_set_zero_ref (hallcurrent18_t *ctx)
	Hall Current 18 set zero reference function.

Detailed Description

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

◆ hallcurrent18_cfg_setup()

void hallcurrent18_cfg_setup ( hallcurrent18_cfg_t * cfg )

Hall Current 18 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See hallcurrent18_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ hallcurrent18_default_cfg()

err_t hallcurrent18_default_cfg ( hallcurrent18_t * ctx )

Hall Current 18 default configuration function.

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

Parameters

[in] ctx : Click context object. See hallcurrent18_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.

◆ hallcurrent18_drv_interface_selection()

void hallcurrent18_drv_interface_selection	(	hallcurrent18_cfg_t *	cfg,
		hallcurrent18_drv_t	drv_sel )

Hall Current 18 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 hallcurrent18_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See hallcurrent18_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.

◆ hallcurrent18_init()

err_t hallcurrent18_init	(	hallcurrent18_t *	ctx,
		hallcurrent18_cfg_t *	cfg )

Hall Current 18 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ hallcurrent18_read_current()

err_t hallcurrent18_read_current	(	hallcurrent18_t *	ctx,
		float *	current )

Hall Current 18 get current function.

This function reads and calculate input current value of the MCS1806GS-3-40-P, solated Hall-Effect Current Sensor on the Hall Current 18 Click board™.

Parameters

[in]	ctx	: Click context object. See hallcurrent18_t object definition for detailed explanation.
[in]	current	: Current [A].

Returns

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

Note: None.

◆ hallcurrent18_read_raw_adc()

err_t hallcurrent18_read_raw_adc	(	hallcurrent18_t *	ctx,
		uint16_t *	raw_adc )

Hall Current 18 read raw ADC value function.

This function reads raw ADC value.

Parameters

[in]	ctx	: Click context object. See hallcurrent18_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.

◆ hallcurrent18_read_voltage()

err_t hallcurrent18_read_voltage	(	hallcurrent18_t *	ctx,
		float *	voltage )

Hall Current 18 read voltage level function.

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

Parameters

[in]	ctx	: Click context object. See hallcurrent18_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.

◆ hallcurrent18_set_vref()

err_t hallcurrent18_set_vref	(	hallcurrent18_t *	ctx,
		float	vref )

Hall Current 18 set vref function.

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

Parameters

[in]	ctx	: Click context object. See hallcurrent18_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 hallcurrent18_init is 3.3V.

◆ hallcurrent18_set_zero_ref()

err_t hallcurrent18_set_zero_ref ( hallcurrent18_t * ctx )

Hall Current 18 set zero reference function.

This function sets the zero voltage reference of the MCS1806GS-3-40-P, solated Hall-Effect Current Sensor on the Hall Current 18 Click board™.

Parameters

[in] ctx : Click context object. See hallcurrent18_t object definition for detailed explanation.

Returns

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

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ hallcurrent18_cfg_setup()

◆ hallcurrent18_default_cfg()

◆ hallcurrent18_drv_interface_selection()

◆ hallcurrent18_init()

◆ hallcurrent18_read_current()

◆ hallcurrent18_read_raw_adc()

◆ hallcurrent18_read_voltage()

◆ hallcurrent18_set_vref()

◆ hallcurrent18_set_zero_ref()