magneto10.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 MAGNETO10_H
#define MAGNETO10_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 MAGNETO10_REG_STAT1             0x00
#define MAGNETO10_REG_X_LSB             0x01
#define MAGNETO10_REG_X_MSB             0x02
#define MAGNETO10_REG_Y_LSB             0x03
#define MAGNETO10_REG_Y_MSB             0x04
#define MAGNETO10_REG_Z_LSB             0x05
#define MAGNETO10_REG_Z_MSB             0x06
#define MAGNETO10_REG_STAT2             0x07
#define MAGNETO10_REG_T_LSB             0x08
#define MAGNETO10_REG_T_MSB             0x09
#define MAGNETO10_REG_CID               0x0A
#define MAGNETO10_REG_DID               0x0B
#define MAGNETO10_REG_CTRL              0x10
#define MAGNETO10_REG_RST               0x11
#define MAGNETO10_REG_OSR_DIG_FILT      0x14
#define MAGNETO10_REG_T_EN_DIG_FILT_Z   0x15
 
 // magneto10_reg
 
#define MAGNETO10_MODE_IDLE             0x00
#define MAGNETO10_MODE_SINGLE_MEAS      0x01
#define MAGNETO10_MODE_CONT_MEAS_10HZ   0x02
#define MAGNETO10_MODE_CONT_MEAS_20HZ   0x03
#define MAGNETO10_MODE_CONT_MEAS_50HZ   0x04
#define MAGNETO10_MODE_CONT_MEAS_100HZ  0x05
#define MAGNETO10_MODE_SELF_TEST        0x06
#define MAGNETO10_MODE_CONT_MEAS_200HZ  0x0A
#define MAGNETO10_MODE_CONT_MEAS_500HZ  0x0B
#define MAGNETO10_MODE_CONT_MEAS_800HZ  0x0C
#define MAGNETO10_MODE_CONT_MEAS_1400HZ 0x0D
#define MAGNETO10_MODE_POWER_DOWN       0x0F
 
#define MAGNETO10_COMPANY_ID            0x98
#define MAGNETO10_DEVICE_ID             0xBA
 
#define MAGNETO10_RESET                 0x06
 
#define MAGNETO10_STAT1_RT              0x08
#define MAGNETO10_STAT1_DRDY            0x01
#define MAGNETO10_STAT2_DOR             0x02
#define MAGNETO10_STAT2_HOVF            0x01
 
#define MAGNETO10_TEMPERATURE_RES       50.0
#define MAGNETO10_TEMPERATURE_ENABLE    0x01
#define MAGNETO10_TEMPERATURE_DISABLE   0x00
#define MAGNETO10_TEMPERATURE_EN_MASK   0x20
 
#define MAGNETO10_MAG_FLUX_RESOLUTION   0.15 
 
#define MAGNETO10_SET_DEV_ADDR          0x0C
 
 // magneto10_set
 
#define MAGNETO10_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // magneto10_map
 // magneto10
 
typedef struct
{
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} magneto10_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} magneto10_cfg_t;
 
typedef enum
{
    MAGNETO10_OK = 0,
    MAGNETO10_ERROR = -1
 
} magneto10_return_value_t;
 
void magneto10_cfg_setup ( magneto10_cfg_t *cfg );
 
err_t magneto10_init ( magneto10_t *ctx, magneto10_cfg_t *cfg );
 
err_t magneto10_default_cfg ( magneto10_t *ctx );
 
err_t magneto10_mem_write_single ( magneto10_t *ctx, uint8_t reg, uint8_t tx_data );
 
err_t magneto10_mem_write_multiple ( magneto10_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t magneto10_mem_direct_read ( magneto10_t *ctx, uint8_t *rx_buf, uint8_t rx_len );
 
err_t magneto10_mem_read ( magneto10_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t magneto10_check_communication ( magneto10_t *ctx );
 
err_t magneto10_check_data_ready ( magneto10_t *ctx );
 
err_t magneto10_get_magnetic_flux ( magneto10_t *ctx, float *x_axis, float *y_axis, float *z_axis );
 
err_t magneto10_get_temperature ( magneto10_t *ctx, float *temperature );
 
err_t magneto10_reset ( magneto10_t *ctx );
 
err_t magneto10_set_operating_mode ( magneto10_t *ctx, uint8_t mode );
 
err_t magneto10_enable_temperature_sensor ( magneto10_t *ctx, uint8_t enable );
 
#ifdef __cplusplus
}
#endif
#endif // MAGNETO10_H
 
 // magneto10
 
// ------------------------------------------------------------------------ END