qirx.h File Reference

This file contains API for Qi RX Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures
struct	qirx_t
	Qi RX Click context object. More...
struct	qirx_cfg_t
	Qi RX Click configuration object. More...

Macros
#define	QIRX_RESOLUTION   4096
	Qi RX description setting.
#define	QIRX_12_BIT_DATA   0x0FFF
#define	QIRX_SET_DEV_ADDR   0x4D
	Qi RX device address setting.
#define	QIRX_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	qirx_return_value_t { QIRX_OK = 0 , QIRX_ERROR = -1 }
	Qi RX Click return value data. More...

Functions
void	qirx_cfg_setup (qirx_cfg_t *cfg)
	Qi RX configuration object setup function.
err_t	qirx_init (qirx_t *ctx, qirx_cfg_t *cfg)
	Qi RX initialization function.
uint16_t	qirx_read_data (qirx_t *ctx)
	Read data function.
uint16_t	qirx_read_voltage (qirx_t *ctx, uint16_t v_ref)
	Read voltage function.

Detailed Description

This file contains API for Qi RX Click Driver.

Enumeration Type Documentation

qirx_return_value_t

enum qirx_return_value_t

Qi RX Click return value data.

Predefined enum values for driver return values.

Enumerator
QIRX_OK
QIRX_ERROR