rfmeter.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright (c) 2019, MikroElektronika - www.mikroe.com
 * All rights reserved.
 *
 * 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 RFMETER_H
#define RFMETER_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_spi_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define RFMETER_MAP_MIKROBUS( cfg, mikrobus )       \
   cfg.miso  = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi  = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck   = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
   cfg.cs    = MIKROBUS( mikrobus, MIKROBUS_CS )
#define RFMETER_RETVAL  uint8_t
 
#define RFMETER_OK           0x00
#define RFMETER_INIT_ERROR   0xFF
#define RFMETER_FILTER_USEFULL_DATA  0x1FFE
#define RFMETER_ADC_RESOLUTION       4096
#define RFMETER_DATA_SAMPLE_NUM      10
#define RFMETER_DEF_VREF             2.5
#define RFMETER_DEF_SLOPE            -0.025
#define RFMETER_DEF_INTERCEPT        20.0
#define RFMETER_DEF_LIMIT_HIGH       2.0
#define RFMETER_DEF_LIMIT_LOW        0.5
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{    
    digital_out_t cs;
 
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} rfmeter_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} rfmeter_cfg_t;
 
 // End types group
// ------------------------------------------------------------------ CONSTANTS
 // End constants group
// ------------------------------------------------------------------ VARIABLES
 // End variable group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void rfmeter_cfg_setup ( rfmeter_cfg_t *cfg );
 
RFMETER_RETVAL rfmeter_init ( rfmeter_t *ctx, rfmeter_cfg_t *cfg );
 
uint16_t rfmeter_read_data ( rfmeter_t *ctx );
 
uint16_t rfmeter_get_raw_data ( rfmeter_t *ctx );
 
float rfmeter_get_voltage ( rfmeter_t *ctx );
 
float rfmeter_get_signal_strenght ( rfmeter_t *ctx, float slope, float intercept );
 
#ifdef __cplusplus
}
#endif
#endif  // _RFMETER_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END