c3dhall2.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 C3DHALL2_H
#define C3DHALL2_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define C3DHALL2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define   C3DHALL2_DEVICE_ADDRESS               0x5E
 
#define   C3DHALL2_M1_I2C_SLAVE_ADDRESS_0       0x00
#define   C3DHALL2_M1_I2C_SLAVE_ADDRESS_1       0x20
#define   C3DHALL2_M1_I2C_SLAVE_ADDRESS_2       0x40
#define   C3DHALL2_M1_I2C_SLAVE_ADDRESS_3       0x60
#define   C3DHALL2_M1_INTERRUPT_ENABLE          0x04
#define   C3DHALL2_M1_INTERRUPT_DISABLE         0x00
#define   C3DHALL2_M1_FAST_MODE_ENABLE          0x02
#define   C3DHALL2_M1_FAST_MODE_DISABLE         0x00
#define   C3DHALL2_M1_LOW_POWER_MODE_ENABLE     0x01
#define   C3DHALL2_M1_LOW_POWER_MODE_DISABLE    0x00
#define   C3DHALL2_M2_TEMPERATURE_ENABLE       0x00
#define   C3DHALL2_M2_TEMPERATURE_DISABLE      0x80
#define   C3DHALL2_M2_LOW_POWER_PERIOD_100MS   0x00
#define   C3DHALL2_M2_LOW_POWER_PERIOD_12MS    0x40
#define   C3DHALL2_M2_PARITY_TEST_ENABLE       0x00
#define   C3DHALL2_M2_PARITY_TEST_DISABLE      0x20
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
   
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} c3dhall2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} c3dhall2_cfg_t;
 
typedef enum
{
    C3DHALL2_OK = 0,
    C3DHALL2_ERROR = -1
 
} c3dhall2_return_value_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void c3dhall2_cfg_setup ( c3dhall2_cfg_t *cfg );
 
err_t c3dhall2_init ( c3dhall2_t *ctx, c3dhall2_cfg_t *cfg );
 
err_t c3dhall2_default_cfg( c3dhall2_t *ctx );
 
err_t c3dhall2_write_data ( c3dhall2_t *ctx, uint8_t *data_buf, uint16_t len );
 
err_t c3dhall2_read_data ( c3dhall2_t *ctx, uint8_t *data_buf, uint16_t len );
 
err_t c3dhall2_get_axis_temp_data ( c3dhall2_t *ctx, float *axis_data, float *temp_data );
 
err_t c3dhall2_configuration ( c3dhall2_t *ctx, uint8_t settings1, uint8_t settings2 );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _C3DHALL2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END