ookrx 2.1.0.0
ookrx.h File Reference

This file contains API for OOK 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  ookrx_t
 OOK RX Click context object. More...
 
struct  ookrx_cfg_t
 OOK RX Click configuration object. More...
 

Macros

#define OOKRX_RSSI_VREF_3V3   3.3f
 OOK RX default settings.
 
#define OOKRX_RSSI_MIN_DBM   ( -110 )
 
#define OOKRX_RSSI_MAX_DBM   ( -50 )
 
#define OOKRX_RSSI_RANGE_DBM   ( OOKRX_RSSI_MAX_DBM - OOKRX_RSSI_MIN_DBM )
 
#define OOKRX_RSSI_MIN_V   0.4f
 
#define OOKRX_RSSI_MAX_V   2.06f
 
#define OOKRX_RSSI_RANGE_V   ( OOKRX_RSSI_MAX_V - OOKRX_RSSI_MIN_V )
 
#define OOKRX_RSSI_DBM_PER_V   ( OOKRX_RSSI_RANGE_DBM / OOKRX_RSSI_MAX_V )
 
#define OOKRX_RSSI_V_TO_DBM(x)   ( OOKRX_RSSI_MIN_DBM + ( ( x - OOKRX_RSSI_MIN_V ) * OOKRX_RSSI_DBM_PER_V ) )
 
#define OOKRX_MAN_BIT_LEN_US   2000
 
#define OOKRX_MAX_DATA_LEN   255
 
#define OOKRX_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  ookrx_return_value_t { OOKRX_OK = 0 , OOKRX_ERROR = -1 }
 OOK RX Click return value data. More...
 

Functions

void ookrx_cfg_setup (ookrx_cfg_t *cfg)
 OOK RX configuration object setup function.
 
err_t ookrx_init (ookrx_t *ctx, ookrx_cfg_t *cfg)
 OOK RX initialization function.
 
void ookrx_enable_squelch (ookrx_t *ctx)
 OOK RX enable squelch function.
 
void ookrx_disable_squelch (ookrx_t *ctx)
 OOK RX disable squelch function.
 
void ookrx_enable_device (ookrx_t *ctx)
 OOK RX enable device function.
 
void ookrx_disable_device (ookrx_t *ctx)
 OOK RX disable device function.
 
uint8_t ookrx_get_data_pin (ookrx_t *ctx)
 OOK RX get data pin function.
 
err_t ookrx_read_rssi_voltage (ookrx_t *ctx, float *data_out)
 OOK RX read RSSI pin voltage level function.
 

Detailed Description

This file contains API for OOK RX Click Driver.

Enumeration Type Documentation

◆ ookrx_return_value_t

OOK RX Click return value data.

Predefined enum values for driver return values.

Enumerator
OOKRX_OK 
OOKRX_ERROR