amrangle2.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 AMRANGLE2_H
#define AMRANGLE2_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"
#include "drv_analog_in.h"
 
#define AMRANGLE2_REG_ADC_MODE_CONTROL          0x0000
#define AMRANGLE2_REG_ADC_CONFIGURATION         0x8000
#define AMRANGLE2_REG_UNIPOLAR                  0x8800
#define AMRANGLE2_REG_BIPOLAR                   0x9000
#define AMRANGLE2_REG_RANGE                     0x9800
#define AMRANGLE2_REG_CUSTOM_SCAN0              0xA000
#define AMRANGLE2_REG_CUSTOM_SCAN1              0xA800
#define AMRANGLE2_REG_SAMPLE_SET                0xB000
 
 // amrangle2_reg
 
#define AMRANGLE2_SCAN_UNCHANGED                0x0000
#define AMRANGLE2_SCAN_MANUAL                   0x0800
#define AMRANGLE2_SCAN_REPEAT                   0x1000
#define AMRANGLE2_SCAN_STANDARD_INT             0x1800
#define AMRANGLE2_SCAN_STANDARD_EXT             0x2000
#define AMRANGLE2_SCAN_UPPER_INT                0x2800
#define AMRANGLE2_SCAN_UPPER_EXT                0x3000
#define AMRANGLE2_SCAN_CUSTOM_INT               0x3800
#define AMRANGLE2_SCAN_CUSTOM_EXT               0x4000
#define AMRANGLE2_SCAN_SAMPLE_SET               0x4800
#define AMRANGLE2_CHSEL_AIN0                    0x0000
#define AMRANGLE2_CHSEL_AIN1                    0x0080
#define AMRANGLE2_CHSEL_AIN2                    0x0100
#define AMRANGLE2_CHSEL_AIN3                    0x0180
#define AMRANGLE2_RESET_FIFO                    0x0020
#define AMRANGLE2_RESET_ALL                     0x0040
#define AMRANGLE2_PM_NORMAL                     0x0000
#define AMRANGLE2_PM_AUTO_SHUTDOWN              0x0008
#define AMRANGLE2_PM_AUTO_STANDBY               0x0010
#define AMRANGLE2_CHAN_ID_ENABLE                0x0004
#define AMRANGLE2_SWCNV_START                   0x0002
 
#define AMRANGLE2_REFSEL_EXT_DIFFERENTIAL       0x0400
#define AMRANGLE2_AVGON                         0x0200
#define AMRANGLE2_NAVG_4                        0x0000
#define AMRANGLE2_NAVG_8                        0x0080
#define AMRANGLE2_NAVG_16                       0x0100
#define AMRANGLE2_NAVG_32                       0x0180
#define AMRANGLE2_NSCAN_4                       0x0000
#define AMRANGLE2_NSCAN_8                       0x0020
#define AMRANGLE2_NSCAN_12                      0x0040
#define AMRANGLE2_NSCAN_16                      0x0060
#define AMRANGLE2_SPM_NORMAL                    0x0000
#define AMRANGLE2_SPM_FULL_SHUTDOWN             0x0008
#define AMRANGLE2_SPM_PARTIAL_SHUTDOWN          0x0010
#define AMRANGLE2_ECHO_ON                       0x0004
 
#define AMRANGLE2_RANGE01_HALF_VREF             0x0000
#define AMRANGLE2_RANGE01_FULL_VREF             0x0400
#define AMRANGLE2_RANGE23_HALF_VREF             0x0000
#define AMRANGLE2_RANGE23_FULL_VREF             0x0200
 
#define AMRANGLE2_BCH01_UNIPOLAR                0x0000
#define AMRANGLE2_BCH01_BIPOLAR_FULLY_DIFF      0x0400
#define AMRANGLE2_BCH23_UNIPOLAR                0x0000
#define AMRANGLE2_BCH23_BIPOLAR_FULLY_DIFF      0x0200
 
#define AMRANGLE2_ADC_VREF                      3.3
#define AMRANGLE2_ADC_RESOLUTION                0x0FFF
 
#define AMRANGLE2_RADIANS_TO_DEGREES            57.295779513
#define AMRANGLE2_ANGLE_ZERO_OFFSET             90.0
 
#define AMRANGLE2_TEMP_VDD                      3.3
#define AMRANGLE2_TEMP_TCAL                     25.0
#define AMRANGLE2_TEMP_TCO                      0.003173
#define AMRANGLE2_TEMP_NUM_CONVERSIONS          100
 
#define AMRANGLE2_SET_DATA_SAMPLE_EDGE          SET_SPI_DATA_SAMPLE_EDGE
#define AMRANGLE2_SET_DATA_SAMPLE_MIDDLE        SET_SPI_DATA_SAMPLE_MIDDLE
 
 // amrangle2_set
 
#define AMRANGLE2_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.cst  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.eoc  = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // amrangle2_map
 // amrangle2
 
typedef struct
{
    // Output pins
    digital_out_t cst;          
    // Input pins
    digital_in_t  eoc;          
    // Modules
    spi_master_t  spi;          
    analog_in_t   adc;          
    pin_name_t    chip_select;  
    float         vcal;         
} amrangle2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
    pin_name_t an;              
    // Additional gpio pins
    pin_name_t cst;             
    pin_name_t eoc;             
    // 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;                       
} amrangle2_cfg_t;
 
typedef enum
{
    AMRANGLE2_OK = 0,
    AMRANGLE2_ERROR = -1
 
} amrangle2_return_value_t;
 
void amrangle2_cfg_setup ( amrangle2_cfg_t *cfg );
 
err_t amrangle2_init ( amrangle2_t *ctx, amrangle2_cfg_t *cfg );
 
err_t amrangle2_default_cfg ( amrangle2_t *ctx );
 
err_t amrangle2_spi_transfer ( amrangle2_t *ctx, uint16_t data_in );
 
err_t amrangle2_read_an_pin_value ( amrangle2_t *ctx, uint16_t *data_out );
 
err_t amrangle2_read_an_pin_voltage ( amrangle2_t *ctx, float *data_out );
 
err_t amrangle2_calibrate_temperature ( amrangle2_t *ctx );
 
err_t amrangle2_read_temperature ( amrangle2_t *ctx, float *temperature );
 
err_t amrangle2_read_vsin_vcos ( amrangle2_t *ctx, float *vsin, float *vcos );
 
err_t amrangle2_read_angle ( amrangle2_t *ctx, float *angle );
 
void amrangle2_set_cst_pin ( amrangle2_t *ctx, uint8_t state );
 
uint8_t amrangle2_get_eoc_pin ( amrangle2_t *ctx );
 
void amrangle2_start_conversion ( amrangle2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // AMRANGLE2_H
 
 // amrangle2
 
// ------------------------------------------------------------------------ END