angle9.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 ANGLE9_H
#define ANGLE9_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 ANGLE9_REG_EWA                      0x02
#define ANGLE9_REG_EWDH                     0x04
#define ANGLE9_REG_EWDL                     0x06
#define ANGLE9_REG_EWCS                     0x08
#define ANGLE9_REG_ERA                      0x0A
#define ANGLE9_REG_ERCS                     0x0C
#define ANGLE9_REG_ERDH                     0x0E
#define ANGLE9_REG_ERDL                     0x10
#define ANGLE9_REG_CTRL                     0x1E
#define ANGLE9_REG_ANG                      0x20
#define ANGLE9_REG_STA                      0x22
#define ANGLE9_REG_ERR                      0x24
#define ANGLE9_REG_WARN                     0x26
#define ANGLE9_REG_TSEN                     0x28
#define ANGLE9_REG_FIELD                    0x2A
#define ANGLE9_REG_HANG                     0x30
#define ANGLE9_REG_ANG15                    0x32
#define ANGLE9_REG_ZANG                     0x34
#define ANGLE9_REG_KEY                      0x3C
 
 // angle9_reg
 
#define ANGLE9_WRITE_BIT                    0x40            
 
#define ANGLE9_DATA_RESOLUTION              0x0FFFu
#define ANGLE9_FULL_CIRCLE                  360.0f
#define ANGLE9_TEMP_RESOLUTION              8.0f
#define ANGLE9_TEMP_OFFSET                  25.0f
 
#define ANGLE9_ODD_PARITY                   0x01
 
#define ANGLE9_SET_DATA_SAMPLE_EDGE         SET_SPI_DATA_SAMPLE_EDGE
#define ANGLE9_SET_DATA_SAMPLE_MIDDLE       SET_SPI_DATA_SAMPLE_MIDDLE
 
 // angle9_set
 
#define ANGLE9_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.pwm  = MIKROBUS( mikrobus, MIKROBUS_PWM );
 
 // angle9_map
 // angle9
 
typedef struct
{
    // Input pins
    digital_in_t pwm;           
    // Modules
    spi_master_t spi;           
    pin_name_t   chip_select;   
} angle9_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 pwm;             
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} angle9_cfg_t;
 
typedef enum
{
    ANGLE9_OK = 0,
    ANGLE9_ERROR = -1
 
} angle9_return_value_t;
 
void angle9_cfg_setup ( angle9_cfg_t *cfg );
 
err_t angle9_init ( angle9_t *ctx, angle9_cfg_t *cfg );
 
err_t angle9_write_register ( angle9_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t angle9_read_register ( angle9_t *ctx, uint8_t reg, uint16_t *data_out );
 
uint8_t angle9_get_pwm_pin ( angle9_t *ctx );
 
err_t angle9_read_angle ( angle9_t *ctx, float *angle );
 
err_t angle9_read_temperature ( angle9_t *ctx, float *temperature );
 
err_t angle9_read_field_strength ( angle9_t *ctx, uint16_t *field_str );
 
#ifdef __cplusplus
}
#endif
#endif // ANGLE9_H
 
 // angle9
 
// ------------------------------------------------------------------------ END