pressure9  2.0.0.0
pressure9.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef PRESSURE9_H
36 #define PRESSURE9_H
37 
38 #include "drv_digital_in.h"
39 #include "drv_digital_out.h"
40 #include "drv_i2c_master.h"
41 #include "drv_spi_master.h"
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
54 #define PRESSURE9_MAP_MIKROBUS( cfg, mikrobus ) \
55  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
56  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
57  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
58  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
59  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
60  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
61 
67 #define PRESSURE9_MASTER_I2C 0
68 #define PRESSURE9_MASTER_SPI 1
69 
75 #define PRESSURE9_OK 0
76 #define PRESSURE9_ERROR -1
77 
83 #define PRESSURE9_REG_PRESSURE_DATA_B2 0x00
84 #define PRESSURE9_REG_PRESSURE_DATA_B1 0x01
85 #define PRESSURE9_REG_PRESSURE_DATA_B0 0x02
86 #define PRESSURE9_REG_TEMPERATRE_DATA_B2 0x03
87 #define PRESSURE9_REG_TEMPERATRE_DATA_B1 0x04
88 #define PRESSURE9_REG_TEMPERATRE_DATA_B0 0x05
89 #define PRESSURE9_REG_PRESSURE_CONFIG 0x06
90 #define PRESSURE9_REG_TEMPERATURE_CONFIG 0x07
91 #define PRESSURE9_REG_MEASUREMENT_CONFIG 0x08
92 #define PRESSURE9_REG_CONFIGURATION 0x09
93 #define PRESSURE9_REG_INT_STATUS 0x0A
94 #define PRESSURE9_REG_WATERMARK_CONFIG 0x0B
95 #define PRESSURE9_REG_FIFO_STATUS 0x0C
96 #define PRESSURE9_REG_RESET 0x0D
97 #define PRESSURE9_REG_PRODUCT_ID 0x1D
98 #define PRESSURE9_T_GAIN_COEFF 0x20
99 #define PRESSURE9_T_DVBE_COEFF 0x21
100 #define PRESSURE9_T_VBE_COEFF 0x22
101 #define PRESSURE9_COEFF_REG_1 0x26
102 #define PRESSURE9_COEFF_REG_2 0x27
103 #define PRESSURE9_COEFF_REG_3 0x28
104 #define PRESSURE9_COEFF_REG_4 0x29
105 #define PRESSURE9_COEFF_REG_5 0x2A
106 #define PRESSURE9_COEFF_REG_6 0x2B
107 #define PRESSURE9_COEFF_REG_7 0x2C
108 #define PRESSURE9_COEFF_REG_8 0x2D
109 #define PRESSURE9_COEFF_REG_9 0x2E
110 #define PRESSURE9_COEFF_REG_10 0x2F
111 #define PRESSURE9_COEFF_REG_11 0x30
112 #define PRESSURE9_COEFF_REG_12 0x31
113 #define PRESSURE9_COEFF_REG_13 0x32
114 #define PRESSURE9_COEFF_REG_14 0x33
115 #define PRESSURE9_COEFF_REG_15 0x34
116 #define PRESSURE9_COEFF_REG_16 0x35
117 #define PRESSURE9_COEFF_REG_17 0x36
118 #define PRESSURE9_COEFF_REG_18 0x37
119 
125 #define PRESSURE9_PTCFG_RATE_1_SAMPLE_SEC 0x00
126 #define PRESSURE9_PTCFG_RATE_2_SAMPLES_SEC 0x10
127 #define PRESSURE9_PTCFG_RATE_4_SAMPLES_SEC 0x20
128 #define PRESSURE9_PTCFG_RATE_8_SAMPLES_SEC 0x30
129 #define PRESSURE9_PTCFG_RATE_16_SAMPLES_SEC 0x40
130 #define PRESSURE9_PTCFG_RATE_32_SAMPLES_SEC 0x50
131 #define PRESSURE9_PTCFG_RATE_64_SAMPLES_SEC 0x60
132 #define PRESSURE9_PTCFG_RATE_128_SAMPLES_SEC 0x70
133 #define PRESSURE9_PTCFG_RES_X1_256_SAMPLES 0x00
134 #define PRESSURE9_PTCFG_RES_X2_512_SAMPLES 0x01
135 #define PRESSURE9_PTCFG_RES_X4_1024_SAMPLES 0x02
136 #define PRESSURE9_PTCFG_RES_X8_2048_SAMPLES 0x03
137 #define PRESSURE9_PTCFG_RES_X16_4096_SAMPLES 0x04
138 #define PRESSURE9_PTCFG_RES_X32_8192_SAMPLES 0x05
139 #define PRESSURE9_PTCFG_RES_X64_16384_SAMPLES 0x06
140 #define PRESSURE9_PTCFG_RES_X128_32768_SAMPLES 0x07
141 
146 #define PRESSURE9_MCFG_IDLE_STOP_BACKGROUND 0x00
147 #define PRESSURE9_MCFG_PRESSURE_MEASUREMENT 0x01
148 #define PRESSURE9_MCFG_TEMPERATURE_MEASUREMENT 0x02
149 #define PRESSURE9_MCFG_TEMP_AND_PRESS_ONE_SHOT 0x03
150 #define PRESSURE9_MCFG_PRESSURE_MEASUREMENT_CONT 0x05
151 #define PRESSURE9_MCFG_TEMPERATURE_MEASUREMENT_CONT 0x06
152 #define PRESSURE9_MCFG_TEMP_AND_PRESS_CONT 0x07
153 
158 #define PRESSURE9_CFG_SINT_NO_INT_ENABLED 0x00
159 #define PRESSURE9_CFG_SINT_PRESS_INT_ENABLED 0x10
160 #define PRESSURE9_CFG_SINT_TEMP_INT_ENABLED 0x20
161 #define PRESSURE9_CFG_SINT_PRESS_AND_TEMP_INT_EN 0x30
162 #define PRESSURE9_CFG_SINT_FIFO_WM_INT_ENABLED 0x40
163 #define PRESSURE9_CFG_SINT_FIFO_FULL_INT_ENABLED 0x80
164 #define PRESSURE9_CFG_PINT_INT_ACTIVE_LOW 0x00
165 #define PRESSURE9_CFG_PINT_INT_ACTIVE_HIGH 0x08
166 #define PRESSURE9_CFG_FIFO_SF_STREAMING_MODE 0x00
167 #define PRESSURE9_CFG_FIFO_SF_FULL_MODE 0x04
168 #define PRESSURE9_CFG_FIFO_EN_ENABLED 0x02
169 #define PRESSURE9_CFG_FIFO_EN_DISABLED 0x00
170 #define PRESSURE9_CFG_SPI_MODE_4_WIRE 0x00
171 #define PRESSURE9_CFG_SPI_MODE_3_WIRE 0x01
172 
177 #define PRESSURE9_RESET_CONFIGURATION_REG 0x08
178 #define PRESSURE9_FULL_SOFTWARE_RESET 0x09
179 #define PRESSURE9_FIFO_FLUSH 0x80
180 
185 #define PRESSURE9_DEV_SLAVE_ADR_GND 0x76
186 #define PRESSURE9_DEV_SLAVE_ADR_VCC 0x77
187 #define PRESSURE9_PRODUCT_ID 0x1A
188 
193 #define PRESSURE9_PRESSURE_COEFFICIENT_C00 0x00
194 #define PRESSURE9_PRESSURE_COEFFICIENT_C01 0x01
195 #define PRESSURE9_PRESSURE_COEFFICIENT_C02 0x02
196 #define PRESSURE9_PRESSURE_COEFFICIENT_C10 0x10
197 #define PRESSURE9_PRESSURE_COEFFICIENT_C20 0x20
198 #define PRESSURE9_PRESSURE_COEFFICIENT_C30 0x30
199 #define PRESSURE9_PRESSURE_COEFFICIENT_C11 0x11
200 #define PRESSURE9_PRESSURE_COEFFICIENT_C12 0x12
201 #define PRESSURE9_PRESSURE_COEFFICIENT_C21 0x21
202 #define PRESSURE9_TEMP_COEFFICIENT_T_GAIN 0x03
203 #define PRESSURE9_TEMP_COEFFICIENT_T_DVBE 0x04
204 #define PRESSURE9_TEMP_COEFFICIENT_T_VBE 0x05
205 #define PRESSURE9_COEFF_CAL_00 0x00
206 #define PRESSURE9_COEFF_CAL_10 0x10
207 #define PRESSURE9_COEFF_CAL_01 0x01
208 #define PRESSURE9_COEFF_CAL_02 0x02
209 #define PRESSURE9_COEFF_CAL_20 0x20
210 #define PRESSURE9_COEFF_CAL_30 0x30
211 #define PRESSURE9_COEFF_CAL_11 0x11
212 #define PRESSURE9_COEFF_CAL_12 0x12
213 #define PRESSURE9_COEFF_CAL_21 0x21
214 #define PRESSURE9_COEFF_T_GAIN 0x03
215 #define PRESSURE9_COEFF_T_DVBE 0x04
216 #define PRESSURE9_COEFF_T_VBE 0x05
217  // End group macro
220 // --------------------------------------------------------------- PUBLIC TYPES
229 typedef void ( *pressure9_master_io_t )( struct pressure9_s*, uint8_t, uint8_t*, uint8_t );
230 
234 typedef struct
235 {
236  int32_t cal_00;
237  int32_t cal_10;
238  int32_t cal_01;
239  int32_t cal_02;
240  int32_t cal_20;
241  int32_t cal_30;
242  int32_t cal_11;
243  int32_t cal_12;
244  int32_t cal_21;
245 
247 
251 typedef struct
252 {
253  int32_t t_gain;
254  int32_t t_dvbe;
255  int32_t t_vbe;
256  float vbe;
257  float dvbe;
258  float adc_val;
259  float vbe_cal;
260  float dvbe_cal;
261  float t_cal;
263  float kptat;
264  float ap;
265  float bp;
266 
268 
272 typedef struct pressure9_s
273 {
274  // Output pins
275  digital_out_t cs;
276 
277  // Modules
278  i2c_master_t i2c;
279  spi_master_t spi;
280 
281  // ctx variable
282  uint8_t slave_address;
283  pin_name_t chip_select;
286  uint8_t master_sel;
287 
288  // Pressure calibration coefficient
290 
291  // Temperature calibration coefficient
293 
294  uint32_t pressure_res;
295  uint8_t press_buf[ 20 ];
296  uint8_t temp_buf[ 3 ];
297 
299 
303 typedef struct
304 {
305  // Communication gpio pins
306  pin_name_t scl;
307  pin_name_t sda;
308  pin_name_t miso;
309  pin_name_t mosi;
310  pin_name_t sck;
311  pin_name_t cs;
312 
313  // static variable
314  uint32_t i2c_speed;
315  uint8_t i2c_address;
316 
317  uint32_t spi_speed;
318  spi_master_mode_t spi_mode;
319  spi_master_chip_select_polarity_t cs_polarity;
320 
321  uint8_t sel;
322 
324  // End types group
326 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
332 #ifdef __cplusplus
333 extern "C"{
334 #endif
335 
345 
355 
364 
375 void pressure9_generic_write ( pressure9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
376 
387 void pressure9_generic_read ( pressure9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
388 
398 void pressure9_configuration ( pressure9_t *ctx, uint8_t reg_adr, uint8_t data_in );
399 
410 int32_t pressure9_get_coefficients ( pressure9_t *ctx, uint8_t coeff );
411 
419 
427 
435 
443 
451 
452 #ifdef __cplusplus
453 }
454 #endif
455 #endif // _PRESSURE9_H_
456  // End public_function group
459 
460 // ------------------------------------------------------------------------- END
pressure9_cfg_t::mosi
pin_name_t mosi
Definition: pressure9.h:309
pressure9_press_cal_coef_t::cal_01
int32_t cal_01
Definition: pressure9.h:238
pressure9_temp_cal_coef_t::t_gain
int32_t t_gain
Definition: pressure9.h:253
pressure9_press_cal_coef_t::cal_30
int32_t cal_30
Definition: pressure9.h:241
pressure9_s::temp_buf
uint8_t temp_buf[3]
Definition: pressure9.h:296
pressure9_s::read_f
pressure9_master_io_t read_f
Definition: pressure9.h:285
pressure9_s
Click ctx object definition.
Definition: pressure9.h:273
pressure9_temp_cal_coef_t::dvbe
float dvbe
Definition: pressure9.h:257
pressure9_cfg_t::i2c_address
uint8_t i2c_address
Definition: pressure9.h:315
pressure9_update_calc_coef
void pressure9_update_calc_coef(pressure9_t *ctx)
Update all calibration coefficients.
pressure9_generic_write
void pressure9_generic_write(pressure9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
pressure9_press_cal_coef_t
Pressure calibration coefficient.
Definition: pressure9.h:235
pressure9_get_temperature_raw
int32_t pressure9_get_temperature_raw(pressure9_t *ctx)
Get Temperature Raw data.
pressure9_t
struct pressure9_s pressure9_t
Click ctx object definition.
pressure9_cfg_setup
void pressure9_cfg_setup(pressure9_cfg_t *cfg)
Config Object Initialization function.
pressure9_temp_cal_coef_t::vbe_cal_t_ref
float vbe_cal_t_ref
Definition: pressure9.h:262
pressure9_configuration
void pressure9_configuration(pressure9_t *ctx, uint8_t reg_adr, uint8_t data_in)
Writing data to the configuration registers.
pressure9_press_cal_coef_t::cal_21
int32_t cal_21
Definition: pressure9.h:244
pressure9_s::master_sel
uint8_t master_sel
Definition: pressure9.h:286
pressure9_s::pressure_res
uint32_t pressure_res
Definition: pressure9.h:294
pressure9_press_cal_coef_t::cal_11
int32_t cal_11
Definition: pressure9.h:242
pressure9_s::chip_select
pin_name_t chip_select
Definition: pressure9.h:283
pressure9_init
err_t pressure9_init(pressure9_t *ctx, pressure9_cfg_t *cfg)
Initialization function.
pressure9_cfg_t::sck
pin_name_t sck
Definition: pressure9.h:310
pressure9_s::press_buf
uint8_t press_buf[20]
Definition: pressure9.h:295
pressure9_temp_cal_coef_t
Temperature calibration coefficient.
Definition: pressure9.h:252
pressure9_press_cal_coef_t::cal_02
int32_t cal_02
Definition: pressure9.h:239
pressure9_master_io_t
void(* pressure9_master_io_t)(struct pressure9_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: pressure9.h:229
pressure9_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: pressure9.h:318
pressure9_temp_cal_coef_t::adc_val
float adc_val
Definition: pressure9.h:258
pressure9_cfg_t::spi_speed
uint32_t spi_speed
Definition: pressure9.h:317
pressure9_s::temp_coef
pressure9_temp_cal_coef_t temp_coef
Definition: pressure9.h:292
pressure9_get_pressure_raw
int32_t pressure9_get_pressure_raw(pressure9_t *ctx)
Get Pressure Raw data.
pressure9_cfg_t::miso
pin_name_t miso
Definition: pressure9.h:308
pressure9_cfg_t::cs
pin_name_t cs
Definition: pressure9.h:311
pressure9_get_coefficients
int32_t pressure9_get_coefficients(pressure9_t *ctx, uint8_t coeff)
Get calibration coefficients.
pressure9_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pressure9.h:314
pressure9_get_temperature_data
float pressure9_get_temperature_data(pressure9_t *ctx)
Get Temperature data in C.
pressure9_press_cal_coef_t::cal_20
int32_t cal_20
Definition: pressure9.h:240
pressure9_temp_cal_coef_t::bp
float bp
Definition: pressure9.h:265
pressure9_s::press_coef
pressure9_press_cal_coef_t press_coef
Definition: pressure9.h:289
pressure9_cfg_t::sel
uint8_t sel
Definition: pressure9.h:321
pressure9_temp_cal_coef_t::vbe_cal
float vbe_cal
Definition: pressure9.h:259
pressure9_press_cal_coef_t::cal_12
int32_t cal_12
Definition: pressure9.h:243
pressure9_temp_cal_coef_t::t_dvbe
int32_t t_dvbe
Definition: pressure9.h:254
pressure9_temp_cal_coef_t::ap
float ap
Definition: pressure9.h:264
pressure9_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: pressure9.h:319
pressure9_press_cal_coef_t::cal_10
int32_t cal_10
Definition: pressure9.h:237
pressure9_generic_read
void pressure9_generic_read(pressure9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
pressure9_temp_cal_coef_t::t_vbe
int32_t t_vbe
Definition: pressure9.h:255
pressure9_s::cs
digital_out_t cs
Definition: pressure9.h:275
pressure9_cfg_t
Click configuration structure definition.
Definition: pressure9.h:304
pressure9_temp_cal_coef_t::vbe
float vbe
Definition: pressure9.h:256
pressure9_press_cal_coef_t::cal_00
int32_t cal_00
Definition: pressure9.h:236
pressure9_default_cfg
void pressure9_default_cfg(pressure9_t *ctx)
Click Default Configuration function.
pressure9_cfg_t::sda
pin_name_t sda
Definition: pressure9.h:307
pressure9_temp_cal_coef_t::dvbe_cal
float dvbe_cal
Definition: pressure9.h:260
pressure9_s::spi
spi_master_t spi
Definition: pressure9.h:279
pressure9_s::write_f
pressure9_master_io_t write_f
Definition: pressure9.h:284
pressure9_get_pressure_data
float pressure9_get_pressure_data(pressure9_t *ctx)
Get Pressure data in mBar.
pressure9_s::slave_address
uint8_t slave_address
Definition: pressure9.h:282
pressure9_s::i2c
i2c_master_t i2c
Definition: pressure9.h:278
pressure9_temp_cal_coef_t::t_cal
float t_cal
Definition: pressure9.h:261
pressure9_cfg_t::scl
pin_name_t scl
Definition: pressure9.h:306
pressure9_temp_cal_coef_t::kptat
float kptat
Definition: pressure9.h:263