hallswitch3.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 HALLSWITCH3_H
#define HALLSWITCH3_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 HALLSWITCH3_REG_STATUS                0x00
#define HALLSWITCH3_REG_CONTROL_REG1          0x01
#define HALLSWITCH3_REG_OUT_M_REG             0x03
#define HALLSWITCH3_REG_USER_ASSERT_THRESH    0x04
#define HALLSWITCH3_REG_USER_CLEAR_THRESH     0x05
#define HALLSWITCH3_REG_USER_ODR              0x06
#define HALLSWITCH3_REG_WHO_AM_I              0x08
#define HALLSWITCH3_REG_I2C_ADDR              0x09
 
 // hallswitch3_reg
 
#define HALLSWITCH3_STATUS_OUT_B_CLEAR        0x00
#define HALLSWITCH3_STATUS_OUT_B_ASSERT       0x01
#define HALLSWITCH3_STATUS_RST_COMPLETE       0x00
#define HALLSWITCH3_STATUS_RST_NOT_COMPLETE   0x02
#define HALLSWITCH3_STATUS_OPMODE_SA          0x00
#define HALLSWITCH3_STATUS_OPMODE_I2C         0x08
#define HALLSWITCH3_STATUS_MDR_DATA_RDY       0x00
#define HALLSWITCH3_STATUS_MDR_DATA_NO_RDY    0x20
#define HALLSWITCH3_STATUS_MDO_DATA_OK        0x00
#define HALLSWITCH3_STATUS_MDO_DATA_FAULT     0x40
#define HALLSWITCH3_STATUS_VOUT_LOW           0x00
#define HALLSWITCH3_STATUS_VOUT_HIGH          0x80
 
#define HALLSWITCH3_CONTROL_SW_RESET          0x01
#define HALLSWITCH3_CONTROL_ONE_SHOT          0x04
#define HALLSWITCH3_CONTROL_AUTO_STOP         0x00
#define HALLSWITCH3_CONTROL_AUTO_START        0x08
#define HALLSWITCH3_CONTROL_V_POL_ASSERT_H    0x00
#define HALLSWITCH3_CONTROL_V_POL_ASSERT_L    0x20
 
#define HALLSWITCH3_ASSERT_THOLD_DEFAULT      0x10
#define HALLSWITCH3_CLEAR_THOLD_DEFAULT       0x15
#define HALLSWITCH3_THOLD_BITMASK             0x1F
 
#define HALLSWITCH3_OUT_M_RES_RST             0x00
#define HALLSWITCH3_OUT_M_RES_LOWEST          0x01
#define HALLSWITCH3_OUT_M_RES_HIGHEST         0x1F
 
#define HALLSWITCH3_USER_ODR_LSP              0x1F
#define HALLSWITCH3_USER_ODR_LSP              0x00
#define HALLSWITCH3_USER_ODR_LSP_X5           0x01
#define HALLSWITCH3_USER_ODR_MSP              0x02
#define HALLSWITCH3_USER_ODR_MSP_X5           0x03
#define HALLSWITCH3_USER_ODR_HSP              0x04
#define HALLSWITCH3_USER_ODR_HSP_X5           0x05
#define HALLSWITCH3_USER_ODR_HSP_X10          0x06
#define HALLSWITCH3_USER_ODR_CFG_ERR          0x07
 
#define HALLSWITCH3_OUT_STATE_LOW             0x00
#define HALLSWITCH3_OUT_STATE_HIGH            0x01
 
#define HALLSWITCH3_WHO_AM_I                  0x01
 
#define HALLSWITCH3_DEVICE_ADDRESS            0x60
 
 // hallswitch3_set
 
#define HALLSWITCH3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.out = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // hallswitch3_map
 // hallswitch3
 
typedef struct
{
    // Input pins
    digital_in_t out;       
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
} hallswitch3_t;
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    pin_name_t out;    
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} hallswitch3_cfg_t;
 
typedef enum
{
    HALLSWITCH3_OK = 0,
    HALLSWITCH3_ERROR = -1
 
} hallswitch3_return_value_t;
 
void hallswitch3_cfg_setup ( hallswitch3_cfg_t *cfg );
 
err_t hallswitch3_init ( hallswitch3_t *ctx, hallswitch3_cfg_t *cfg );
 
err_t hallswitch3_default_cfg ( hallswitch3_t *ctx );
 
err_t hallswitch3_reg_write ( hallswitch3_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t hallswitch3_reg_read ( hallswitch3_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t hallswitch3_get_status ( hallswitch3_t *ctx, uint8_t *status );
 
err_t hallswitch3_reset ( hallswitch3_t *ctx );
 
err_t hallswitch3_set_one_shot ( hallswitch3_t *ctx );
 
err_t hallswitch3_autonomous_mode ( hallswitch3_t *ctx );
 
err_t hallswitch3_set_vpol ( hallswitch3_t *ctx, uint8_t v_pol );
 
err_t hallswitch3_get_mag_data ( hallswitch3_t *ctx, int8_t *mag_data );
 
err_t hallswitch3_set_threshold ( hallswitch3_t *ctx, uint8_t assert_thold, uint8_t clear_thold );
 
err_t hallswitch3_set_out_data_rate ( hallswitch3_t *ctx, uint8_t odr );
 
err_t hallswitch3_get_device_id ( hallswitch3_t *ctx, uint8_t *device_id );
 
uint8_t hallswitch3_check_mag_field ( hallswitch3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // HALLSWITCH3_H
 
 // hallswitch3
 
// ------------------------------------------------------------------------ END