Public function

Functions
void	qireceiver_cfg_setup (qireceiver_cfg_t *cfg)
	Config Object Initialization function.
QIRECEIVER_RETVAL	qireceiver_init (qireceiver_t *ctx, qireceiver_cfg_t *cfg)
	Initialization function.
void	qireceiver_generic_write (qireceiver_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	qireceiver_generic_read (qireceiver_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
float	qireceiver_read_voltage (qireceiver_t *ctx)
	Read Voltage function.
float	qireceiver_read_current (qireceiver_t *ctx)
	Read Current function.
float	qireceiver_read_freq (qireceiver_t *ctx)
	Read Frequency function.
void	qireceiver_dev_enable (qireceiver_t *ctx)
	Device enable function.

Detailed Description

Function Documentation

qireceiver_cfg_setup()

void qireceiver_cfg_setup

(

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

qireceiver_dev_enable()

void qireceiver_dev_enable

(

qireceiver_t *

ctx

)

Device enable function.

Parameters

ctx	Click object.

Function is used to enable the device.

qireceiver_generic_read()

void qireceiver_generic_read	(	qireceiver_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic read function.

Parameters

ctx	Click object.
reg	Register address.

@description This function reads data from the desired register.

qireceiver_generic_write()

void qireceiver_generic_write	(	qireceiver_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic write function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number of the bytes in data buf.

@description This function writes data to the desired register.

qireceiver_init()

QIRECEIVER_RETVAL qireceiver_init	(	qireceiver_t *	ctx,
		qireceiver_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

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

qireceiver_read_current()

float qireceiver_read_current

(

qireceiver_t *

ctx

)

Read Current function.

Parameters

ctx	Click object.

Returns

result float value of a current amperage

@description Function is used to measure current amperage in mA.

qireceiver_read_freq()

float qireceiver_read_freq

(

qireceiver_t *

ctx

)

Read Frequency function.

Parameters

ctx	Click object.

Returns

result float value of a current frequency

@description Function is used to measure current frequency in hertz.

qireceiver_read_voltage()

float qireceiver_read_voltage

(

qireceiver_t *

ctx

)

Read Voltage function.

Parameters

ctx	Click object.

Returns

result float value of a current voltage

@description Function is used to measure current voltage in volt.