micrfrx2  2.1.0.0
Data Structures | Macros | Enumerations | Functions
micrfrx2.h File Reference

This file contains API for MICRF RX 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"

Go to the source code of this file.

Data Structures

struct  micrfrx2_t
 MICRF RX 2 Click context object. More...
 
struct  micrfrx2_cfg_t
 MICRF RX 2 Click configuration object. More...
 

Macros

#define MICRFRX2_RSSI_VREF_3V3   3.3f
 MICRF RX 2 default settings. More...
 
#define MICRFRX2_RSSI_MIN_DBM   ( -110 )
 
#define MICRFRX2_RSSI_MAX_DBM   ( -50 )
 
#define MICRFRX2_RSSI_RANGE_DBM   ( MICRFRX2_RSSI_MAX_DBM - MICRFRX2_RSSI_MIN_DBM )
 
#define MICRFRX2_RSSI_MIN_V   0.5f
 
#define MICRFRX2_RSSI_MAX_V   2.0f
 
#define MICRFRX2_RSSI_RANGE_V   ( MICRFRX2_RSSI_MAX_V - MICRFRX2_RSSI_MIN_V )
 
#define MICRFRX2_RSSI_DBM_PER_V   ( MICRFRX2_RSSI_RANGE_DBM / MICRFRX2_RSSI_MAX_V )
 
#define MICRFRX2_RSSI_V_TO_DBM(x)   ( MICRFRX2_RSSI_MIN_DBM + ( ( x - MICRFRX2_RSSI_MIN_V ) * MICRFRX2_RSSI_DBM_PER_V ) )
 
#define MICRFRX2_MAN_BIT_LEN_US   2000
 
#define MICRFRX2_MAX_DATA_LEN   255
 
#define MICRFRX2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  micrfrx2_return_value_t { MICRFRX2_OK = 0, MICRFRX2_ERROR = -1 }
 MICRF RX 2 Click return value data. More...
 

Functions

void micrfrx2_cfg_setup (micrfrx2_cfg_t *cfg)
 MICRF RX 2 configuration object setup function. More...
 
err_t micrfrx2_init (micrfrx2_t *ctx, micrfrx2_cfg_t *cfg)
 MICRF RX 2 initialization function. More...
 
void micrfrx2_set_clock_pin (micrfrx2_t *ctx)
 MICRF RX 2 set clock pin function. More...
 
void micrfrx2_clear_clock_pin (micrfrx2_t *ctx)
 MICRF RX 2 clear clock pin function. More...
 
void micrfrx2_enable_device (micrfrx2_t *ctx)
 MICRF RX 2 enable device function. More...
 
void micrfrx2_disable_device (micrfrx2_t *ctx)
 MICRF RX 2 disable device function. More...
 
uint8_t micrfrx2_get_data_pin (micrfrx2_t *ctx)
 MICRF RX 2 get data pin function. More...
 
err_t micrfrx2_read_rssi_voltage (micrfrx2_t *ctx, float *data_out)
 MICRF RX 2 read RSSI pin voltage level function. More...
 

Detailed Description

This file contains API for MICRF RX 2 Click Driver.

Enumeration Type Documentation

◆ micrfrx2_return_value_t

MICRF RX 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
MICRFRX2_OK 
MICRFRX2_ERROR