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

This file contains API for MICRF RX 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  micrfrx_t
 MICRF RX Click context object. More...
 
struct  micrfrx_cfg_t
 MICRF RX Click configuration object. More...
 

Macros

#define MICRFRX_RSSI_VREF_3V3   3.3f
 MICRF RX default settings. More...
 
#define MICRFRX_RSSI_MIN_DBM   ( -110 )
 
#define MICRFRX_RSSI_MAX_DBM   ( -50 )
 
#define MICRFRX_RSSI_RANGE_DBM   ( MICRFRX_RSSI_MAX_DBM - MICRFRX_RSSI_MIN_DBM )
 
#define MICRFRX_RSSI_MIN_V   0.5f
 
#define MICRFRX_RSSI_MAX_V   2.0f
 
#define MICRFRX_RSSI_RANGE_V   ( MICRFRX_RSSI_MAX_V - MICRFRX_RSSI_MIN_V )
 
#define MICRFRX_RSSI_DBM_PER_V   ( MICRFRX_RSSI_RANGE_DBM / MICRFRX_RSSI_MAX_V )
 
#define MICRFRX_RSSI_V_TO_DBM(x)   ( MICRFRX_RSSI_MIN_DBM + ( ( x - MICRFRX_RSSI_MIN_V ) * MICRFRX_RSSI_DBM_PER_V ) )
 
#define MICRFRX_MAN_BIT_LEN_US   2000
 
#define MICRFRX_MAX_DATA_LEN   255
 
#define MICRFRX_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  micrfrx_return_value_t { MICRFRX_OK = 0, MICRFRX_ERROR = -1 }
 MICRF RX Click return value data. More...
 

Functions

void micrfrx_cfg_setup (micrfrx_cfg_t *cfg)
 MICRF RX configuration object setup function. More...
 
err_t micrfrx_init (micrfrx_t *ctx, micrfrx_cfg_t *cfg)
 MICRF RX initialization function. More...
 
void micrfrx_enable_squelch (micrfrx_t *ctx)
 MICRF RX enable squelch function. More...
 
void micrfrx_disable_squelch (micrfrx_t *ctx)
 MICRF RX disable squelch function. More...
 
void micrfrx_enable_device (micrfrx_t *ctx)
 MICRF RX enable device function. More...
 
void micrfrx_disable_device (micrfrx_t *ctx)
 MICRF RX disable device function. More...
 
uint8_t micrfrx_get_data_pin (micrfrx_t *ctx)
 MICRF RX get data pin function. More...
 
err_t micrfrx_read_rssi_voltage (micrfrx_t *ctx, float *data_out)
 MICRF RX read RSSI pin voltage level function. More...
 

Detailed Description

This file contains API for MICRF RX Click Driver.

Enumeration Type Documentation

◆ micrfrx_return_value_t

MICRF RX Click return value data.

Predefined enum values for driver return values.

Enumerator
MICRFRX_OK 
MICRFRX_ERROR