angle7.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 ANGLE7_H
#define ANGLE7_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_i2c_master.h"
#include "drv_analog_in.h"
 
#define ANGLE7_REG_ZMCO                     0x00
#define ANGLE7_REG_ZPOS_MSB                 0x01
#define ANGLE7_REG_ZPOS_LSB                 0x02
#define ANGLE7_REG_MPOS_MSB                 0x03
#define ANGLE7_REG_MPOS_LSB                 0x04
#define ANGLE7_REG_MANG_MSB                 0x05
#define ANGLE7_REG_MANG_LSB                 0x06
#define ANGLE7_REG_CONF_MSB                 0x07
#define ANGLE7_REG_CONF_LSB                 0x08
#define ANGLE7_REG_STATUS                   0x0B
#define ANGLE7_REG_RAW_ANGLE_MSB            0x0C
#define ANGLE7_REG_RAW_ANGLE_LSB            0x0D
#define ANGLE7_REG_ANGLE_MSB                0x0E
#define ANGLE7_REG_ANGLE_LSB                0x0F
#define ANGLE7_REG_AGC                      0x1A
#define ANGLE7_REG_MAGNITUDE_MSB            0x1B
#define ANGLE7_REG_MAGNITUDE_LSB            0x1C
#define ANGLE7_REG_BURN                     0xFF
 
 // angle7_reg
 
#define ANGLE7_CONF_WATCHDOG_OFF            0x0000
#define ANGLE7_CONF_WATCHDOG_ON             0x2000
#define ANGLE7_CONF_WATCHDOG_BIT_MASK       0x2000
#define ANGLE7_CONF_FTH_SLOW                0x0000
#define ANGLE7_CONF_FTH_6LSB                0x0400
#define ANGLE7_CONF_FTH_7LSB                0x0800
#define ANGLE7_CONF_FTH_9LSB                0x0C00
#define ANGLE7_CONF_FTH_18LSB               0x1000
#define ANGLE7_CONF_FTH_21LSB               0x1400
#define ANGLE7_CONF_FTH_24LSB               0x1800
#define ANGLE7_CONF_FTH_10LSB               0x1C00
#define ANGLE7_CONF_FTH_BIT_MASK            0x1C00
#define ANGLE7_CONF_SF_16X                  0x0000
#define ANGLE7_CONF_SF_8X                   0x0100
#define ANGLE7_CONF_SF_4X                   0x0200
#define ANGLE7_CONF_SF_2X                   0x0300
#define ANGLE7_CONF_SF_BIT_MASK             0x0300
#define ANGLE7_CONF_PWMF_115HZ              0x0000
#define ANGLE7_CONF_PWMF_230HZ              0x0040
#define ANGLE7_CONF_PWMF_460HZ              0x0080
#define ANGLE7_CONF_PWMF_920HZ              0x00C0
#define ANGLE7_CONF_PWMF_BIT_MASK           0x00C0
#define ANGLE7_CONF_OUTS_ANALOG_FULL        0x0000
#define ANGLE7_CONF_OUTS_ANALOG_REDUCED     0x0010
#define ANGLE7_CONF_OUTS_PWM                0x0020
#define ANGLE7_CONF_OUTS_BIT_MASK           0x0030
#define ANGLE7_CONF_HYST_OFF                0x0000
#define ANGLE7_CONF_HYST_1LSB               0x0004
#define ANGLE7_CONF_HYST_2LSB               0x0008
#define ANGLE7_CONF_HYST_3LSB               0x000C
#define ANGLE7_CONF_HYST_BIT_MASK           0x000C
#define ANGLE7_CONF_PM_NOM                  0x0000
#define ANGLE7_CONF_PM_LPM1                 0x0001
#define ANGLE7_CONF_PM_LPM2                 0x0002
#define ANGLE7_CONF_PM_LPM3                 0x0003
#define ANGLE7_CONF_PM_BIT_MASK             0x0003
 
#define ANGLE7_STATUS_MAGNET_DETECTED       0x20
#define ANGLE7_STATUS_MAGNET_TOO_WEAK       0x10
#define ANGLE7_STATUS_MAGNET_TOO_STRONG     0x08
 
#define ANGLE7_BURN_ANGLE                   0x80
#define ANGLE7_BURN_SETTING                 0x40
 
#define ANGLE7_RESOLUTION                   0x0FFF
#define ANGLE7_FULL_CIRCLE                  360.0
#define ANGLE7_ZERO_POSITION                0.0
 
#define ANGLE7_DEVICE_ADDRESS               0x36
 
 // angle7_set
 
#define ANGLE7_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // angle7_map
 // angle7
 
typedef struct
{
    // Output pins
    digital_out_t en;           
    // Input pins
    digital_in_t  int_pin;      
    // Modules
    i2c_master_t i2c;           
    analog_in_t  adc;           
    // I2C slave address
    uint8_t slave_address;      
    float start_position;
    float stop_position;
 
} angle7_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  en;             
    pin_name_t  an;             
    pin_name_t  int_pin;        
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
    analog_in_resolution_t  resolution;     
    float                   vref;           
} angle7_cfg_t;
 
typedef enum
{
    ANGLE7_OK = 0,
    ANGLE7_ERROR = -1
 
} angle7_return_value_t;
 
void angle7_cfg_setup ( angle7_cfg_t *cfg );
 
err_t angle7_init ( angle7_t *ctx, angle7_cfg_t *cfg );
 
err_t angle7_default_cfg ( angle7_t *ctx );
 
err_t angle7_generic_write ( angle7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t angle7_generic_read ( angle7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t angle7_write_two_bytes ( angle7_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t angle7_read_two_bytes ( angle7_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t angle7_read_an_pin_value ( angle7_t *ctx, uint16_t *data_out );
 
err_t angle7_read_an_pin_voltage ( angle7_t *ctx, float *data_out );
 
uint8_t angle7_get_int_pin ( angle7_t *ctx );
 
void angle7_enable_device ( angle7_t *ctx );
 
void angle7_disable_device ( angle7_t *ctx );
 
err_t angle7_set_start_position ( angle7_t *ctx, float angle );
 
err_t angle7_get_start_position ( angle7_t *ctx, float *angle );
 
err_t angle7_set_stop_position ( angle7_t *ctx, float angle );
 
err_t angle7_get_stop_position ( angle7_t *ctx, float *angle );
 
err_t angle7_get_raw_angle ( angle7_t *ctx, float *angle );
 
err_t angle7_get_angle ( angle7_t *ctx, float *angle );
 
err_t angle7_get_status ( angle7_t *ctx, uint8_t *status );
 
err_t angle7_get_agc ( angle7_t *ctx, uint8_t *agc );
 
err_t angle7_get_magnitude ( angle7_t *ctx, uint16_t *magnitude );
 
#ifdef __cplusplus
}
#endif
#endif // ANGLE7_H
 
 // angle7
 
// ------------------------------------------------------------------------ END