compass6.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 COMPASS6_H
#define COMPASS6_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"
 
#define COMPASS6_REG_SELFTEST_RSP       0x0C
#define COMPASS6_REG_INFO_VERSION       0x0D
#define COMPASS6_REG_INFO_ALPS          0x0E
#define COMPASS6_REG_WHO_I_AM           0x0F
#define COMPASS6_REG_OUTPUT_X_LSB       0x10
#define COMPASS6_REG_OUTPUT_X_MSB       0x11
#define COMPASS6_REG_OUTPUT_Y_LSB       0x12
#define COMPASS6_REG_OUTPUT_Y_MSB       0x13
#define COMPASS6_REG_OUTPUT_Z_LSB       0x14
#define COMPASS6_REG_OUTPUT_Z_MSB       0x15
#define COMPASS6_REG_STATUS             0x18
#define COMPASS6_REG_FIFO_PTR_STATUS    0x19
#define COMPASS6_REG_CTRL1              0x1B
#define COMPASS6_REG_CTRL2              0x1C
#define COMPASS6_REG_CTRL3              0x1D
#define COMPASS6_REG_CTRL4              0x1E
#define COMPASS6_REG_OFFSET_X_LSB       0x20
#define COMPASS6_REG_OFFSET_X_MSB       0x21
#define COMPASS6_REG_OFFSET_Y_LSB       0x22
#define COMPASS6_REG_OFFSET_Y_MSB       0x23
#define COMPASS6_REG_OFFSET_Z_LSB       0x24
#define COMPASS6_REG_OFFSET_Z_MSB       0x25
#define COMPASS6_REG_THR_L              0x26
#define COMPASS6_REG_THR_H              0x27
#define COMPASS6_REG_TEMPERATURE_VAL    0x31
 
 // compass6_reg
 
#define COMPASS6_WHO_AM_I               0x49
#define COMPASS6_VERSION                0x11
#define COMPASS6_ALPS                   0x15
 
#define COMPASS6_SET_DEV_ADDR           0x0C
 
 // compass6_set
 
#define COMPASS6_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // compass6_map
 // compass6
 
typedef struct
{
    // Input pins
    digital_in_t  rdy;      
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
} compass6_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  rdy;        
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} compass6_cfg_t;
 
typedef enum
{
   COMPASS6_OK = 0,
   COMPASS6_ERROR = -1
 
} compass6_return_value_t;
 
typedef struct
{
   int16_t x; 
   int16_t y; 
   int16_t z; 
} compass6_axes_t;
 
void compass6_cfg_setup ( compass6_cfg_t *cfg );
 
err_t compass6_init ( compass6_t *ctx, compass6_cfg_t *cfg );
 
err_t compass6_default_cfg ( compass6_t *ctx );
 
err_t compass6_generic_write ( compass6_t *ctx, uint8_t reg, uint8_t tx_data );
 
err_t compass6_generic_read ( compass6_t *ctx, uint8_t reg, uint8_t *rx_data );
 
uint8_t compass6_data_ready ( compass6_t *ctx );
 
err_t compass6_get_axes_data ( compass6_t *ctx, compass6_axes_t *axes_data );
 
#ifdef __cplusplus
}
#endif
#endif // COMPASS6_H
 
 // compass6
 
// ------------------------------------------------------------------------ END