compass7.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 COMPASS7_H
#define COMPASS7_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 COMPASS7_REG_XOUT0                  0x00
#define COMPASS7_REG_XOUT1                  0x01
#define COMPASS7_REG_YOUT0                  0x02
#define COMPASS7_REG_YOUT1                  0x03
#define COMPASS7_REG_ZOUT0                  0x04
#define COMPASS7_REG_ZOUT1                  0x05
#define COMPASS7_REG_XOUT2                  0x06
#define COMPASS7_REG_YOUT2                  0x07
#define COMPASS7_REG_ZOUT2                  0x08
#define COMPASS7_REG_TOUT                   0x09
#define COMPASS7_REG_TPH0                   0x0A
#define COMPASS7_REG_TPH1                   0x0B
#define COMPASS7_REG_TU                     0x0C
#define COMPASS7_REG_STATUS1                0x18
#define COMPASS7_REG_STATUS0                0x19
#define COMPASS7_REG_ODR                    0x1A
#define COMPASS7_REG_CONTROL0               0x1B
#define COMPASS7_REG_CONTROL1               0x1C
#define COMPASS7_REG_CONTROL2               0x1D
#define COMPASS7_REG_ST_X_TH                0x1E
#define COMPASS7_REG_ST_Y_TH                0x1F
#define COMPASS7_REG_ST_Z_TH                0x20
#define COMPASS7_REG_ST_X                   0x27
#define COMPASS7_REG_ST_Y                   0x28
#define COMPASS7_REG_ST_Z                   0x29
#define COMPASS7_REG_PRODUCT_ID             0x39
 
 // compass7_reg
 
#define COMPASS7_STATUS1_MEAS_T_DONE        0x80
#define COMPASS7_STATUS1_MEAS_M_DONE        0x40
#define COMPASS7_STATUS1_SAT_SENSOR         0x20
#define COMPASS7_STATUS1_OTP_READ_DONE      0x10
#define COMPASS7_STATUS1_ST_FAIL            0x08
#define COMPASS7_STATUS1_MDT_FLAG_INT       0x04
#define COMPASS7_STATUS1_MEAS_T_DONE_INT    0x02
#define COMPASS7_STATUS1_MEAS_M_DONE_INT    0x01
 
#define COMPASS7_CONTROL0_CMM_FREQ_EN       0x80
#define COMPASS7_CONTROL0_AUTO_ST_EN        0x40
#define COMPASS7_CONTROL0_AUTO_SR_EN        0x20
#define COMPASS7_CONTROL0_DO_RESET          0x10
#define COMPASS7_CONTROL0_DO_SET            0x08
#define COMPASS7_CONTROL0_START_MDT         0x04
#define COMPASS7_CONTROL0_TAKE_MEAS_T       0x02
#define COMPASS7_CONTROL0_TAKE_MEAS_M       0x01
 
#define COMPASS7_CONTROL1_SW_RESET          0x80
#define COMPASS7_CONTROL1_ST_ENM            0x40
#define COMPASS7_CONTROL1_ST_ENP            0x20
#define COMPASS7_CONTROL1_Z_INHIBIT         0x10
#define COMPASS7_CONTROL1_Y_INHIBIT         0x08
#define COMPASS7_CONTROL1_X_INHIBIT         0x04
#define COMPASS7_CONTROL1_BW_6p6MS          0x00
#define COMPASS7_CONTROL1_BW_3p5MS          0x01
#define COMPASS7_CONTROL1_BW_2p0MS          0x02
#define COMPASS7_CONTROL1_BW_1p2MS          0x03
#define COMPASS7_CONTROL1_BW_BIT_MASK       0x03
 
