vibrasense2.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 VIBRASENSE2_H
#define VIBRASENSE2_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 VIBRASENSE2_RESOLUTION           4096
#define VIBRASENSE2_12_BIT_DATA          0x0FFF
 
#define VIBRASENSE2_VIBRA_LVL_ERROR     -1
#define VIBRASENSE2_VIBRA_LVL_0          0
#define VIBRASENSE2_VIBRA_LVL_1          1
#define VIBRASENSE2_VIBRA_LVL_2          2
#define VIBRASENSE2_VIBRA_LVL_3          3
#define VIBRASENSE2_VIBRA_LVL_4          4
#define VIBRASENSE2_VIBRA_LVL_5          5
#define VIBRASENSE2_VIBRA_LVL_6          6
 
#define VIBRASENSE2_SET_DEV_ADDR  0x4D
 
 // vibrasense2_set
 
#define VIBRASENSE2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 // vibrasense2_map
 // vibrasense2
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                                
    // I2C slave address
    uint8_t slave_address;                           
} vibrasense2_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} vibrasense2_cfg_t;
 
typedef enum
{
   VIBRASENSE2_OK = 0,
   VIBRASENSE2_ERROR = -1
 
} vibrasense2_return_value_t;
 
void vibrasense2_cfg_setup ( vibrasense2_cfg_t *cfg );
 
err_t vibrasense2_init ( vibrasense2_t *ctx, vibrasense2_cfg_t *cfg );
 
err_t vibrasense2_generic_write ( vibrasense2_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t vibrasense2_generic_read ( vibrasense2_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
uint16_t vibrasense2_read_data ( vibrasense2_t *ctx );
 
uint16_t vibrasense2_read_voltage ( vibrasense2_t *ctx, uint16_t v_ref );
 
int8_t vibrasense2_vibration_level ( vibrasense2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // VIBRASENSE2_H
 
 // vibrasense2
 
// ------------------------------------------------------------------------ END