amrangle.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 AMRANGLE_H
#define AMRANGLE_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 "drv_analog_in.h"
#include "math.h"
    
#define AMRANGLE_ARM_TOOLCHAIN                                  0x00
 
#define AMRANGLE_PIC_TOOLCHAIN                                  0x01
 
 // sel_toolchain
 
#define AMRANGLE_GAIN_CONTROL_EN                                0x01
 
#define AMRANGLE_GAIN_CONTROL_DIS                               0x00
 
 // gain_control
 
#define AMRANGLE_POWER_DOWN_EN                                  0x01
 
#define AMRANGLE_POWER_DOWN_DIS                                 0x00
 
 // pd_state
 
#define AMRANGLE_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.gc   = MIKROBUS( mikrobus, MIKROBUS_RST );  \
    cfg.pd   = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // amrangle_map
 // amrangle
 
typedef struct
{
    // Output pins
 
    digital_out_t  gc;                  
    digital_out_t  pd;                  
    // Modules
    
    analog_in_t   adc;                  
    spi_master_t  spi;                  
    pin_name_t    chip_select;          
} amrangle_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  an;                    
     pin_name_t  gc;                    
     pin_name_t  pd;                    
    // static variable
 
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
    analog_in_resolution_t             resolution;       
    float                              vref;             
} amrangle_cfg_t;
 
typedef enum
{
    AMRANGLE_OK = 0,
    AMRANGLE_ERROR = -1
 
} amrangle_return_value_t;
 
void amrangle_cfg_setup ( amrangle_cfg_t *cfg, uint8_t sel_toolchain );
 
err_t amrangle_init ( amrangle_t *ctx, amrangle_cfg_t *cfg );
 
void amrangle_default_cfg ( amrangle_t *ctx );
 
float amrangle_angle_read ( amrangle_t *ctx );
 
err_t amrangle_read_vtp_voltage ( amrangle_t *ctx, float *vtp_volts );
 
float amrangle_read_vtp_temp ( amrangle_t *ctx );
 
void amrangle_gain_control_mode ( amrangle_t *ctx, uint8_t gain_control );
 
void amrangle_power_down_pin ( amrangle_t *ctx, uint8_t pd_state );
 
#ifdef __cplusplus
}
#endif
#endif // AMRANGLE_H
 
 // amrangle
 
// ------------------------------------------------------------------------ END