multimeter.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 MULTIMETER_H
#define MULTIMETER_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 MULTIMETER_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.a     = MIKROBUS( mikrobus, MIKROBUS_AN ); \
   cfg.b     = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
   cfg.c     = MIKROBUS( mikrobus, MIKROBUS_INT )
#define MULTIMETER_RETVAL  uint8_t
 
#define MULTIMETER_OK           0x00
#define MULTIMETER_INIT_ERROR   0xFF
#define MULTIMETER_I_CHANNEL   0x00
#define MULTIMETER_U_CHANNEL   0x01
#define MULTIMETER_R_CHANNEL   0x02
#define MULTIMETER_C_CHANNEL   0x03
#define MULTIMETER_MAX_VOLTAGE   4095.0
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    float capacitance_cal;
    float voltage_cal;
    float current_cal;
    uint8_t scan_range;
 
} calibration_t;
 
typedef struct 
{
    float capa_cal_cfg;
    float volt_cal_cfg;
    float curr_cal_cfg;
    uint8_t scan_range_cfg;
 
} calibration_cfg_t;
 
typedef struct
{
    // Output pins 
 
    digital_out_t a;
    digital_out_t b;
    digital_out_t c;
    digital_out_t cs;
    
    // Modules 
 
    spi_master_t spi;
    calibration_t calibration;
    pin_name_t chip_select;
 
} multimeter_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins 
 
    pin_name_t a;
    pin_name_t b;
    pin_name_t c;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
    calibration_cfg_t calibration_cfg;
 
} multimeter_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void multimeter_cfg_setup ( multimeter_cfg_t *cfg );
 
MULTIMETER_RETVAL multimeter_init ( multimeter_t *ctx, multimeter_cfg_t *cfg );
 
void multimeter_default_cfg ( multimeter_t *ctx );
 
float multimeter_read_capacitance ( multimeter_t *ctx );
 
float multimeter_read_voltage ( multimeter_t *ctx );
 
float multimeter_read_current ( multimeter_t *ctx );
 
float multimeter_read_resistance ( multimeter_t *ctx );
 
uint16_t multimeter_get_resistance_range ( multimeter_t *ctx, uint8_t range );
 
void multimeter_set_resistance_range ( multimeter_t *ctx, uint8_t range );
 
#ifdef __cplusplus
}
#endif
#endif  // _MULTIMETER_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END