accel29.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 ACCEL29_H
#define ACCEL29_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_spi_master.h"
#include "spi_specifics.h"
 
#define ACCEL29_REG_DEVID                   0x00
#define ACCEL29_REG_OFSX                    0x1E
#define ACCEL29_REG_OFSY                    0x1F
#define ACCEL29_REG_OFSZ                    0x20
#define ACCEL29_REG_THRESH_ACT              0x24
#define ACCEL29_REG_THRESH_INACT            0x25
#define ACCEL29_REG_TIME_INACT              0x26
#define ACCEL29_REG_ACT_INACT_CTL           0x27
#define ACCEL29_REG_BW_RATE                 0x2C
#define ACCEL29_REG_POWER_CTL               0x2D
#define ACCEL29_REG_INT_ENABLE              0x2E
#define ACCEL29_REG_INT_MAP                 0x2F
#define ACCEL29_REG_INT_SOURCE              0x30
#define ACCEL29_REG_DATA_FORMAT             0x31
#define ACCEL29_REG_DATA_X0                 0x32
#define ACCEL29_REG_DATA_X1                 0x33
#define ACCEL29_REG_DATA_Y0                 0x34
#define ACCEL29_REG_DATA_Y1                 0x35
#define ACCEL29_REG_DATA_Z0                 0x36
#define ACCEL29_REG_DATA_Z1                 0x37
#define ACCEL29_REG_FIFO_CTL                0x38
#define ACCEL29_REG_FIFO_STATUS             0x39
 
 // accel29_reg
 
#define ACCEL29_INT_ENABLE_DATA_READY       0x80
#define ACCEL29_INT_ENABLE_ACTIVITY         0x10
#define ACCEL29_INT_ENABLE_INACTIVITY       0x08
#define ACCEL29_INT_ENABLE_OVERRUN          0x01
 
#define ACCEL29_INT_MAP_DATA_READY_INT2     0x80
#define ACCEL29_INT_MAP_DATA_READY_INT1     0x00
#define ACCEL29_INT_MAP_DATA_READY_MASK     0x80
#define ACCEL29_INT_MAP_ACTIVITY_INT2       0x10
#define ACCEL29_INT_MAP_ACTIVITY_INT1       0x00
#define ACCEL29_INT_MAP_ACTIVITY_MASK       0x10
#define ACCEL29_INT_MAP_INACTIVITY_INT2     0x08
#define ACCEL29_INT_MAP_INACTIVITY_INT1     0x00
#define ACCEL29_INT_MAP_INACTIVITY_MASK     0x08
#define ACCEL29_INT_MAP_OVERRUN_INT2        0x01
#define ACCEL29_INT_MAP_OVERRUN_INT1        0x00
#define ACCEL29_INT_MAP_OVERRUN_MASK        0x01
 
#define ACCEL29_INT_SOURCE_DATA_READY       0x80
#define ACCEL29_INT_SOURCE_ACTIVITY         0x10
#define ACCEL29_INT_SOURCE_INACTIVITY       0x08
#define ACCEL29_INT_SOURCE_OVERRUN          0x01
 
#define ACCEL29_BW_RATE_LOW_POWER           0x10
#define ACCEL29_BW_RATE_6_25_HZ             0x06
#define ACCEL29_BW_RATE_12_5_HZ             0x07
#define ACCEL29_BW_RATE_25_HZ               0x08
#define ACCEL29_BW_RATE_50_HZ               0x09
#define ACCEL29_BW_RATE_100_HZ              0x0A
#define ACCEL29_BW_RATE_200_HZ              0x0B
#define ACCEL29_BW_RATE_400_HZ              0x0C
#define ACCEL29_BW_RATE_800_HZ              0x0D
#define ACCEL29_BW_RATE_1600_HZ             0x0E
#define ACCEL29_BW_RATE_3200_HZ             0x0F
 
