piezoaccel.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 PIEZOACCEL_H
#define PIEZOACCEL_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_spi_master.h"
#include "drv_analog_in.h"
 
#define PIEZOACCEL_MEAS_MODE_AN_PIN      0x00
#define PIEZOACCEL_MEAS_MODE_ADC         0x01
 
 // measurement_mode
 
#define PIEZOACCEL_SENSOR_VOLTAGE_5V     0x00
#define PIEZOACCEL_SENSOR_VOLTAGE_3V3    0x01
 
 // sensor_voltage
 
#define PIEZOACCEL_MAP_MIKROBUS( cfg, mikrobus )    \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.an   = MIKROBUS( mikrobus, MIKROBUS_AN )
 
 // piezoaccel_map
 // piezoaccel
 
typedef struct
{
    // Modules
 
    analog_in_t   adc;                               
    spi_master_t  spi;                               
    pin_name_t    chip_select;                       
} piezoaccel_t;
 
typedef struct
{
    // Communication gpio pins
 
    pin_name_t  miso;                      
    pin_name_t  mosi;                      
    pin_name_t  sck;                       
    pin_name_t  cs;                        
    // Additional gpio pins
 
    pin_name_t  an;                        
    // static variable
 
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
    analog_in_resolution_t             resolution;       
    float                              vref;             
} piezoaccel_cfg_t;
 
typedef struct
{
    uint8_t measurement_mode;                        
    uint8_t sensor_voltage;                          
    float offset_data;                               
} piezoaccel_setup_t;
 
void piezoaccel_cfg_setup ( piezoaccel_cfg_t *cfg );
 
err_t piezoaccel_init ( piezoaccel_t *ctx, piezoaccel_cfg_t *cfg );
 
void piezoaccel_default_cfg ( piezoaccel_t *ctx, piezoaccel_setup_t *setup_cfg_data );
 
uint16_t piezoaccel_adc_raw_read ( piezoaccel_t *ctx );
 
float piezoaccel_adc_voltage_read ( piezoaccel_t *ctx );
 
err_t piezoaccel_read_an_pin_value ( piezoaccel_t *ctx, uint16_t *data_out );
 
err_t piezoaccel_read_an_pin_voltage ( piezoaccel_t *ctx, float *data_out );
 
float piezoaccel_g_unit_read ( piezoaccel_t *ctx, piezoaccel_setup_t *cfg_data );
 
void piezoaccel_calibration ( piezoaccel_t *ctx, piezoaccel_setup_t *cfg_data );
 
#ifdef __cplusplus
}
#endif
#endif // PIEZOACCEL_H
 
 // piezoaccel
 
// ------------------------------------------------------------------------ END