Public function

Functions
void	rfmeter_cfg_setup (rfmeter_cfg_t *cfg)
	Config Object Initialization function.
RFMETER_RETVAL	rfmeter_init (rfmeter_t *ctx, rfmeter_cfg_t *cfg)
	Initialization function.
uint16_t	rfmeter_read_data (rfmeter_t *ctx)
	Data read function.
uint16_t	rfmeter_get_raw_data (rfmeter_t *ctx)
	Get raw data function.
float	rfmeter_get_voltage (rfmeter_t *ctx)
	Get voltage function.
float	rfmeter_get_signal_strenght (rfmeter_t *ctx, float slope, float intercept)
	Get signal strenght function.

Detailed Description

Function Documentation

rfmeter_cfg_setup()

void rfmeter_cfg_setup

(

rfmeter_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

@description This function initializes click configuration structure to init state.

Note

All used pins will be set to unconnected state.

rfmeter_get_raw_data()

uint16_t rfmeter_get_raw_data

(

rfmeter_t *

ctx

)

Get raw data function.

Parameters

ctx	Click object.

Returns

result 12-bit value that represents raw data value.

Function is used to read raw data value from output register.

rfmeter_get_signal_strenght()

float rfmeter_get_signal_strenght	(	rfmeter_t *	ctx,
		float	slope,
		float	intercept )

Get signal strenght function.

Parameters

ctx	Click object.
slope	float value that represents slope
intercept	float value that represents intercept

Returns

result float value that represents signal strenght

Function is used to calculate radio frequency signal strenght in a vicinity.

rfmeter_get_voltage()

float rfmeter_get_voltage

(

rfmeter_t *

ctx

)

Get voltage function.

Parameters

ctx	Click object.

Returns

result 12-bit value that represents raw voltage value.

Function is used to read raw voltage value from output register.

rfmeter_init()

RFMETER_RETVAL rfmeter_init	(	rfmeter_t *	ctx,
		rfmeter_cfg_t *	cfg )

Initialization function.

Parameters

rfmeter	Click object.
cfg	Click configuration structure.

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

rfmeter_read_data()

uint16_t rfmeter_read_data

(

rfmeter_t *

ctx

)

Data read function.

Parameters

ctx	Click object.

Returns

result 16-bit value that represents readings from output register.

Function is used to read data from output register.