#define ACCEL29_POWER_CTL_LINK              0x20
#define ACCEL29_POWER_CTL_AUTO_SLEEP        0x10
#define ACCEL29_POWER_CTL_MEASURE           0x08
#define ACCEL29_POWER_CTL_SLEEP             0x04
#define ACCEL29_POWER_CTL_WAKEUP_8_HZ       0x00
#define ACCEL29_POWER_CTL_WAKEUP_4_HZ       0x01
#define ACCEL29_POWER_CTL_WAKEUP_2_HZ       0x02
#define ACCEL29_POWER_CTL_WAKEUP_1_HZ       0x03
#define ACCEL29_POWER_CTL_WAKEUP_MASK       0x03
 
#define ACCEL29_DEVID                       0xE5
 
#define ACCEL29_OFS_RESET                   0
#define ACCEL29_OFS_SCALE_FACTOR_G_PER_LSB  0.195f
 
#define ACCEL29_SCALE_FACTOR_LSB_PER_G      20.48f
 
#define ACCEL29_NUM_OF_SAMPLES              100
 
#define ACCEL29_SPI_RW_BIT                  0x80
#define ACCEL29_SPI_MB_BIT                  0x40
#define ACCEL29_ADDRESS_MASK                0x3F
 
#define ACCEL29_DEVICE_ADDRESS_0            0x53
#define ACCEL29_DEVICE_ADDRESS_1            0x1D
 
#define ACCEL29_SET_DATA_SAMPLE_EDGE        SET_SPI_DATA_SAMPLE_EDGE
#define ACCEL29_SET_DATA_SAMPLE_MIDDLE      SET_SPI_DATA_SAMPLE_MIDDLE
 
 // accel29_set
 
#define ACCEL29_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    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.int1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.int2 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // accel29_map
 // accel29
 
typedef enum
{
    ACCEL29_DRV_SEL_SPI,                
    ACCEL29_DRV_SEL_I2C                 
} accel29_drv_t;
 
typedef err_t ( *accel29_master_io_t )( struct accel29_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct accel29_s
{
    digital_in_t int1;                  
    digital_in_t int2;                  
    i2c_master_t i2c;                   
    spi_master_t spi;                   
    uint8_t      slave_address;         
    pin_name_t   chip_select;           
    accel29_drv_t drv_sel;              
    accel29_master_io_t write_f;        
    accel29_master_io_t read_f;         
} accel29_t;
 
typedef struct
{
    pin_name_t scl;                     
    pin_name_t sda;                     
    pin_name_t miso;                    
    pin_name_t mosi;                    
    pin_name_t sck;                     
    pin_name_t cs;                      
    pin_name_t int1;                    
    pin_name_t int2;                    
    uint32_t   i2c_speed;               
    uint8_t    i2c_address;             
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
    accel29_drv_t drv_sel;              
} accel29_cfg_t;
 
typedef struct
{
    float x;                        
    float y;                        
    float z;                        
} accel29_axes_t;
 
typedef enum
{
    ACCEL29_OK = 0,
    ACCEL29_ERROR = -1
 
} accel29_return_value_t;
 
void accel29_cfg_setup ( accel29_cfg_t *cfg );
 
void accel29_drv_interface_selection ( accel29_cfg_t *cfg, accel29_drv_t drv_sel );
 
err_t accel29_init ( accel29_t *ctx, accel29_cfg_t *cfg );
 
err_t accel29_default_cfg ( accel29_t *ctx );
 
err_t accel29_generic_write ( accel29_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t accel29_generic_read ( accel29_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t accel29_write_register ( accel29_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t accel29_read_register ( accel29_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t accel29_check_communication ( accel29_t *ctx );
 
uint8_t accel29_get_int1_pin ( accel29_t *ctx );
 
uint8_t accel29_get_int2_pin ( accel29_t *ctx );
 
err_t accel29_get_axes ( accel29_t *ctx, accel29_axes_t *axes );
 
err_t accel29_get_avg_axes ( accel29_t *ctx, uint16_t num_samples, accel29_axes_t *avg_axes );
 
err_t accel29_calibrate_offset ( accel29_t *ctx, accel29_axes_t calib_axes );
 
#ifdef __cplusplus
}
#endif
#endif // ACCEL29_H
 
 // accel29
 
// ------------------------------------------------------------------------ END