microwave4.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 MICROWAVE4_H
#define MICROWAVE4_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"
#include "drv_i2c_master.h"
 
#define MICROWAVE4_ADC_RESOLUTION    0x0FFF
#define MICROWAVE4_VREF_3V3          3.3
#define MICROWAVE4_VREF_5V           5.0
 
#define MICROWAVE4_SET_DEV_ADDR      0x4D
 
 // microwave4_set
 
#define MICROWAVE4_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // microwave4_map
 // microwave4
 
typedef enum
{
    MICROWAVE4_DRV_SEL_ADC,       
    MICROWAVE4_DRV_SEL_I2C        
} microwave4_drv_t;
 
typedef struct
{
    analog_in_t  adc;                               
    i2c_master_t i2c;                               
    uint8_t      slave_address;                     
    float        vref;                              
    microwave4_drv_t drv_sel;                       
} microwave4_t;
 
typedef struct
{
    pin_name_t an;                                  
    pin_name_t scl;                                 
    pin_name_t sda;                                 
    analog_in_resolution_t resolution;              
    float                  vref;                    
    uint32_t               i2c_speed;               
    uint8_t                i2c_address;             
    microwave4_drv_t drv_sel;                       
} microwave4_cfg_t;
 
typedef enum
{
    MICROWAVE4_OK = 0,
    MICROWAVE4_ERROR = -1
 
} microwave4_return_value_t;
 
void microwave4_cfg_setup ( microwave4_cfg_t *cfg );
 
void microwave4_drv_interface_sel ( microwave4_cfg_t *cfg, microwave4_drv_t drv_sel );
 
err_t microwave4_init ( microwave4_t *ctx, microwave4_cfg_t *cfg );
 
err_t microwave4_read_raw_adc ( microwave4_t *ctx, uint16_t *raw_adc );
 
err_t microwave4_read_voltage ( microwave4_t *ctx, float *voltage );
 
err_t microwave4_set_vref ( microwave4_t *ctx, float vref );
 
#ifdef __cplusplus
}
#endif
#endif // MICROWAVE4_H
 
 // microwave4
 
// ------------------------------------------------------------------------ END