vavpress  2.0.0.0
vavpress.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 VAVPRESS_H
29 #define VAVPRESS_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
69 #define VAVPRESS_SET_CMD_RESET_FIRMWARE 0x11
70 #define VAVPRESS_SET_CMD_START_PRESSURE_CONVERSION 0x21
71 #define VAVPRESS_SET_CMD_RETRIEVE_ELECTRONIC_SIGNATURE 0x23
72 
78 #define VAVPRESS_SET_DEV_ADDR_0 0x5C
79 #define VAVPRESS_SET_DEV_ADDR_1 0x5D
80 #define VAVPRESS_SET_DEV_ADDR_2 0x5E
81 #define VAVPRESS_SET_DEV_ADDR_3 0x5F
82  // vavpress_set
84 
99 #define VAVPRESS_MAP_MIKROBUS( cfg, mikrobus ) \
100  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
101  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
102  // vavpress_map // vavpress
105 
110 typedef struct
111 {
112  // Modules
113 
114  i2c_master_t i2c;
116  // I2C slave address
117 
118  uint8_t slave_address;
120 } vavpress_t;
121 
126 typedef struct
127 {
128  pin_name_t scl;
129  pin_name_t sda;
131  uint32_t i2c_speed;
132  uint8_t i2c_address;
135 
140 typedef enum
141 {
143  VAVPRESS_ERROR = -1
144 
146 
151 typedef struct
152 {
154  char part_number[ 12 ];
155  char lot_number[ 7 ];
156  uint16_t pressure_range;
158  uint16_t scale_factor;
159  char calibration_id[ 2 ];
160  uint8_t week_number;
161  uint8_t year_number;
162  uint16_t sequence_number;
163 
165 
170 typedef struct
171 {
176 
178 
197 
215 
232 
251 err_t vavpress_set_command ( vavpress_t *ctx, uint8_t cmd );
252 
269 err_t vavpress_generic_write ( vavpress_t *ctx, uint8_t *tx_buf, uint8_t tx_len );
270 
287 err_t vavpress_generic_read ( vavpress_t *ctx, uint8_t *rx_buf, uint8_t rx_len );
288 
306 
324 err_t vavpress_get_readout_data ( vavpress_t *ctx, int16_t *press_data, int16_t *temp_data );
325 
344 err_t vavpress_get_dif_press_and_temp ( vavpress_t *ctx, vavpress_sensor_param_data_t *param_data, float *diff_press, float *temperature );
345 
363 
364 
365 #ifdef __cplusplus
366 }
367 #endif
368 #endif // VAVPRESS_H
369  // vavpress
371 
372 // ------------------------------------------------------------------------ END
vavpress_get_readout_data
err_t vavpress_get_readout_data(vavpress_t *ctx, int16_t *press_data, int16_t *temp_data)
VAV Press get data readout function.
vavpress_generic_read
err_t vavpress_generic_read(vavpress_t *ctx, uint8_t *rx_buf, uint8_t rx_len)
VAV Press I2C reading function.
vavpress_init
err_t vavpress_init(vavpress_t *ctx, vavpress_cfg_t *cfg)
VAV Press initialization function.
vavpress_t::slave_address
uint8_t slave_address
Definition: vavpress.h:118
vavpress_default_cfg
err_t vavpress_default_cfg(vavpress_t *ctx)
VAV Press default configuration function.
vavpress_generic_write
err_t vavpress_generic_write(vavpress_t *ctx, uint8_t *tx_buf, uint8_t tx_len)
VAV Press I2C writing function.
vavpress_el_signature_data_t::scale_factor
uint16_t scale_factor
Definition: vavpress.h:158
vavpress_set_default_sensor_param
err_t vavpress_set_default_sensor_param(vavpress_t *ctx, vavpress_sensor_param_data_t *param_data)
VAV Press set default sensor parameter function.
vavpress_cfg_t
VAV Press Click configuration object.
Definition: vavpress.h:127
vavpress_cfg_t::i2c_address
uint8_t i2c_address
Definition: vavpress.h:132
VAVPRESS_ERROR
@ VAVPRESS_ERROR
Definition: vavpress.h:143
vavpress_sensor_param_data_t::scale_factor_press
uint16_t scale_factor_press
Definition: vavpress.h:173
vavpress_return_value_t
vavpress_return_value_t
VAV Press Click return value data.
Definition: vavpress.h:141
vavpress_set_command
err_t vavpress_set_command(vavpress_t *ctx, uint8_t cmd)
VAV Press set command function.
vavpress_t
VAV Press Click context object.
Definition: vavpress.h:111
vavpress_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: vavpress.h:131
vavpress_sensor_param_data_t::scale_factor_temp
uint16_t scale_factor_temp
Definition: vavpress.h:172
vavpress_cfg_setup
void vavpress_cfg_setup(vavpress_cfg_t *cfg)
VAV Press configuration object setup function.
vavpress_el_signature_data_t::sequence_number
uint16_t sequence_number
Definition: vavpress.h:162
vavpress_sensor_param_data_t::readout_at_known_temperature
uint16_t readout_at_known_temperature
Definition: vavpress.h:174
VAVPRESS_OK
@ VAVPRESS_OK
Definition: vavpress.h:142
param_data
vavpress_sensor_param_data_t param_data
Definition: main.c:37
vavpress_sensor_param_data_t::known_temperature_c
float known_temperature_c
Definition: vavpress.h:175
vavpress_el_signature_data_t::pressure_range
uint16_t pressure_range
Definition: vavpress.h:156
el_signature_data
vavpress_el_signature_data_t el_signature_data
Definition: main.c:36
vavpress_sensor_param_data_t
VAV Press Click sensor parameter data.
Definition: vavpress.h:171
vavpress_t::i2c
i2c_master_t i2c
Definition: vavpress.h:114
vavpress_el_signature_data_t::output_type
char output_type
Definition: vavpress.h:157
vavpress_retrieve_electronic_signature
err_t vavpress_retrieve_electronic_signature(vavpress_t *ctx, vavpress_el_signature_data_t *el_signature_data)
VAV Press retrieve electronic signature function.
vavpress_get_dif_press_and_temp
err_t vavpress_get_dif_press_and_temp(vavpress_t *ctx, vavpress_sensor_param_data_t *param_data, float *diff_press, float *temperature)
VAV Press get differential pressure and temperature function.
vavpress_cfg_t::scl
pin_name_t scl
Definition: vavpress.h:128
vavpress_el_signature_data_t::year_number
uint8_t year_number
Definition: vavpress.h:161
vavpress_el_signature_data_t::firmware_version
float firmware_version
Definition: vavpress.h:153
vavpress_el_signature_data_t::week_number
uint8_t week_number
Definition: vavpress.h:160
vavpress_cfg_t::sda
pin_name_t sda
Definition: vavpress.h:129
vavpress_el_signature_data_t
VAV Press Click electronic signature.
Definition: vavpress.h:152