#define COMPASS7_CONTROL2_HPOWER            0x80
#define COMPASS7_CONTROL2_INT_MEAS_DONE_EN  0x40
#define COMPASS7_CONTROL2_INT_MDT_EN        0x20
#define COMPASS7_CONTROL2_CMM_EN            0x10
#define COMPASS7_CONTROL2_EN_PRD_SET        0x08
#define COMPASS7_CONTROL2_PRD_SET_1_SMPL    0x00
#define COMPASS7_CONTROL2_PRD_SET_25_SMPL   0x01
#define COMPASS7_CONTROL2_PRD_SET_75_SMPL   0x02
#define COMPASS7_CONTROL2_PRD_SET_100_SMPL  0x03
#define COMPASS7_CONTROL2_PRD_SET_250_SMPL  0x04
#define COMPASS7_CONTROL2_PRD_SET_500_SMPL  0x05
#define COMPASS7_CONTROL2_PRD_SET_1000_SMPL 0x06
#define COMPASS7_CONTROL2_PRD_SET_2000_SMPL 0x07
#define COMPASS7_CONTROL2_PRD_SET_BIT_MASK  0x07
 
#define COMPASS7_ODR_DISABLE                0
#define COMPASS7_ODR_1HZ                    1
#define COMPASS7_ODR_2HZ                    2
#define COMPASS7_ODR_5HZ                    5
#define COMPASS7_ODR_10HZ                   10
#define COMPASS7_ODR_25HZ                   25
#define COMPASS7_ODR_50HZ                   50
#define COMPASS7_ODR_100HZ                  100
 
#define COMPASS7_MAGNETIC_OFFSET            0x080000l
#define COMPASS7_MAGNETIC_RESOLUTION        0.0625
#define COMPASS7_MILLIGAUSS_TO_GAUSS        0.001
#define COMPASS7_TEMPERATURE_OFFSET         75
#define COMPASS7_TEMPERATURE_RESOLUTION     0.8
#define COMPASS7_TIMEOUT                    2000
 
#define COMPASS7_MEAS_SINGLE_T              0
#define COMPASS7_MEAS_SINGLE_M              1
#define COMPASS7_MEAS_CONTINUOUS_M_1HZ      2
#define COMPASS7_MEAS_CONTINUOUS_M_2HZ      3
#define COMPASS7_MEAS_CONTINUOUS_M_5HZ      4
#define COMPASS7_MEAS_CONTINUOUS_M_10HZ     5
#define COMPASS7_MEAS_CONTINUOUS_M_25HZ     6
#define COMPASS7_MEAS_CONTINUOUS_M_50HZ     7
#define COMPASS7_MEAS_CONTINUOUS_M_100HZ    8
 
#define COMPASS7_PRODUCT_ID                 0x10
 
#define COMPASS7_DEVICE_ADDRESS             0x30
 
 // compass7_set
 
#define COMPASS7_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // compass7_map
 // compass7
 
typedef struct
{
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} compass7_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
} compass7_cfg_t;
 
typedef struct
{
    float x_axis;
    float y_axis;
    float z_axis;
 
} compass7_magnetic_flux_t;
 
typedef enum
{
    COMPASS7_OK = 0,
    COMPASS7_ERROR = -1
 
} compass7_return_value_t;
 
void compass7_cfg_setup ( compass7_cfg_t *cfg );
 
err_t compass7_init ( compass7_t *ctx, compass7_cfg_t *cfg );
 
err_t compass7_default_cfg ( compass7_t *ctx );
 
err_t compass7_generic_write ( compass7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t compass7_generic_read ( compass7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t compass7_write_register ( compass7_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t compass7_read_register ( compass7_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t compass7_check_communication ( compass7_t *ctx );
 
err_t compass7_soft_reset ( compass7_t *ctx );
 
err_t compass7_set_measurement_mode ( compass7_t *ctx, uint8_t mode );
 
err_t compass7_get_magnetic_flux ( compass7_t *ctx, compass7_magnetic_flux_t *flux );
 
err_t compass7_get_temperature ( compass7_t *ctx, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // COMPASS7_H
 
 // compass7
 
// ------------------------------------------------------------------------ END