piezoaccel  2.0.0.0
piezoaccel.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef PIEZOACCEL_H
29 #define PIEZOACCEL_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "drv_analog_in.h"
39 
56 #define PIEZOACCEL_MEAS_MODE_AN_PIN 0x00
57 #define PIEZOACCEL_MEAS_MODE_ADC 0x01
58  // measurement_mode
60 
71 #define PIEZOACCEL_SENSOR_VOLTAGE_5V 0x00
72 #define PIEZOACCEL_SENSOR_VOLTAGE_3V3 0x01
73  // sensor_voltage
75 
90 #define PIEZOACCEL_MAP_MIKROBUS( cfg, mikrobus ) \
91  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
92  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
93  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
94  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
95  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
96  // piezoaccel_map // piezoaccel
99 
104 typedef struct
105 {
106  // Modules
107 
108  analog_in_t adc;
110  spi_master_t spi;
112  pin_name_t chip_select;
114 } piezoaccel_t;
115 
120 typedef struct
121 {
122  // Communication gpio pins
123 
124  pin_name_t miso;
125  pin_name_t mosi;
126  pin_name_t sck;
127  pin_name_t cs;
129  // Additional gpio pins
130 
131  pin_name_t an;
133  // static variable
134 
135  uint32_t spi_speed;
136  spi_master_mode_t spi_mode;
137  spi_master_chip_select_polarity_t cs_polarity;
139  analog_in_resolution_t resolution;
140  float vref;
143 
148 typedef struct
149 {
151  uint8_t sensor_voltage;
152  float offset_data;
155 
172 
188 
201 
212 
223 
236 err_t piezoaccel_read_an_pin_value ( piezoaccel_t *ctx, uint16_t *data_out );
237 
252 err_t piezoaccel_read_an_pin_voltage ( piezoaccel_t *ctx, float *data_out );
253 
267 
280 
281 #ifdef __cplusplus
282 }
283 #endif
284 #endif // PIEZOACCEL_H
285  // piezoaccel
287 
288 // ------------------------------------------------------------------------ END
piezoaccel_cfg_t::miso
pin_name_t miso
Definition: piezoaccel.h:124
piezoaccel_setup_t
Piezo Accel Click Configuration setup structure.
Definition: piezoaccel.h:149
piezoaccel_g_unit_read
float piezoaccel_g_unit_read(piezoaccel_t *ctx, piezoaccel_setup_t *cfg_data)
Piezo Accel read force of acceleration function.
piezoaccel_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: piezoaccel.h:136
piezoaccel_default_cfg
void piezoaccel_default_cfg(piezoaccel_t *ctx, piezoaccel_setup_t *setup_cfg_data)
Piezo Accel default configuration function.
piezoaccel_adc_raw_read
uint16_t piezoaccel_adc_raw_read(piezoaccel_t *ctx)
Piezo Accel read raw adc function.
piezoaccel_cfg_t::vref
float vref
Definition: piezoaccel.h:140
piezoaccel_init
err_t piezoaccel_init(piezoaccel_t *ctx, piezoaccel_cfg_t *cfg)
Piezo Accel initialization function.
piezoaccel_t
Piezo Accel Click context object.
Definition: piezoaccel.h:105
piezoaccel_t::spi
spi_master_t spi
Definition: piezoaccel.h:110
piezoaccel_cfg_t
Piezo Accel Click configuration object.
Definition: piezoaccel.h:121
piezoaccel_calibration
void piezoaccel_calibration(piezoaccel_t *ctx, piezoaccel_setup_t *cfg_data)
Piezo Accel calibration function.
piezoaccel_setup_t::sensor_voltage
uint8_t sensor_voltage
Definition: piezoaccel.h:151
piezoaccel_read_an_pin_voltage
err_t piezoaccel_read_an_pin_voltage(piezoaccel_t *ctx, float *data_out)
Piezo Accel read AN pin voltage level function.
piezoaccel_read_an_pin_value
err_t piezoaccel_read_an_pin_value(piezoaccel_t *ctx, uint16_t *data_out)
Piezo Accel read AN pin value function.
piezoaccel_cfg_t::an
pin_name_t an
Definition: piezoaccel.h:131
piezoaccel_cfg_t::spi_speed
uint32_t spi_speed
Definition: piezoaccel.h:135
piezoaccel_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: piezoaccel.h:137
piezoaccel_setup_t::offset_data
float offset_data
Definition: piezoaccel.h:152
piezoaccel_cfg_t::resolution
analog_in_resolution_t resolution
Definition: piezoaccel.h:139
piezoaccel_t::adc
analog_in_t adc
Definition: piezoaccel.h:108
piezoaccel_cfg_t::mosi
pin_name_t mosi
Definition: piezoaccel.h:125
piezoaccel_t::chip_select
pin_name_t chip_select
Definition: piezoaccel.h:112
piezoaccel_setup_t::measurement_mode
uint8_t measurement_mode
Definition: piezoaccel.h:150
piezoaccel_cfg_setup
void piezoaccel_cfg_setup(piezoaccel_cfg_t *cfg)
Piezo Accel configuration object setup function.
piezoaccel_cfg_t::cs
pin_name_t cs
Definition: piezoaccel.h:127
piezoaccel_cfg_t::sck
pin_name_t sck
Definition: piezoaccel.h:126
piezoaccel_adc_voltage_read
float piezoaccel_adc_voltage_read(piezoaccel_t *ctx)
Piezo Accel read adc converted to voltage function.