Microwave 4 Click Driver

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

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

Functions
void	microwave4_cfg_setup (microwave4_cfg_t *cfg)
	Microwave 4 configuration object setup function.
void	microwave4_drv_interface_sel (microwave4_cfg_t *cfg, microwave4_drv_t drv_sel)
	Microwave 4 driver interface setup function.
err_t	microwave4_init (microwave4_t *ctx, microwave4_cfg_t *cfg)
	Microwave 4 initialization function.
err_t	microwave4_read_raw_adc (microwave4_t *ctx, uint16_t *raw_adc)
	Microwave 4 read raw ADC value function.
err_t	microwave4_read_voltage (microwave4_t *ctx, float *voltage)
	Microwave 4 read voltage level function.
err_t	microwave4_set_vref (microwave4_t *ctx, float vref)
	Microwave 4 set vref function.

Detailed Description

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

microwave4_cfg_setup()

void microwave4_cfg_setup

(

microwave4_cfg_t *

cfg

)

Microwave 4 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

microwave4_drv_interface_sel()

void microwave4_drv_interface_sel	(	microwave4_cfg_t *	cfg,
		microwave4_drv_t	drv_sel )

Microwave 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 microwave4_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See microwave4_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.

microwave4_init()

err_t microwave4_init	(	microwave4_t *	ctx,
		microwave4_cfg_t *	cfg )

Microwave 4 initialization function.

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

Parameters

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

Returns

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

Note

None.

microwave4_read_raw_adc()

err_t microwave4_read_raw_adc	(	microwave4_t *	ctx,
		uint16_t *	raw_adc )

Microwave 4 read raw ADC value function.

This function reads raw ADC value.

Parameters

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

microwave4_read_voltage()

err_t microwave4_read_voltage	(	microwave4_t *	ctx,
		float *	voltage )

Microwave 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 microwave4_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.

microwave4_set_vref()

err_t microwave4_set_vref	(	microwave4_t *	ctx,
		float	vref )

Microwave 4 set vref function.

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

Parameters

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