angle10.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 ANGLE10_H
#define ANGLE10_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"
 
#define ANGLE10_FULL_CIRCLE         360.0
#define ANGLE10_NUM_CONVERSIONS     50
 
#define ANGLE10_VREF_3V3            3.3
#define ANGLE10_VREF_5V             5.0
 
 // angle10_set
 
#define ANGLE10_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
 
 // angle10_map
 // angle10
 
typedef struct
{
    analog_in_t adc;            
    float       vref;           
} angle10_t;
 
typedef struct
{
    pin_name_t an;              
    analog_in_resolution_t resolution;  
    float      vref;            
} angle10_cfg_t;
 
typedef enum
{
    ANGLE10_OK = 0,
    ANGLE10_ERROR = -1
 
} angle10_return_value_t;
 
void angle10_cfg_setup ( angle10_cfg_t *cfg );
 
err_t angle10_init ( angle10_t *ctx, angle10_cfg_t *cfg );
 
err_t angle10_read_raw_adc ( angle10_t *ctx, uint16_t *raw_adc );
 
err_t angle10_read_voltage ( angle10_t *ctx, float *voltage );
 
err_t angle10_set_vref ( angle10_t *ctx, float vref );
 
err_t angle10_get_angle ( angle10_t *ctx, float *angle );
 
#ifdef __cplusplus
}
#endif
#endif // ANGLE10_H
 
 // angle10
 
// ------------------------------------------------------------------------ END