Angle 10 Click Driver

API for configuring and manipulating Angle 10 Click driver. More...

Topics
	Angle 10 Settings
	Settings of Angle 10 Click driver.
	Angle 10 MikroBUS Map
	MikroBUS pin mapping of Angle 10 Click driver.

Functions
void	angle10_cfg_setup (angle10_cfg_t *cfg)
	Angle 10 configuration object setup function.
err_t	angle10_init (angle10_t *ctx, angle10_cfg_t *cfg)
	Angle 10 initialization function.
err_t	angle10_read_raw_adc (angle10_t *ctx, uint16_t *raw_adc)
	Angle 10 read raw ADC value function.
err_t	angle10_read_voltage (angle10_t *ctx, float *voltage)
	Angle 10 read voltage level function.
err_t	angle10_set_vref (angle10_t *ctx, float vref)
	Angle 10 set vref function.
err_t	angle10_get_angle (angle10_t *ctx, float *angle)
	Angle 10 get angle function.

Detailed Description

API for configuring and manipulating Angle 10 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

angle10_cfg_setup()

void angle10_cfg_setup

(

angle10_cfg_t *

cfg

)

Angle 10 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

angle10_get_angle()

err_t angle10_get_angle	(	angle10_t *	ctx,
		float *	angle )

Angle 10 get angle function.

This function reads the magnetic angular position in degrees based on ANGLE10_NUM_CONVERSIONS of voltage measurements.

Parameters

[in]	ctx	: Click context object. See angle10_t object definition for detailed explanation.
[out]	angle	: Angle in degrees [0-360].

Returns

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

Note

None.

angle10_init()

err_t angle10_init	(	angle10_t *	ctx,
		angle10_cfg_t *	cfg )

Angle 10 initialization function.

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

Parameters

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

Returns

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

Note

None.

angle10_read_raw_adc()

err_t angle10_read_raw_adc	(	angle10_t *	ctx,
		uint16_t *	raw_adc )

Angle 10 read raw ADC value function.

This function reads raw ADC value.

Parameters

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

angle10_read_voltage()

err_t angle10_read_voltage	(	angle10_t *	ctx,
		float *	voltage )

Angle 10 read voltage level function.

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

Parameters

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

angle10_set_vref()

err_t angle10_set_vref	(	angle10_t *	ctx,
		float	vref )

Angle 10 set vref function.

This function sets the voltage reference for Angle 10 click driver.

Parameters

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