RF Meter 3 Click Driver

API for configuring and manipulating RF Meter 3 Click driver. More...

Topics
	RF Meter 3 Registers Settings
	Settings for registers of RF Meter 3 Click driver.
	RF Meter 3 MikroBUS Map
	MikroBUS pin mapping of RF Meter 3 Click driver.

Functions
void	rfmeter3_cfg_setup (rfmeter3_cfg_t *cfg)
	RF Meter 3 configuration object setup function.
err_t	rfmeter3_init (rfmeter3_t *ctx, rfmeter3_cfg_t *cfg)
	RF Meter 3 initialization function.
err_t	rfmeter3_read_an_pin_value (rfmeter3_t *ctx, uint16_t *data_out)
	RF Meter 3 read AN pin value function.
err_t	rfmeter3_read_an_pin_voltage (rfmeter3_t *ctx, float *data_out)
	RF Meter 3 read AN pin voltage level function.
void	rfmeter3_enable_device (rfmeter3_t *ctx)
	RF Meter 3 enable device function.
void	rfmeter3_disable_device (rfmeter3_t *ctx)
	RF Meter 3 disable device function.
err_t	rfmeter3_get_rf_input_power (rfmeter3_t *ctx, float *data_out)
	RF Meter 3 get rf input power function.

Detailed Description

API for configuring and manipulating RF Meter 3 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

rfmeter3_cfg_setup()

void rfmeter3_cfg_setup

(

rfmeter3_cfg_t *

cfg

)

RF Meter 3 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

rfmeter3_disable_device()

void rfmeter3_disable_device

(

rfmeter3_t *

ctx

)

RF Meter 3 disable device function.

This function disables device by setting EN pin to LOW logic level.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

rfmeter3_enable_device()

void rfmeter3_enable_device

(

rfmeter3_t *

ctx

)

RF Meter 3 enable device function.

This function enables device by setting EN pin to HIGH logic level.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

rfmeter3_get_rf_input_power()

err_t rfmeter3_get_rf_input_power	(	rfmeter3_t *	ctx,
		float *	data_out )

RF Meter 3 get rf input power function.

This function reads the voltage from AN pin and converts it to RF input power in dBm.

Parameters

[in]	ctx	: Click context object. See rfmeter3_t object definition for detailed explanation.
[out]	data_out	: RF Input Power [dBm].

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).

rfmeter3_init()

err_t rfmeter3_init	(	rfmeter3_t *	ctx,
		rfmeter3_cfg_t *	cfg )

RF Meter 3 initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

rfmeter3_read_an_pin_value()

err_t rfmeter3_read_an_pin_value	(	rfmeter3_t *	ctx,
		uint16_t *	data_out )

RF Meter 3 read AN pin value function.

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

Parameters

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

rfmeter3_read_an_pin_voltage()

err_t rfmeter3_read_an_pin_voltage	(	rfmeter3_t *	ctx,
		float *	data_out )

RF Meter 3 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 rfmeter3_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).