angle.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 ANGLE_H
#define ANGLE_H
 
#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"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define ANGLE_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); 
 
#define ANGLE_RETVAL  uint8_t
 
#define ANGLE_OK           0x00
#define ANGLE_INIT_ERROR   0xFF
#define ANGLE_ERROR_REG_MASK              0x34 
#define ANGLE_EXTENDED_ERROR_REG_MASK     0x36 
#define ANGLE_EXTENDED_ERROR_REG          0x26 
#define ANGLE_ERROR_REG                   0x24 
#define ANGLE_STATUS_REG                  0x22 
#define ANGLE_SETTINGS_REG                0x1E 
#define ANGLE_CDS_NO_CHANGLE              0x0000 << 13
#define ANGLE_CDS_IDLE_MODE               0x0002 << 13
#define ANGLE_CDS_RUN_MODE                0x0003 << 13
#define ANGLE_HDR_RESET_0                 0x0000 << 12
#define ANGLE_HDR_RESET_1                 0x0001 << 12
#define ANGLE_SFR_RESET_0                 0x0000 << 11
#define ANGLE_SFR_RESET_1                 0x0001 << 11
#define ANGLE_CSR_STA_0                   0x0000 << 9
#define ANGLE_CSR_STA_1                   0x0001 << 9
#define ANGLE_CXE_0                       0x0000 << 8
#define ANGLE_CXE_1                       0x0001 << 8
 #define ANGLE_CER_0                      0x0000 << 7
 #define ANGLE_CER_1                      0x0001 << 7
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
 
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} angle_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} angle_cfg_t;
 
 // End types group
 
#ifdef __cplusplus
extern "C"{
#endif
 
void angle_cfg_setup ( angle_cfg_t *cfg );
 
ANGLE_RETVAL angle_init ( angle_t *ctx, angle_cfg_t *cfg );
 
void angle_default_cfg ( angle_t *ctx );
 
void angle_generic_write ( angle_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void angle_generic_read ( angle_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint16_t angle_get_angle ( angle_t *ctx );
 
uint16_t angle_get_temperature ( angle_t *ctx );
 
uint16_t angle_get_magnetics ( angle_t *ctx );
 
uint16_t angle_get_status( angle_t *ctx, uint8_t reg );
 
void angle_set_config ( angle_t *ctx, uint16_t set_value );
 
#ifdef __cplusplus
}
#endif
#endif  // _ANGLE_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END