magneto6.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 MAGNETO6_H
#define MAGNETO6_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 MAGNETO6_REG_MAGNETIC_X_MSB         0x00
#define MAGNETO6_REG_MAGNETIC_Y_MSB         0x01
#define MAGNETO6_REG_MAGNETIC_Z_MSB         0x02
#define MAGNETO6_REG_TEMPERATURE_MSB        0x03
#define MAGNETO6_REG_MAGNETIC_XY_LSB        0x04
#define MAGNETO6_REG_TEMPERATURE_Z_LSB      0x05
#define MAGNETO6_REG_DIAG                   0x06
#define MAGNETO6_REG_CONFIG                 0x10
#define MAGNETO6_REG_MOD1                   0x11
#define MAGNETO6_REG_MOD2                   0x13
#define MAGNETO6_REG_VERSION                0x16
 
 // magneto6_reg
 
#define MAGNETO6_CONFIG_DISABLE_TEMP        0x80
#define MAGNETO6_CONFIG_ENABLE_ANGULAR_XY   0x40
#define MAGNETO6_CONFIG_TRIGGER_DISABLE     0x00
#define MAGNETO6_CONFIG_TRIGGER_MSB         0x10
#define MAGNETO6_CONFIG_TRIGGER_REG_READ    0x20
#define MAGNETO6_CONFIG_TRIGGER_MASK        0x30
#define MAGNETO6_CONFIG_SHORT_RANGE_SENS_EN 0x08
#define MAGNETO6_CONFIG_TL_COMP_TC0         0x00
#define MAGNETO6_CONFIG_TL_COMP_TC1         0x02
#define MAGNETO6_CONFIG_TL_COMP_TC2         0x04
#define MAGNETO6_CONFIG_TL_COMP_TC3         0x06
#define MAGNETO6_CONFIG_TL_COMP_MASK        0x06
#define MAGNETO6_CONFIG_PARITY_BIT          0x01
 
#define MAGNETO6_MOD1_FUSE_PARITY           0x80
#define MAGNETO6_MOD1_I2C_ADDR_0            0x00
#define MAGNETO6_MOD1_I2C_ADDR_1            0x20
#define MAGNETO6_MOD1_I2C_ADDR_2            0x40
#define MAGNETO6_MOD1_I2C_ADDR_3            0x60
#define MAGNETO6_MOD1_I2C_ADDR_MASK         0x60
#define MAGNETO6_MOD1_1BYTE_READ_EN         0x10
#define MAGNETO6_MOD1_COLLISION_AVOID       0x08
#define MAGNETO6_MOD1_INT_DISABLE           0x04
#define MAGNETO6_MOD1_MODE_LOW_POWER        0x00
#define MAGNETO6_MOD1_MODE_MASTER           0x01
#define MAGNETO6_MOD1_MODE_FAST             0x03
#define MAGNETO6_MOD1_MODE_MASK             0x03
 
#define MAGNETO6_MOD2_FUPDATE_SLOW          0x80
#define MAGNETO6_MOD2_FACTORY_MASK          0x7F
 
#define MAGNETO6_DIAG_BUS_PARITY            0x80
#define MAGNETO6_DIAG_FUSE_PARITY           0x40
#define MAGNETO6_DIAG_CFG_PARITY            0x20
#define MAGNETO6_DIAG_T_BIT                 0x10
#define MAGNETO6_DIAG_PD3_FLAG              0x08
#define MAGNETO6_DIAG_PD0_FLAG              0x04
#define MAGNETO6_DIAG_FRAME_COUNTER_MASK    0x03
 
#define MAGNETO6_VERSION_FACTORY_MASK       0xC0
#define MAGNETO6_VERSION_TYPE_MASK          0x30
#define MAGNETO6_VERSION_HWV_MASK           0x0F
 
#define MAGNETO6_TEMP_25_DIGIT              1180
#define MAGNETO6_TEMP_25                    25
#define MAGNETO6_TEMP_RES                   0.24f
#define MAGNETO6_MAGNETIC_RES_MILLI_T       0.13f
 
#define MAGNETO6_I2C_TIMEOUT                100000ul
 
#define MAGNETO6_DEVICE_ADDRESS_0           0x35
#define MAGNETO6_DEVICE_ADDRESS_1           0x22
#define MAGNETO6_DEVICE_ADDRESS_2           0x78
#define MAGNETO6_DEVICE_ADDRESS_3           0x44
 
 // magneto6_set
 
#define MAGNETO6_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.ien = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // magneto6_map
 // magneto6
 
typedef struct
{
    float x_data;               
    float y_data;               
    float z_data;               
    float temperature;          
} magneto6_data_t;
 
typedef struct
{
    // Output pins
    digital_out_t ien;          
    // Input pins
    digital_in_t int_pin;       
    // Modules
    pin_name_t scl;             
    pin_name_t sda;             
    uint8_t i2c_started;        
    // I2C slave address
    uint8_t slave_address;      
} magneto6_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t ien;             
    pin_name_t int_pin;         
    uint8_t    i2c_address;     
} magneto6_cfg_t;
 
typedef enum
{
    MAGNETO6_OK = 0,
    MAGNETO6_ERROR = -1
 
} magneto6_return_value_t;
 
void magneto6_cfg_setup ( magneto6_cfg_t *cfg );
 
err_t magneto6_init ( magneto6_t *ctx, magneto6_cfg_t *cfg );
 
err_t magneto6_default_cfg ( magneto6_t *ctx );
 
err_t magneto6_write_reg ( magneto6_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t magneto6_read_reg ( magneto6_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void magneto6_set_ien_pin ( magneto6_t *ctx, uint8_t state );
 
uint8_t magneto6_get_int_pin ( magneto6_t *ctx );
 
err_t magneto6_read_data ( magneto6_t *ctx, magneto6_data_t *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // MAGNETO6_H
 
 // magneto6
 
// ------------------------------------------------------------------------ END