c3dhall8.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 C3DHALL8_H
#define C3DHALL8_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 C3DHALL8_REG_MAGNETIC_X_MSB         0x00
#define C3DHALL8_REG_MAGNETIC_Y_MSB         0x01
#define C3DHALL8_REG_MAGENTIC_Z_MSB         0x02
#define C3DHALL8_REG_TEMPERATURE_MSB        0x03
#define C3DHALL8_REG_MAGNETIC_XY_LSB        0x04
#define C3DHALL8_REG_TEMPERATURE_Z_LSB      0x05
#define C3DHALL8_REG_STATUS                 0x06
#define C3DHALL8_REG_LOWER_THRESHOLD_X_MSB  0x07
#define C3DHALL8_REG_UPPER_THRESHOLD_X_MSB  0x08
#define C3DHALL8_REG_LOWER_THRESHOLD_Y_MSB  0x09
#define C3DHALL8_REG_UPPER_THRESHOLD_Y_MSB  0x0A
#define C3DHALL8_REG_LOWER_THRESHOLD_Z_MSB  0x0B
#define C3DHALL8_REG_UPPER_THRESHOLD_Z_MSB  0x0C
#define C3DHALL8_REG_THRESHOLDS_X_LSB       0x0D
#define C3DHALL8_REG_THRESHOLDS_Y_LSB       0x0E
#define C3DHALL8_REG_THRESHOLDS_Z_LSB       0x0F
#define C3DHALL8_REG_CONFIG_1               0x10
#define C3DHALL8_REG_MOD1                   0x11
#define C3DHALL8_REG_MOD2                   0x13
#define C3DHALL8_REG_CONFIG_2               0x14
#define C3DHALL8_REG_VERSION                0x16
 
 // c3dhall8_reg
 
#define C3DHALL8_RX_BUFFER 0x17
 
#define C3DHALL8_SET_DEV_ADDR  0x35
 
 // c3dhall8_set
 
#define C3DHALL8_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // c3dhall8_map
 // c3dhall8
 
typedef struct
{
    // Input pins
     digital_in_t  int_pin;       
    // Modules
    i2c_master_t i2c;             
    // I2C slave address
    uint8_t slave_address;        
    uint8_t receiver_buff[ C3DHALL8_RX_BUFFER ];
 
} c3dhall8_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  int_pin;       
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} c3dhall8_cfg_t;
 
typedef struct
{
    float x_axis;
    float y_axis;
    float z_axis;
    float temperature;
    
} c3dhall8_data_t;
 
typedef enum
{
    C3DHALL8_OK = 0,
    C3DHALL8_ERROR = -1
 
} ismtx_return_value_t;
 
void c3dhall8_cfg_setup ( c3dhall8_cfg_t *cfg );
 
err_t c3dhall8_init ( c3dhall8_t *ctx, c3dhall8_cfg_t *cfg );
 
err_t c3dhall8_default_cfg ( c3dhall8_t *ctx );
 
err_t c3dhall8_generic_write ( c3dhall8_t *ctx, uint8_t reg, uint8_t tx_buf );
 
err_t c3dhall8_generic_read ( c3dhall8_t *ctx, uint8_t reg, uint8_t *rx_buf );
 
void c3dhall8_read_sensor_data ( c3dhall8_t *ctx, c3dhall8_data_t *sensor_data );
 
float c3dhall8_get_xyz_magnetic_matching ( c3dhall8_t *ctx, c3dhall8_data_t sensor_data );
 
float c3dhall8_get_xy_magnetic_matching ( c3dhall8_t *ctx, c3dhall8_data_t sensor_data );
 
#ifdef __cplusplus
}
#endif
#endif // C3DHALL8_H
 
 // c3dhall8
 
// ------------------------------------------------------------------------ END