ookrx.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef OOKRX_H
#define OOKRX_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
 
#define OOKRX_RSSI_VREF_3V3       3.3f
#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
 
 // ookrx_cfg
 
#define OOKRX_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.rssi = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.sqc = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.dout = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ookrx_map
 // ookrx
 
typedef struct
{
    digital_out_t en;       
    digital_out_t sqc;      
    digital_in_t dout;      
    analog_in_t adc;        
} ookrx_t;
 
typedef struct
{
    pin_name_t rssi;        
    pin_name_t en;          
    pin_name_t sqc;         
    pin_name_t dout;        
    analog_in_resolution_t resolution;  
    float                  vref;        
} ookrx_cfg_t;
 
typedef enum
{
    OOKRX_OK = 0,
    OOKRX_ERROR = -1
 
} ookrx_return_value_t;
 
void ookrx_cfg_setup ( ookrx_cfg_t *cfg );
 
err_t ookrx_init ( ookrx_t *ctx, ookrx_cfg_t *cfg );
 
void ookrx_enable_squelch ( ookrx_t *ctx );
 
void ookrx_disable_squelch ( ookrx_t *ctx );
 
void ookrx_enable_device ( ookrx_t *ctx );
 
void ookrx_disable_device ( ookrx_t *ctx );
 
uint8_t ookrx_get_data_pin ( ookrx_t *ctx );
 
err_t ookrx_read_rssi_voltage ( ookrx_t *ctx, float *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // OOKRX_H
 
 // ookrx
 
// ------------------------------------------------------------------------ END