pressure19  2.0.0.0
pressure19.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 PRESSURE19_H
29 #define PRESSURE19_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_analog_in.h"
48 #include "drv_i2c_master.h"
49 
70 #define PRESSURE19_MIN_PRESSURE 0.2
71 #define PRESSURE19_MAX_PRESSURE 3.0
72 #define PRESSURE19_MIN_VOLTAGE 0.4
73 #define PRESSURE19_MAX_VOLTAGE 4.65
74 #define PRESSURE19_BAR_TO_MBAR 1000
75 
80 #define PRESSURE19_ADC_RESOLUTION 0x0FFF
81 #define PRESSURE19_VREF_3V3 3.3
82 #define PRESSURE19_VREF_5V 5.0
83 
89 #define PRESSURE19_SET_DEV_ADDR 0x4D
90  // pressure19_set
92 
107 #define PRESSURE19_MAP_MIKROBUS( cfg, mikrobus ) \
108  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
109  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
110  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
111  // pressure19_map // pressure19
114 
119 typedef enum
120 {
125 
130 typedef struct
131 {
132  analog_in_t adc;
133  i2c_master_t i2c;
135  uint8_t slave_address;
136  pin_name_t chip_select;
137  float vref;
140 } pressure19_t;
141 
146 typedef struct
147 {
148  pin_name_t an;
149  pin_name_t scl;
150  pin_name_t sda;
152  analog_in_resolution_t resolution;
153  float vref;
155  uint32_t i2c_speed;
156  uint8_t i2c_address;
161 
166 typedef enum
167 {
169  PRESSURE19_ERROR = -1
170 
172 
189 
205 
220 
232 err_t pressure19_read_raw_adc ( pressure19_t *ctx, uint16_t *raw_adc );
233 
245 err_t pressure19_read_voltage ( pressure19_t *ctx, float *voltage );
246 
258 err_t pressure19_set_vref ( pressure19_t *ctx, float vref );
259 
272 err_t pressure19_get_pressure ( pressure19_t *ctx, uint16_t *pressure );
273 
274 #ifdef __cplusplus
275 }
276 #endif
277 #endif // PRESSURE19_H
278  // pressure19
280 
281 // ------------------------------------------------------------------------ END
pressure19_t::vref
float vref
Definition: pressure19.h:137
pressure19_drv_t
pressure19_drv_t
Pressure 19 Click driver selector.
Definition: pressure19.h:120
PRESSURE19_DRV_SEL_ADC
@ PRESSURE19_DRV_SEL_ADC
Definition: pressure19.h:121
pressure19_cfg_t
Pressure 19 Click configuration object.
Definition: pressure19.h:147
pressure19_get_pressure
err_t pressure19_get_pressure(pressure19_t *ctx, uint16_t *pressure)
Pressure 19 get pressure function.
pressure19_cfg_t::an
pin_name_t an
Definition: pressure19.h:148
pressure19_cfg_t::i2c_address
uint8_t i2c_address
Definition: pressure19.h:156
pressure19_t::drv_sel
pressure19_drv_t drv_sel
Definition: pressure19.h:138
pressure19_cfg_t::resolution
analog_in_resolution_t resolution
Definition: pressure19.h:152
pressure19_init
err_t pressure19_init(pressure19_t *ctx, pressure19_cfg_t *cfg)
Pressure 19 initialization function.
PRESSURE19_ERROR
@ PRESSURE19_ERROR
Definition: pressure19.h:169
pressure19_t
Pressure 19 Click context object.
Definition: pressure19.h:131
pressure19_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pressure19.h:155
pressure19_t::adc
analog_in_t adc
Definition: pressure19.h:132
pressure19_cfg_t::vref
float vref
Definition: pressure19.h:153
pressure19_drv_interface_selection
void pressure19_drv_interface_selection(pressure19_cfg_t *cfg, pressure19_drv_t drv_sel)
Pressure 19 driver interface setup function.
pressure19_cfg_t::drv_sel
pressure19_drv_t drv_sel
Definition: pressure19.h:158
PRESSURE19_OK
@ PRESSURE19_OK
Definition: pressure19.h:168
pressure19_t::i2c
i2c_master_t i2c
Definition: pressure19.h:133
pressure19_cfg_setup
void pressure19_cfg_setup(pressure19_cfg_t *cfg)
Pressure 19 configuration object setup function.
pressure19_read_voltage
err_t pressure19_read_voltage(pressure19_t *ctx, float *voltage)
Pressure 19 read voltage level function.
pressure19_read_raw_adc
err_t pressure19_read_raw_adc(pressure19_t *ctx, uint16_t *raw_adc)
Pressure 19 read raw ADC value function.
PRESSURE19_DRV_SEL_I2C
@ PRESSURE19_DRV_SEL_I2C
Definition: pressure19.h:122
pressure19_t::slave_address
uint8_t slave_address
Definition: pressure19.h:135
pressure19_cfg_t::scl
pin_name_t scl
Definition: pressure19.h:149
pressure19_set_vref
err_t pressure19_set_vref(pressure19_t *ctx, float vref)
Pressure 19 set vref function.
pressure19_t::chip_select
pin_name_t chip_select
Definition: pressure19.h:136
pressure19_cfg_t::sda
pin_name_t sda
Definition: pressure19.h:150
pressure19_return_value_t
pressure19_return_value_t
Pressure 19 Click return value data.
Definition: pressure19.h:167