c3dhall9.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 C3DHALL9_H
#define C3DHALL9_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 C3DHALL9_REG_EEPROM_02                  0x02
#define C3DHALL9_REG_EEPROM_03                  0x03
#define C3DHALL9_REG_EEPROM_0D                  0x0D
#define C3DHALL9_REG_EEPROM_0E                  0x0E
#define C3DHALL9_REG_EEPROM_0F                  0x0F
#define C3DHALL9_REG_VOLATILE_27                0x27
#define C3DHALL9_REG_VOLATILE_28                0x28
#define C3DHALL9_REG_VOLATILE_29                0x29
 
 // c3dhall9_reg
 
#define C3DHALL9_EEPROM_02_ENABLE_Z             0x00000100ul
#define C3DHALL9_EEPROM_02_ENABLE_Y             0x00000080ul
#define C3DHALL9_EEPROM_02_ENABLE_X             0x00000040ul
#define C3DHALL9_VOLATILE_27_ACTIVE_MODE        0x00000000ul
#define C3DHALL9_VOLATILE_27_SLEEP_MODE         0x00000001ul
#define C3DHALL9_VOLATILE_27_LOW_POWER_MODE     0x00000002ul
#define C3DHALL9_VOLATILE_27_I2C_SINGLE         0x00000000ul
#define C3DHALL9_VOLATILE_27_I2C_FAST_LOOP      0x00000004ul
#define C3DHALL9_VOLATILE_27_I2C_FULL_LOOP      0x00000008ul
 
#define C3DHALL9_12BIT_RESOLUTION               0x1000
#define C3DHALL9_SIGN_BIT                       0x0800
#define C3DHALL9_DATA_READY_BIT                 0x0080
#define C3DHALL9_GAUSS_RESOLUTION               4
#define C3DHALL9_TEMPERATURE_MULTIPLIER         302
#define C3DHALL9_TEMPERATURE_SUBTRACTOR         1702
#define C3DHALL9_TEMPERATURE_SUBTRACTOR         1702
#define C3DHALL9_HALF_CICRLE_DEGREES            180.0
#define C3DHALL9_MATH_TWO_PI                    6.28318530717958
 
#define C3DHALL9_SET_DEV_ADDR                   0x60
 
 // c3dhall9_set
 
#define C3DHALL9_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // c3dhall9_map
 // c3dhall9
 
typedef struct
{
    // Output pins
    digital_out_t  en;              
    // Input pins
    digital_in_t  int_pin;          
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} c3dhall9_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    pin_name_t  en;                 
    pin_name_t  int_pin;            
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
} c3dhall9_cfg_t;
 
typedef enum
{
    C3DHALL9_OK = 0,
    C3DHALL9_ERROR = -1
 
} c3dhall9_return_value_t;
 
typedef struct
{
    float x_axis;
    float y_axis;
    float z_axis;
    float angle_xy;
    float angle_xz;
    float angle_yz;
    float temperature;
    
} c3dhall9_data_t;
 
void c3dhall9_cfg_setup ( c3dhall9_cfg_t *cfg );
 
err_t c3dhall9_init ( c3dhall9_t *ctx, c3dhall9_cfg_t *cfg );
 
err_t c3dhall9_default_cfg ( c3dhall9_t *ctx );
 
err_t c3dhall9_write_register ( c3dhall9_t *ctx, uint8_t reg, uint32_t data_in );
 
err_t c3dhall9_read_register ( c3dhall9_t *ctx, uint8_t reg, uint32_t *data_out );
 
void c3dhall9_enable_chip ( c3dhall9_t *ctx );
 
void c3dhall9_disable_chip ( c3dhall9_t *ctx );
 
uint8_t c3dhall9_get_int_pin ( c3dhall9_t *ctx );
 
err_t c3dhall9_read_data ( c3dhall9_t *ctx, c3dhall9_data_t *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // C3DHALL9_H
 
 // c3dhall9
 
// ------------------------------------------------------------------------ END