Current 4 Click Driver

API for configuring and manipulating Current 4 Click driver. More...

Topics
	Current 4 Registers List
	List of registers of Current 4 Click driver.
	Current 4 Registers Settings
	Settings for registers of Current 4 Click driver.
	Current 4 MikroBUS Map
	MikroBUS pin mapping of Current 4 Click driver.

Functions
void	current4_cfg_setup (current4_cfg_t *cfg)
	Current 4 configuration object setup function.
err_t	current4_init (current4_t *ctx, current4_cfg_t *cfg)
	Current 4 initialization function.
err_t	current4_read_an_pin_value (current4_t *ctx, uint16_t *data_out)
	Read AN pin value function.
err_t	current4_read_an_pin_voltage (current4_t *ctx, float *data_out)
	Read AN pin voltage level function.
err_t	current4_read_load_current (current4_t *ctx, float *load_current)
	Read load current.

Detailed Description

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

current4_cfg_setup()

void current4_cfg_setup

(

current4_cfg_t *

cfg

)

Current 4 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

current4_init()

err_t current4_init	(	current4_t *	ctx,
		current4_cfg_t *	cfg )

Current 4 initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

current4_read_an_pin_value()

err_t current4_read_an_pin_value	(	current4_t *	ctx,
		uint16_t *	data_out )

Read AN pin value function.

This function reads results of AD conversion of the AN pin.

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

current4_read_an_pin_voltage()

err_t current4_read_an_pin_voltage	(	current4_t *	ctx,
		float *	data_out )

Read AN pin voltage level function.

This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.

Parameters

[in]	ctx	: Click context object. See current4_t object definition for detailed explanation.
[out]	data_out	: Output voltage level of the analog pin [V].

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

The conversion to voltage depends on the entered configuration of the ADC (resolution, reference voltage).

current4_read_load_current()

err_t current4_read_load_current	(	current4_t *	ctx,
		float *	load_current )

Read load current.

This function reads voltage on AN pin and calculates the load current.

Parameters

[in]	ctx	: Click context object. See current4_t object definition for detailed explanation.
[out]	load_current	: Output load current [A].

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.