inclinometer.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 INCLINOMETER_H
#define INCLINOMETER_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_spi_master.h"
 
#define INCLINOMETER_REG_ACC_X              0x01
#define INCLINOMETER_REG_ACC_Y              0x02
#define INCLINOMETER_REG_ACC_Z              0x03
#define INCLINOMETER_REG_STO                0x04
#define INCLINOMETER_REG_TEMP               0x05
#define INCLINOMETER_REG_STATUS             0x06
#define INCLINOMETER_REG_ERR_FLAG1          0x07
#define INCLINOMETER_REG_ERR_FLAG2          0x08
#define INCLINOMETER_REG_ANG_X              0x09
#define INCLINOMETER_REG_ANG_Y              0x0A
#define INCLINOMETER_REG_ANG_Z              0x0B
#define INCLINOMETER_REG_ANG_CTRL           0x0C
#define INCLINOMETER_REG_MODE               0x0D
#define INCLINOMETER_REG_WHOAMI             0x10
#define INCLINOMETER_REG_SERIAL1            0x19
#define INCLINOMETER_REG_SERIAL2            0x1A
#define INCLINOMETER_REG_SELBANK            0x1F
 
 // inclinometer_reg
 
#define INCLINOMETER_CMD_READ_ACC_X         0x040000F7
#define INCLINOMETER_CMD_READ_ACC_Y         0x080000FD
#define INCLINOMETER_CMD_READ_ACC_Z         0x0C0000FB
#define INCLINOMETER_CMD_READ_STO           0x100000E9
#define INCLINOMETER_CMD_EN_ANGLE_OUT       0xB0001F6F
#define INCLINOMETER_CMD_READ_ANG_X         0x240000C7
#define INCLINOMETER_CMD_READ_ANG_Y         0x280000CD
#define INCLINOMETER_CMD_READ_ANG_Z         0x2C0000CB
#define INCLINOMETER_CMD_READ_TEMP          0x140000EF
#define INCLINOMETER_CMD_READ_STATUS        0x180000E5
#define INCLINOMETER_CMD_READ_ERR_FLAG1     0x1C0000E3
#define INCLINOMETER_CMD_READ_ERR_FLAG2     0x200000C1
#define INCLINOMETER_CMD_READ_MODE          0x340000DF
#define INCLINOMETER_CMD_CHANGE_TO_MODE1    0xB400001F
#define INCLINOMETER_CMD_CHANGE_TO_MODE2    0xB4000102
#define INCLINOMETER_CMD_CHANGE_TO_MODE3    0xB4000225
#define INCLINOMETER_CMD_CHANGE_TO_MODE4    0xB4000338
#define INCLINOMETER_CMD_POWER_DOWN         0xB400046B
#define INCLINOMETER_CMD_WAKE_UP            0xB400001F
#define INCLINOMETER_CMD_SW_RESET           0xB4002098
#define INCLINOMETER_CMD_READ_WHOAMI        0x40000091
#define INCLINOMETER_CMD_READ_SERIAL1       0x640000A7
#define INCLINOMETER_CMD_READ_SERIAL2       0x680000AD
#define INCLINOMETER_CMD_READ_CURRENT_BANK  0x7C0000B3
#define INCLINOMETER_CMD_SWITCH_TO_BANK0    0xFC000073
#define INCLINOMETER_CMD_SWITCH_TO_BANK1    0xFC00016E
 
 // inclinometer_cmd
 
#define INCLINOMETER_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); 
 
 // inclinometer_map
 // inclinometer
 
typedef struct
{
    // Modules
    spi_master_t  spi;          
    pin_name_t  chip_select;    
    uint8_t rs;                 
    float resolution;           
} inclinometer_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;   
    pin_name_t  mosi;   
    pin_name_t  sck;    
    pin_name_t  cs;     
    // static variable
    uint32_t                           spi_speed;   
    spi_master_mode_t                  spi_mode;    
    spi_master_chip_select_polarity_t  cs_polarity; 
} inclinometer_cfg_t;
 
typedef struct
{
    float x;    
    float y;    
    float z;    
} inclinometer_accel_t;
 
typedef enum
{
   INCLINOMETER_OK = 0,
   INCLINOMETER_ERROR = -1,
   INCLINOMETER_CRC_ERROR = -2
 
} inclinometer_return_value_t;
 
void inclinometer_cfg_setup ( inclinometer_cfg_t *cfg );
 
err_t inclinometer_init ( inclinometer_t *ctx, inclinometer_cfg_t *cfg );
 
err_t inclinometer_default_cfg ( inclinometer_t *ctx );
 
err_t inclinometer_generic_write ( inclinometer_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t inclinometer_generic_read ( inclinometer_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t inclinometer_cmd_write ( inclinometer_t *ctx, uint32_t cmd );
 
err_t inclinometer_cmd_read ( inclinometer_t *ctx, uint32_t cmd, uint16_t *cmd_data );
 
err_t inclinometer_get_temperature ( inclinometer_t *ctx, float *temperature );
 
err_t inclinometer_get_axes ( inclinometer_t *ctx, inclinometer_accel_t *axes_data );
 
err_t inclinometer_get_angle ( inclinometer_t *ctx, inclinometer_accel_t *angle_data );
 
#ifdef __cplusplus
}
#endif
#endif // INCLINOMETER_H
 
 // inclinometer
 
// ------------------------------------------------------------------------ END