magneto11.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 MAGNETO11_H
#define MAGNETO11_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 MAGNETO11_REG_DATA_LSB              0x00
#define MAGNETO11_REG_DATA_MSB              0x01
#define MAGNETO11_REG_CONFIG                0x02
#define MAGNETO11_REG_OFFSET_LSB            0x03
#define MAGNETO11_REG_OFFSET_MSB            0x04
#define MAGNETO11_REG_SENSITIVITY           0x0B
 
 // magneto11_reg
 
#define MAGNETO11_DATA_RESOLUTION           0x03FF
#define MAGNETO11_DATA_OCF_MASK             0x0800
#define MAGNETO11_DATA_PARITY_MASK          0x0400
 
#define MAGNETO11_SENSITIVITY_RES_50mT      0x00
#define MAGNETO11_SENSITIVITY_RES_25mT      0x01
#define MAGNETO11_SENSITIVITY_RES_12p5mT    0x02
#define MAGNETO11_SENSITIVITY_RES_18p75mT   0x03
#define MAGNETO11_SENSITIVITY_RES_MASK      0x03
#define MAGNETO11_SENSITIVITY_LSB_50mT      0.09766
#define MAGNETO11_SENSITIVITY_LSB_25mT      0.04883
#define MAGNETO11_SENSITIVITY_LSB_12p5mT    0.02441
#define MAGNETO11_SENSITIVITY_LSB_18p75mT   0.03662
 
#define MAGNETO11_CONFIG_SPEED_FAST         0x00
#define MAGNETO11_CONFIG_SPEED_SLOW         0x04
#define MAGNETO11_CONFIG_POLARITY_NORMAL    0x00
#define MAGNETO11_CONFIG_POLARITY_REVERSED  0x02
#define MAGNETO11_CONFIG_OP_NORMAL          0x00
#define MAGNETO11_CONFIG_OP_POWER_DOWN      0x01
 
#define MAGNETO11_DEV_ADDR_GND              0x56
#define MAGNETO11_DEV_ADDR_VCC              0x57
 
 // magneto11_set
 
#define MAGNETO11_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // magneto11_map
 // magneto11
 
typedef struct
{
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} magneto11_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
} magneto11_cfg_t;
 
typedef enum
{
    MAGNETO11_OK = 0,
    MAGNETO11_ERROR = -1
 
} magneto11_return_value_t;
 
void magneto11_cfg_setup ( magneto11_cfg_t *cfg );
 
err_t magneto11_init ( magneto11_t *ctx, magneto11_cfg_t *cfg );
 
err_t magneto11_default_cfg ( magneto11_t *ctx );
 
err_t magneto11_generic_write ( magneto11_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t magneto11_generic_read ( magneto11_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t magneto11_get_magnetic_field ( magneto11_t *ctx, float *mag_field );
 
err_t magneto11_get_offset ( magneto11_t *ctx, uint16_t *offset );
 
err_t magneto11_set_config ( magneto11_t *ctx, uint8_t config );
 
err_t magneto11_set_sensitivity ( magneto11_t *ctx, uint8_t sensitivity );
 
#ifdef __cplusplus
}
#endif
#endif // MAGNETO11_H
 
 // magneto11
 
// ------------------------------------------------------------------------ END