rmeter.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 RMETER_H
#define RMETER_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_analog_in.h"
#include "drv_spi_master.h"
 
#define RMETER_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 )  ; \
   cfg.an   = MIKROBUS( mikrobus, MIKROBUS_AN )  ; \
   cfg.s3   = MIKROBUS( mikrobus, MIKROBUS_RST ) ; \
   cfg.s2   = MIKROBUS( mikrobus, MIKROBUS_INT ) ; \
   cfg.s1   = MIKROBUS( mikrobus, MIKROBUS_PWM )
#define RMETER_OK            0
#define RMETER_INIT_ERROR  (-1)
 // End group macro
 
typedef void ( *rmeter_callback_t )( char* );
 
typedef struct
{
    // Auto scale control pins objects.
 
    digital_out_t s3;
    digital_out_t s2;
    digital_out_t s1;
 
    // Analog input pin object.
 
    analog_in_t an;
 
    // Communication module object.
 
    spi_master_t spi;
 
    pin_name_t chip_select;
 
    // R Meter calculation operands.
 
    float ifb;      
    // Callback handler.
 
    rmeter_callback_t callback;
 
} rmeter_t;
 
typedef struct
{
    // Communication pins descriptors.
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional pins descriptors.
 
    pin_name_t an;
    pin_name_t s3;
    pin_name_t s2;
    pin_name_t s1;
 
    // Module configuration settings.
 
    uint32_t spi_speed;
    spi_master_mode_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
    // ADC settings.
 
    analog_in_resolution_t adc_resolution;  
    float adc_vref;                         
} rmeter_cfg_t;
 
 // End types group
 
#ifdef __cplusplus
extern "C"{
#endif
 
void rmeter_cfg_setup ( rmeter_cfg_t *cfg );
 
err_t rmeter_init ( rmeter_t *ctx, rmeter_cfg_t *cfg );
 
void rmeter_set_callback_handler ( rmeter_t *ctx, rmeter_callback_t handler );
 
void rmeter_set_range_up_to_1k9_ohms ( rmeter_t *ctx );
 
void rmeter_set_range_up_to_17k_ohms ( rmeter_t *ctx );
 
void rmeter_set_range_up_to_1M9_ohms ( rmeter_t *ctx );
 
err_t rmeter_read_measurement ( rmeter_t *ctx, uint16_t *data_out );
 
err_t rmeter_calculate_resistance ( rmeter_t *ctx, float *data_out, uint16_t data_in );
 
uint16_t rmeter_auto_scale_range_execution ( rmeter_t *ctx );
 
err_t rmeter_read_an ( rmeter_t *ctx, uint16_t *data_out );
 
err_t rmeter_read_an_voltage ( rmeter_t *ctx, float *data_out );
 
#ifdef __cplusplus
}
#endif
#endif  // RMETER_H
 
 // End public_function group
 // End click Driver group
 
// ------------------------------------------------------------------------ END