POT 4 Click Driver

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

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

Functions
void	pot4_cfg_setup (pot4_cfg_t *cfg)
	POT 4 configuration object setup function.
void	pot4_drv_interface_selection (pot4_cfg_t *cfg, pot4_drv_t drv_sel)
	POT 4 driver interface setup function.
err_t	pot4_init (pot4_t *ctx, pot4_cfg_t *cfg)
	POT 4 initialization function.
err_t	pot4_read_raw_adc (pot4_t *ctx, uint16_t *raw_adc)
	POT 4 read raw ADC value function.
err_t	pot4_read_voltage (pot4_t *ctx, float *voltage)
	POT 4 read voltage level function.
err_t	pot4_set_vref (pot4_t *ctx, float vref)
	POT 4 set vref function.
uint8_t	pot4_get_switch_pin (pot4_t *ctx)
	POT 4 get switch pin function.
uint8_t	pot4_convert_voltage_to_percents (pot4_t *ctx, float voltage)
	POT 4 convert voltage to percents function.

Detailed Description

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

pot4_cfg_setup()

void pot4_cfg_setup

(

pot4_cfg_t *

cfg

)

POT 4 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

pot4_convert_voltage_to_percents()

uint8_t pot4_convert_voltage_to_percents	(	pot4_t *	ctx,
		float	voltage )

POT 4 convert voltage to percents function.

This function converts analog voltage to potentiometer position in percents.

Parameters

[in]

ctx

: Click context object. See pot4_t object definition for detailed explanation.

Returns

Potentiometer position in percents.

Note

None.

pot4_drv_interface_selection()

void pot4_drv_interface_selection	(	pot4_cfg_t *	cfg,
		pot4_drv_t	drv_sel )

POT 4 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 pot4_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See pot4_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.

pot4_get_switch_pin()

uint8_t pot4_get_switch_pin

(

pot4_t *

ctx

)

POT 4 get switch pin function.

This function returns the switch (SW) pin logic state.

Parameters

[in]

ctx

: Click context object. See pot4_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

pot4_init()

err_t pot4_init	(	pot4_t *	ctx,
		pot4_cfg_t *	cfg )

POT 4 initialization function.

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

Parameters

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

Returns

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

Note

None.

pot4_read_raw_adc()

err_t pot4_read_raw_adc	(	pot4_t *	ctx,
		uint16_t *	raw_adc )

POT 4 read raw ADC value function.

This function reads raw ADC value.

Parameters

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

pot4_read_voltage()

err_t pot4_read_voltage	(	pot4_t *	ctx,
		float *	voltage )

POT 4 read voltage level function.

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

Parameters

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

pot4_set_vref()

err_t pot4_set_vref	(	pot4_t *	ctx,
		float	vref )

POT 4 set vref function.

This function sets the voltage reference for POT 4 click driver.

Parameters

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