accel17.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 ACCEL17_H
#define ACCEL17_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 ACCEL17_REG_ACCEL_CONFIG    0x00
#define ACCEL17_REG_ACCEL_X_MSB     0x01
#define ACCEL17_REG_ACCEL_X_LSB     0x02
#define ACCEL17_REG_ACCEL_Y_MSB     0x03
#define ACCEL17_REG_ACCEL_Y_LSB     0x04
 
 // accel17_reg
 
#define ACCEL17_TOEN_MASK           0x08      // Temperature Out Status
#define ACCEL17_TOEN_DISABLE        0x00      // Temperature Out Disable
#define ACCEL17_TOEN_ENABLE         0x08      // Temperature Out Enable
#define ACCEL17_BGTST_MASK          0x04      // BandGap Test Status
#define ACCEL17_BGTST_NORMAL        0x00      // Normal Test
#define ACCEL17_BGTST_BANDGAP       0x04      // Bandga Test
#define ACCEL17_ST_MASK             0x02      // Self Test Status
#define ACCEL17_ST_OFF              0x00      // Self Test Off
#define ACCEL17_ST_ON               0x02      // Self Test On
#define ACCEL17_PD_MASK             0x01      // Power Status
#define ACCEL17_PD_ON               0x00      // Power On
#define ACCEL17_PD_DOWN             0x01      // Power Down
 
#define ACCEL17_OFFSET              2048
#define ACCEL17_SENSITIVITY         512.0
#define ACCEL17_DEGREE_RES          90
 
#define ACCEL17_SET_DEV_ADDR        0x10
 
 // accel17_set
 
#define ACCEL17_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // accel17_map
 // accel17
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                                
    // I2C slave address
    uint8_t slave_address;                           
} accel17_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} accel17_cfg_t;
 
typedef struct
{
   float x; 
   float y; 
} accel17_axes_t;
 
typedef enum
{
   ACCEL17_OK = 0,
   ACCEL17_ERROR = -1
 
} accel17_return_value_t;
 
void accel17_cfg_setup ( accel17_cfg_t *cfg );
 
err_t accel17_init ( accel17_t *ctx, accel17_cfg_t *cfg );
 
err_t accel17_default_cfg ( accel17_t *ctx );
 
err_t accel17_generic_write ( accel17_t *ctx, uint8_t reg, uint8_t tx_data );
 
err_t accel17_generic_read ( accel17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t accel17_get_axes_data ( accel17_t *ctx, accel17_axes_t *axes );
 
#ifdef __cplusplus
}
#endif
#endif // ACCEL17_H
 
 // accel17
 
// ------------------------------------------------------------------------ END