barometer3  2.0.0.0
barometer3.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 BAROMETER3_H
36 #define BAROMETER3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 #include "drv_spi_master.h"
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
54 #define BAROMETER3_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  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
62 
68 #define BAROMETER3_MASTER_I2C 0
69 #define BAROMETER3_MASTER_SPI 1
70 
76 #define BAROMETER3_RETVAL uint8_t
77 
78 #define BAROMETER3_OK 0x00
79 #define BAROMETER3_INIT_ERROR 0xFF
80 
86 #define BAROMETER3_I2C_SLV_ADR_GND 0x76
87 #define BAROMETER3_I2C_SLV_ADR_VCC 0x77
88 
94 #define BAROMETER3_READ_BIT_MASK 0x80
95 #define BAROMETER3_WRITE_BIT_MASK 0x7F
96 
102 #define BAROMETER3_PSR_B2 0x00
103 #define BAROMETER3_PSR_B1 0x01
104 #define BAROMETER3_PSR_B0 0x02
105 #define BAROMETER3_TMP_B2 0x03
106 #define BAROMETER3_TMP_B1 0x04
107 #define BAROMETER3_TMP_B0 0x05
108 #define BAROMETER3_PRS_CFG 0x06
109 #define BAROMETER3_TMP_CFG 0x07
110 #define BAROMETER3_MEAS_CFG 0x08
111 #define BAROMETER3_CFG_REG 0x09
112 #define BAROMETER3_INT_STS 0x0A
113 #define BAROMETER3_FIFO_STS 0x0B
114 #define BAROMETER3_RESET 0x0C
115 #define BAROMETER3_PROD_ID 0x0D
116 #define BAROMETER3_COEF_C0 0x10
117 #define BAROMETER3_COEF_C0_C1 0x11
118 #define BAROMETER3_COEF_C1 0x12
119 #define BAROMETER3_COEF_C00_MSB 0x13
120 #define BAROMETER3_COEF_C00_LSB 0x14
121 #define BAROMETER3_COEF_C00_C10 0x15
122 #define BAROMETER3_COEF_C10_MSB 0x16
123 #define BAROMETER3_COEF_C10_LSB 0x17
124 #define BAROMETER3_COEF_C01_MSB 0x18
125 #define BAROMETER3_COEF_C01_LSB 0x19
126 #define BAROMETER3_COEF_C11_MSB 0x1A
127 #define BAROMETER3_COEF_C11_LSB 0x1B
128 #define BAROMETER3_COEF_C20_MSB 0x1C
129 #define BAROMETER3_COEF_C20_LSB 0x1D
130 #define BAROMETER3_COEF_C21_MSB 0x1E
131 #define BAROMETER3_COEF_C21_LSB 0x1F
132 #define BAROMETER3_COEF_C30_MSB 0x20
133 #define BAROMETER3_COEF_C30_LSB 0x21
134 #define BAROMETER3_COEF_SRCE 0x28
135 
141 #define BAROMETER3_PM_RATE_1 0x00
142 #define BAROMETER3_PM_RATE_2 0x10
143 #define BAROMETER3_PM_RATE_4 0x20
144 #define BAROMETER3_PM_RATE_8 0x30
145 #define BAROMETER3_PM_RATE_16 0x40
146 #define BAROMETER3_PM_RATE_32 0x50
147 #define BAROMETER3_PM_RATE_64 0x60
148 #define BAROMETER3_PM_RATE_128 0x70
149 #define BAROMETER3_PM_PRC_1 0x00
150 #define BAROMETER3_PM_PRC_2 0x01
151 #define BAROMETER3_PM_PRC_4 0x02
152 #define BAROMETER3_PM_PRC_8 0x03
153 #define BAROMETER3_PM_PRC_16 0x04
154 #define BAROMETER3_PM_PRC_32 0x05
155 #define BAROMETER3_PM_PRC_64 0x06
156 #define BAROMETER3_PM_PRC_128 0x07
157 
163 #define BAROMETER3_TMP_INT 0x00
164 #define BAROMETER3_TMP_EXT 0x80
165 #define BAROMETER3_TMP_RATE_1 0x00
166 #define BAROMETER3_TMP_RATE_2 0x10
167 #define BAROMETER3_TMP_RATE_4 0x20
168 #define BAROMETER3_TMP_RATE_8 0x30
169 #define BAROMETER3_TMP_RATE_16 0x40
170 #define BAROMETER3_TMP_RATE_32 0x50
171 #define BAROMETER3_TMP_RATE_64 0x60
172 #define BAROMETER3_TMP_RATE_128 0x70
173 #define BAROMETER3_TMP_PRC_1 0x00
174 #define BAROMETER3_TMP_PRC_2 0x01
175 #define BAROMETER3_TMP_PRC_4 0x02
176 #define BAROMETER3_TMP_PRC_8 0x03
177 #define BAROMETER3_TMP_PRC_16 0x04
178 #define BAROMETER3_TMP_PRC_32 0x05
179 #define BAROMETER3_TMP_PRC_64 0x06
180 #define BAROMETER3_TMP_PRC_128 0x07
181 
187 #define BAROMETER3_COEF_RDY 0x80
188 #define BAROMETER3_SENSOR_RDY 0x40
189 #define BAROMETER3_TMP_RDY 0x20
190 #define BAROMETER3_PRS_RDY 0x10
191 #define BAROMETER3_MEAS_CTRL_IDLE 0x00
192 #define BAROMETER3_MEAS_CTRL_CMD_PM 0x01
193 #define BAROMETER3_MEAS_CTRL_CMD_TM 0x02
194 #define BAROMETER3_MEAS_CTRL_CONT_PM 0x05
195 #define BAROMETER3_MEAS_CTRL_CONT_TM 0x06
196 #define BAROMETER3_MEAS_CTRL_CONT_MEAS 0x07
197 
203 #define BAROMETER3_INT_HL_ACT_L 0x00
204 #define BAROMETER3_INT_HL_ACT_H 0x80
205 #define BAROMETER3_INT_FIFO 0x40
206 #define BAROMETER3_INT_TMP 0x20
207 #define BAROMETER3_INT_PRS 0x10
208 #define BAROMETER3_T_SHIFT 0x08
209 #define BAROMETER3_P_SHIFT 0x04
210 #define BAROMETER3_FIFO_EN 0x02
211 #define BAROMETER3_SPI_MODE_4_WIRE 0x00
212 #define BAROMETER3_SPI_MODE_3_WIRE 0x01
213 
219 #define BAROMETER3_INT_FIFO_FULL 0x04
220 #define BAROMETER3_INT_TMP_FLG 0x02
221 #define BAROMETER3_INT_PRS_FLG 0x01
222 
228 #define BAROMETER3_FIFO_FULL 0x02
229 #define BAROMETER3_FIFO_EMPTY 0x01
230 #define BAROMETER3_FIFO_SIZE 32
231 
237 #define BAROMETER3_FIFO_FLUSH 0x80
238 #define BAROMETER3_SOFT_RST 0x09
239 
245 #define BAROMETER3_TMP_COEF_SRCE 0x80
246 
252 #define BAROMETER3_SCALE_FCTR_OSR_1 524288
253 #define BAROMETER3_SCALE_FCTR_OSR_2 1572864
254 #define BAROMETER3_SCALE_FCTR_OSR_4 3670016
255 #define BAROMETER3_SCALE_FCTR_OSR_8 7864320
256 #define BAROMETER3_SCALE_FCTR_OSR_16 253952
257 #define BAROMETER3_SCALE_FCTR_OSR_32 516096
258 #define BAROMETER3_SCALE_FCTR_OSR_64 1040384
259 #define BAROMETER3_SCALE_FCTR_OSR_128 2088960
260 
266 #define BAROMETER3_SUCCESS 0
267 #define BAROMETER3_BUSY 1
268 #define BAROMETER3_MAX_BUSYTIME 990
269 #define BAROMETER3_FAIL 2
270 #define BAROMETER3_UNFIN 3
271 
277 #define BAROMETER3_SPI_DUMMY 0x00
278 
284 #define SPI_COMMUNICATION 1
285 #define I2C_COMMUNICATION 2
286 
292 #define BAROMETER3_PRODUCT_ID 0x10
293 
299 #define BAROMETER3_PASCAL_TO_MBAR 100
300  // End group macro
303 // --------------------------------------------------------------- PUBLIC TYPES
312 typedef uint8_t barometer3_select_t;
313 
317 typedef void ( *barometer3_master_io_t )( struct barometer3_s*, uint8_t, uint8_t*, uint8_t );
318 
322 typedef struct barometer3_s
323 {
324  // Input pins
325 
326  digital_in_t int_pin;
327 
328  // Output pins
329 
330  digital_out_t cs;
331 
332  // Modules
333 
334  i2c_master_t i2c;
335  spi_master_t spi;
336 
337  // ctx variable
338 
339  uint8_t slave_address;
340  pin_name_t chip_select;
344 
345  int32_t coef_c0_half;
346  int32_t coef_c1;
347  int32_t coef_c00;
348  int32_t coef_c10;
349  int32_t coef_c01;
350  int32_t coef_c11;
351  int32_t coef_c20;
352  int32_t coef_c21;
353  int32_t coef_c30;
355  uint8_t cfg_temp_mr;
356  uint8_t cfg_temp_osr;
357  uint8_t cfg_prs_mr;
358  uint8_t cfg_prs_osr;
359  uint8_t cfg_temp_sens;
360  uint8_t cfg_op_mode;
361 
363 
364 } barometer3_t;
365 
369 typedef struct
370 {
371  // Communication gpio pins
372 
373  pin_name_t scl;
374  pin_name_t sda;
375  pin_name_t miso;
376  pin_name_t mosi;
377  pin_name_t sck;
378  pin_name_t cs;
379 
380  // Additional gpio pins
381 
382  pin_name_t int_pin;
383 
384  // static variable
385 
386  uint32_t i2c_speed;
387  uint8_t i2c_address;
388 
389  uint32_t spi_speed;
390  spi_master_mode_t spi_mode;
391  spi_master_chip_select_polarity_t cs_polarity;
392 
394 
396  // End types group
398 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
404 #ifdef __cplusplus
405 extern "C"{
406 #endif
407 
417 
426 
437 void barometer3_generic_write ( barometer3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
438 
449 void barometer3_generic_read ( barometer3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
450 
462 uint8_t barometer3_read_byte ( barometer3_t *ctx, uint8_t reg_adr );
463 
472 
481 void barometer3_set_op_mode ( barometer3_t *ctx, uint8_t op_mode );
482 
490 void barometer3_flush_fifo ( barometer3_t *ctx );
491 
500 
508 void barometer3_standby ( barometer3_t *ctx );
509 
519 void barometer3_cfg_temp ( barometer3_t *ctx, uint8_t temp_mr, uint8_t temp_osr );
520 
530 void barometer3_cfg_pres ( barometer3_t *ctx, uint8_t prs_mr, uint8_t prs_osr );
531 
546 uint8_t barometer3_st_meas_temp_once ( barometer3_t *ctx, uint8_t temp_osr );
547 
562 uint8_t barometer3_st_meas_pres_once ( barometer3_t *ctx, uint8_t prs_osr );
563 
573 void barometer3_get_raw_res ( barometer3_t *ctx, uint8_t reg_adr, int32_t *raw );
574 
585 float barometer3_calc_temp ( int32_t raw );
586 
597 float barometer3_calc_pres ( int32_t raw );
598 
613 uint8_t barometer3_get_single_res ( barometer3_t *ctx, float *result );
614 
631 uint8_t barometer3_meas_temp_once ( barometer3_t *ctx, float *result, uint8_t temp_osr );
632 
649 uint8_t barometer3_meas_prs_once ( barometer3_t *ctx, float *result, uint8_t prs_osr );
650 
658 void barometer3_def_cfg ( barometer3_t *ctx );
659 
674 uint8_t barometer3_get_fifo_val ( barometer3_t *ctx, int32_t *value );
675 
693 uint8_t barometer3_get_cont_res ( barometer3_t *ctx, float *temp_buf, float *prs_buf );
694 
707 uint8_t barometer3_check_int ( barometer3_t *ctx );
708 
709 #ifdef __cplusplus
710 }
711 #endif
712 #endif // _BAROMETER3_H_
713  // End public_function group
716 
717 // ------------------------------------------------------------------------- END
barometer3_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: barometer3.h:390
barometer3_s::coef_temp_scal
float coef_temp_scal
Definition: barometer3.h:354
barometer3_s::chip_select
pin_name_t chip_select
Definition: barometer3.h:340
barometer3_s::coef_c30
int32_t coef_c30
Definition: barometer3.h:353
barometer3_s
Click ctx object definition.
Definition: barometer3.h:322
barometer3_master_io_t
void(* barometer3_master_io_t)(struct barometer3_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: barometer3.h:317
barometer3_flush_fifo
void barometer3_flush_fifo(barometer3_t *ctx)
Flush FIFO function.
barometer3_cfg_t::cs
pin_name_t cs
Definition: barometer3.h:378
barometer3_cfg_t
Click configuration structure definition.
Definition: barometer3.h:369
barometer3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: barometer3.h:386
barometer3_s::i2c
i2c_master_t i2c
Definition: barometer3.h:334
barometer3_generic_write
void barometer3_generic_write(barometer3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
barometer3_s::coef_c10
int32_t coef_c10
Definition: barometer3.h:348
barometer3_st_meas_pres_once
uint8_t barometer3_st_meas_pres_once(barometer3_t *ctx, uint8_t prs_osr)
Start Measure Pressure Once function.
barometer3_cfg_t::spi_speed
uint32_t spi_speed
Definition: barometer3.h:389
barometer3_set_op_mode
void barometer3_set_op_mode(barometer3_t *ctx, uint8_t op_mode)
Set mode of operation function.
barometer3_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: barometer3.h:391
barometer3_get_cont_res
uint8_t barometer3_get_cont_res(barometer3_t *ctx, float *temp_buf, float *prs_buf)
Get Continuous results function.
barometer3_s::master_sel
barometer3_select_t master_sel
Definition: barometer3.h:343
barometer3_cfg_temp
void barometer3_cfg_temp(barometer3_t *ctx, uint8_t temp_mr, uint8_t temp_osr)
Temperature Measurement Configuration function.
barometer3_get_raw_res
void barometer3_get_raw_res(barometer3_t *ctx, uint8_t reg_adr, int32_t *raw)
Get Raw Measurement results.
barometer3_cfg_t::int_pin
pin_name_t int_pin
Definition: barometer3.h:382
barometer3_s::cfg_temp_mr
uint8_t cfg_temp_mr
Definition: barometer3.h:355
barometer3_cfg_t::i2c_address
uint8_t i2c_address
Definition: barometer3.h:387
barometer3_calc_pres
float barometer3_calc_pres(int32_t raw)
Pressure Calculation function.
barometer3_s::read_f
barometer3_master_io_t read_f
Definition: barometer3.h:342
barometer3_disable_fifo
void barometer3_disable_fifo(barometer3_t *ctx)
Disable FIFO function.
barometer3_cfg_t::sda
pin_name_t sda
Definition: barometer3.h:374
barometer3_st_meas_temp_once
uint8_t barometer3_st_meas_temp_once(barometer3_t *ctx, uint8_t temp_osr)
Start Measure Temperature Once function.
barometer3_s::cfg_prs_osr
uint8_t cfg_prs_osr
Definition: barometer3.h:358
barometer3_meas_prs_once
uint8_t barometer3_meas_prs_once(barometer3_t *ctx, float *result, uint8_t prs_osr)
Get Pressure Measurement Once function.
barometer3_cfg_setup
void barometer3_cfg_setup(barometer3_cfg_t *cfg)
Config Object Initialization function.
barometer3_cfg_t::sel
barometer3_select_t sel
Definition: barometer3.h:393
barometer3_s::coef_c0_half
int32_t coef_c0_half
Definition: barometer3.h:345
barometer3_s::write_f
barometer3_master_io_t write_f
Definition: barometer3.h:341
barometer3_calc_temp
float barometer3_calc_temp(int32_t raw)
Temperature Calculation function.
barometer3_cfg_pres
void barometer3_cfg_pres(barometer3_t *ctx, uint8_t prs_mr, uint8_t prs_osr)
Pressure Measurement Configuration function.
barometer3_s::coef_c01
int32_t coef_c01
Definition: barometer3.h:349
barometer3_s::cfg_op_mode
uint8_t cfg_op_mode
Definition: barometer3.h:360
barometer3_s::cfg_prs_mr
uint8_t cfg_prs_mr
Definition: barometer3.h:357
barometer3_s::coef_c20
int32_t coef_c20
Definition: barometer3.h:351
barometer3_generic_read
void barometer3_generic_read(barometer3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
barometer3_read_coeffs
void barometer3_read_coeffs(barometer3_t *ctx)
Read Calculation Coefficients function.
barometer3_s::int_pin
digital_in_t int_pin
Definition: barometer3.h:326
barometer3_get_single_res
uint8_t barometer3_get_single_res(barometer3_t *ctx, float *result)
Get Single measurement function.
barometer3_get_fifo_val
uint8_t barometer3_get_fifo_val(barometer3_t *ctx, int32_t *value)
Get FIFO Value function.
barometer3_s::coef_c21
int32_t coef_c21
Definition: barometer3.h:352
barometer3_select_t
uint8_t barometer3_select_t
Communication type.
Definition: barometer3.h:312
barometer3_s::cfg_temp_osr
uint8_t cfg_temp_osr
Definition: barometer3.h:356
barometer3_cfg_t::sck
pin_name_t sck
Definition: barometer3.h:377
barometer3_read_byte
uint8_t barometer3_read_byte(barometer3_t *ctx, uint8_t reg_adr)
Read byte function.
BAROMETER3_RETVAL
#define BAROMETER3_RETVAL
Definition: barometer3.h:76
barometer3_standby
void barometer3_standby(barometer3_t *ctx)
Standby function.
barometer3_s::slave_address
uint8_t slave_address
Definition: barometer3.h:339
barometer3_s::cs
digital_out_t cs
Definition: barometer3.h:330
barometer3_s::coef_c11
int32_t coef_c11
Definition: barometer3.h:350
barometer3_s::spi
spi_master_t spi
Definition: barometer3.h:335
barometer3_s::cfg_temp_sens
uint8_t cfg_temp_sens
Definition: barometer3.h:359
barometer3_s::coef_c00
int32_t coef_c00
Definition: barometer3.h:347
barometer3_s::coef_c1
int32_t coef_c1
Definition: barometer3.h:346
barometer3_cfg_t::miso
pin_name_t miso
Definition: barometer3.h:375
barometer3_init
BAROMETER3_RETVAL barometer3_init(barometer3_t *ctx, barometer3_cfg_t *cfg)
Initialization function.
barometer3_cfg_t::scl
pin_name_t scl
Definition: barometer3.h:373
barometer3_t
struct barometer3_s barometer3_t
Click ctx object definition.
barometer3_cfg_t::mosi
pin_name_t mosi
Definition: barometer3.h:376
barometer3_meas_temp_once
uint8_t barometer3_meas_temp_once(barometer3_t *ctx, float *result, uint8_t temp_osr)
Get Temperature Measurement Once function.
barometer3_check_int
uint8_t barometer3_check_int(barometer3_t *ctx)
Check interrupt ststus function.
barometer3_def_cfg
void barometer3_def_cfg(barometer3_t *ctx)
Apply Default Configuration function.
barometer3_s::communication_interface
uint8_t communication_interface
Definition: barometer3.h:362