magaccel.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 MAGACCEL_H
#define MAGACCEL_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 MAGACCEL_REG_INT_STATUS           0x00
#define MAGACCEL_REG_TEMP_OUT             0x01
#define MAGACCEL_REG_VECM_LSB             0x02
#define MAGACCEL_REG_VECM_MSB             0x03
#define MAGACCEL_REG_OUT_X_LSB            0x04
#define MAGACCEL_REG_OUT_X_MSB            0x05
#define MAGACCEL_REG_OUT_Y_LSB            0x06
#define MAGACCEL_REG_OUT_Y_MSB            0x07
#define MAGACCEL_REG_OUT_Z_LSB            0x08
#define MAGACCEL_REG_OUT_Z_MSB            0x09
#define MAGACCEL_REG_BUF_STATUS           0x0B
#define MAGACCEL_REG_BUF_X_LSB            0x0C
#define MAGACCEL_REG_BUF_X_MSB            0x0D
#define MAGACCEL_REG_BUF_Y_LSB            0x0E
#define MAGACCEL_REG_BUF_Y_MSB            0x0F
#define MAGACCEL_REG_BUF_Z_LSB            0x10
#define MAGACCEL_REG_BUF_Z_MSB            0x11
#define MAGACCEL_REG_PROD_REV             0x12
#define MAGACCEL_REG_WHO_AM_I             0x13
#define MAGACCEL_REG_SYS_MODE             0x14
#define MAGACCEL_REG_SENS_CONFIG1         0x15
#define MAGACCEL_REG_SENS_CONFIG2         0x16
#define MAGACCEL_REG_SENS_CONFIG3         0x17
#define MAGACCEL_REG_SENS_CONFIG4         0x18
#define MAGACCEL_REG_SENS_CONFIG5         0x19
#define MAGACCEL_REG_WAKE_IDLE_LSB        0x1A
#define MAGACCEL_REG_WAKE_IDLE_MSB        0x1B
#define MAGACCEL_REG_SLEEP_IDLE_LSB       0x1C
#define MAGACCEL_REG_SLEEP_IDLE_MSB       0x1D
#define MAGACCEL_REG_ASLP_COUNT_LSB       0x1E
#define MAGACCEL_REG_ASLP_COUNT_MSB       0x1F
#define MAGACCEL_REG_INT_EN               0x20
#define MAGACCEL_REG_INT_PIN_SEL          0x21
#define MAGACCEL_REG_OFF_X                0x22
#define MAGACCEL_REG_OFF_Y                0x23
#define MAGACCEL_REG_OFF_Z                0x24
#define MAGACCEL_REG_BUF_CONFIG1          0x26
#define MAGACCEL_REG_BUF_CONFIG2          0x27
#define MAGACCEL_REG_ORIENT_STATUS        0x28
#define MAGACCEL_REG_ORIENT_CONFIG        0x29
#define MAGACCEL_REG_ORIENT_DBCOUNT       0x2A
#define MAGACCEL_REG_ORIENT_BF_ZCOMP      0x2B
#define MAGACCEL_REG_ORIENT_THS_REG       0x2C
#define MAGACCEL_REG_SDCD_INT_SRC1        0x2D
#define MAGACCEL_REG_SDCD_INT_SRC2        0x2E
#define MAGACCEL_REG_SDCD_CONFIG1         0x2F
#define MAGACCEL_REG_SDCD_CONFIG2         0x30
#define MAGACCEL_REG_SDCD_OT_DBCNT        0x31
#define MAGACCEL_REG_SDCD_WT_DBCNT        0x32
#define MAGACCEL_REG_SDCD_LTHS_LSB        0x33
#define MAGACCEL_REG_SDCD_LTHS_MSB        0x34
#define MAGACCEL_REG_SDCD_UTHS_LSB        0x35
#define MAGACCEL_REG_SDCD_UTHS_MSB        0x36
#define MAGACCEL_REG_SELF_TEST_CONFIG1    0x37
#define MAGACCEL_REG_SELF_TEST_CONFIG2    0x38
 
 // magaccel_reg
 
#define MAGACCEL_SRC_BOOT_COMPLETED       0x01
 
#define MAGACCEL_DEVICE_ID_VAL            0x86
 
#define MAGACCEL_SW_RESET_BIT_MASK        0x80
 
#define MAGACCEL_OP_MODE_STANDBY          0x00
#define MAGACCEL_OP_MODE_ACTIVE           0x01
#define MAGACCEL_OP_MODE_BIT_MASK         0xFE
 
#define MAGACCEL_FSR_SEL_2G               0x00
#define MAGACCEL_FSR_SEL_4G               0x01
#define MAGACCEL_FSR_SEL_8G               0x02
#define MAGACCEL_FSR_SEL_16G              0x03
#define MAGACCEL_FSR_SEL_BIT_MASK         0xF9
 
#define MAGACCEL_INT_EN_DRDY_DIS          0x00
#define MAGACCEL_INT_EN_DRDY_EN           0x80
 
#define MAGACCEL_DATA_READY               0
#define MAGACCEL_DET_MAG_FIELD            0
 
#define MAGACCEL_FSR_SENS_VAL_2G          0.98f
#define MAGACCEL_FSR_SENS_VAL_4G          1.95f
#define MAGACCEL_FSR_SENS_VAL_8G          3.91f
#define MAGACCEL_FSR_SENS_VAL_16G         7.81f
 
 
#define MAGACCEL_DEVICE_ADDRESS           0x18
 
 // magaccel_set
 
#define MAGACCEL_MAP_MIKROBUS( cfg, mikrobus )    \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.fld = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.mot = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // magaccel_map
 // magaccel
 
typedef struct
{
    // Input pins
    digital_in_t fld;    
    digital_in_t mot;    
    // Modules
    i2c_master_t i2c;    
    // I2C slave address
    uint8_t slave_address;  
    // Sensitivity
    float sensitivity;       
} magaccel_t;
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    pin_name_t fld;    
    pin_name_t mot;    
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} magaccel_cfg_t;
 
typedef struct
{
    float x;    
    float y;    
    float z;    
} magaccel_axes_t;
 
typedef enum
{
    MAGACCEL_OK = 0,
    MAGACCEL_ERROR = -1
 
} magaccel_return_value_t;
 
void magaccel_cfg_setup ( magaccel_cfg_t *cfg );
 
err_t magaccel_init ( magaccel_t *ctx, magaccel_cfg_t *cfg );
 
err_t magaccel_default_cfg ( magaccel_t *ctx );
 
err_t magaccel_generic_write ( magaccel_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t magaccel_generic_read ( magaccel_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t magaccel_get_device_id ( magaccel_t *ctx, uint8_t *device_id );
 
err_t magaccel_get_status ( magaccel_t *ctx, uint8_t *status );
 
err_t magaccel_sw_reset ( magaccel_t *ctx );
 
err_t magaccel_set_op_mode ( magaccel_t *ctx, uint8_t op_mode );
 
err_t magaccel_set_fsr ( magaccel_t *ctx, uint8_t fsr );
 
err_t magaccel_en_data_ready ( magaccel_t *ctx );
 
err_t magaccel_get_axes_data ( magaccel_t *ctx, magaccel_axes_t *axes );
 
uint8_t magaccel_check_data_ready ( magaccel_t *ctx );
 
uint8_t magaccel_check_mag_field ( magaccel_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // MAGACCEL_H
 
 // magaccel
 
// ------------------------------------------------------------------------ END