Current 9 Click Driver

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

Topics
	Current 9 Settings
	Settings of Current 9 Click driver.
	Current 9 MikroBUS Map
	MikroBUS pin mapping of Current 9 Click driver.

Functions
void	current9_cfg_setup (current9_cfg_t *cfg)
	Current 9 configuration object setup function.
void	current9_drv_interface_selection (current9_cfg_t *cfg, current9_drv_t drv_sel)
	Current 9 driver interface setup function.
err_t	current9_init (current9_t *ctx, current9_cfg_t *cfg)
	Current 9 initialization function.
err_t	current9_read_raw_adc (current9_t *ctx, uint16_t *raw_adc)
	Current 9 read raw ADC value function.
err_t	current9_read_voltage (current9_t *ctx, float *voltage)
	Current 9 read voltage level function.
err_t	current9_set_vref (current9_t *ctx, float vref)
	Current 9 set vref function.
err_t	current9_read_current (current9_t *ctx, float *current)
	Current 9 read current function.

Detailed Description

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

current9_cfg_setup()

void current9_cfg_setup

(

current9_cfg_t *

cfg

)

Current 9 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

current9_drv_interface_selection()

void current9_drv_interface_selection	(	current9_cfg_t *	cfg,
		current9_drv_t	drv_sel )

Current 9 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 current9_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See current9_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.

current9_init()

err_t current9_init	(	current9_t *	ctx,
		current9_cfg_t *	cfg )

Current 9 initialization function.

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

Parameters

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

Returns

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

Note

None.

current9_read_current()

err_t current9_read_current	(	current9_t *	ctx,
		float *	current )

Current 9 read current function.

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

Parameters

[in]	ctx	: Click context object. See current9_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 current9_set_vref function, increase the number of conversions by modifying the CURRENT9_NUM_CONVERSIONS macro, and adjust the CURRENT9_ZERO_CURRENT_OFFSET voltage value.

current9_read_raw_adc()

err_t current9_read_raw_adc	(	current9_t *	ctx,
		uint16_t *	raw_adc )

Current 9 read raw ADC value function.

This function reads raw ADC value.

Parameters

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

current9_read_voltage()

err_t current9_read_voltage	(	current9_t *	ctx,
		float *	voltage )

Current 9 read voltage level function.

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

Parameters

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

current9_set_vref()

err_t current9_set_vref	(	current9_t *	ctx,
		float	vref )

Current 9 set vref function.

This function sets the voltage reference for Current 9 click driver.

Parameters

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