isoadc.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 ISOADC_H
#define ISOADC_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_spi_master.h"
#include "spi_specifics.h"
 
#define ISOADC_VEXT_MIN                 4.5f
#define ISOADC_VEXT_5V                  5.0f
#define ISOADC_VEXT_MAX                 5.5f
#define ISOADC_ADC_RESOLUTION           65535
#define ISOADC_ADC_FSR                  320
#define ISOADC_ADC_2FSR                 ( ISOADC_ADC_FSR * 2 )
#define ISOADC_ADC_NUM_AVERAGES         65535
#define ISOADC_VOLTAGE_NUM_AVERAGES     10
#define ISOADC_TIMEOUT_COUNT            1000
#define ISOADC_VOLTAGE_TO_CURRENT       0.1f
#define ISOADC_MILLI_TO_ONE             1000
 
#define ISOADC_SET_DATA_SAMPLE_EDGE     SET_SPI_DATA_SAMPLE_EDGE
#define ISOADC_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 
 // isoadc_set
 
#define ISOADC_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );
 
 // isoadc_map
 // isoadc
 
typedef struct
{
    // Modules
    spi_master_t spi;               
    float vext;                     
} isoadc_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    // static variable
    uint32_t            spi_speed;  
    spi_master_mode_t   spi_mode;   
} isoadc_cfg_t;
 
typedef enum
{
    ISOADC_OK = 0,
    ISOADC_ERROR = -1
 
} isoadc_return_value_t;
 
void isoadc_cfg_setup ( isoadc_cfg_t *cfg );
 
err_t isoadc_init ( isoadc_t *ctx, isoadc_cfg_t *cfg );
 
err_t isoadc_read_raw_adc ( isoadc_t *ctx, uint16_t *data_out );
 
void isoadc_set_vext ( isoadc_t *ctx, float vext );
 
err_t isoadc_read_voltage ( isoadc_t *ctx, float *voltage );
 
float isoadc_get_current ( float voltage );
 
float isoadc_get_power ( isoadc_t *ctx, float voltage );
 
#ifdef __cplusplus
}
#endif
#endif // ISOADC_H
 
 // isoadc
 
// ------------------------------------------------------------------------ END