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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 #include "drv_spi_master.h"
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
64 #define BAROMETER3_MAP_MIKROBUS( cfg, mikrobus ) \
65  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
66  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
67  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
68  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
69  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
70  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
71  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
72 
78 #define BAROMETER3_MASTER_I2C 0
79 #define BAROMETER3_MASTER_SPI 1
80 
86 #define BAROMETER3_RETVAL uint8_t
87 
88 #define BAROMETER3_OK 0x00
89 #define BAROMETER3_INIT_ERROR 0xFF
90 
96 #define BAROMETER3_I2C_SLV_ADR_GND 0x76
97 #define BAROMETER3_I2C_SLV_ADR_VCC 0x77
98 
104 #define BAROMETER3_READ_BIT_MASK 0x80
105 #define BAROMETER3_WRITE_BIT_MASK 0x7F
106 
112 #define BAROMETER3_PSR_B2 0x00
113 #define BAROMETER3_PSR_B1 0x01
114 #define BAROMETER3_PSR_B0 0x02
115 #define BAROMETER3_TMP_B2 0x03
116 #define BAROMETER3_TMP_B1 0x04
117 #define BAROMETER3_TMP_B0 0x05
118 #define BAROMETER3_PRS_CFG 0x06
119 #define BAROMETER3_TMP_CFG 0x07
120 #define BAROMETER3_MEAS_CFG 0x08
121 #define BAROMETER3_CFG_REG 0x09
122 #define BAROMETER3_INT_STS 0x0A
123 #define BAROMETER3_FIFO_STS 0x0B
124 #define BAROMETER3_RESET 0x0C
125 #define BAROMETER3_PROD_ID 0x0D
126 #define BAROMETER3_COEF_C0 0x10
127 #define BAROMETER3_COEF_C0_C1 0x11
128 #define BAROMETER3_COEF_C1 0x12
129 #define BAROMETER3_COEF_C00_MSB 0x13
130 #define BAROMETER3_COEF_C00_LSB 0x14
131 #define BAROMETER3_COEF_C00_C10 0x15
132 #define BAROMETER3_COEF_C10_MSB 0x16
133 #define BAROMETER3_COEF_C10_LSB 0x17
134 #define BAROMETER3_COEF_C01_MSB 0x18
135 #define BAROMETER3_COEF_C01_LSB 0x19
136 #define BAROMETER3_COEF_C11_MSB 0x1A
137 #define BAROMETER3_COEF_C11_LSB 0x1B
138 #define BAROMETER3_COEF_C20_MSB 0x1C
139 #define BAROMETER3_COEF_C20_LSB 0x1D
140 #define BAROMETER3_COEF_C21_MSB 0x1E
141 #define BAROMETER3_COEF_C21_LSB 0x1F
142 #define BAROMETER3_COEF_C30_MSB 0x20
143 #define BAROMETER3_COEF_C30_LSB 0x21
144 #define BAROMETER3_COEF_SRCE 0x28
145 
151 #define BAROMETER3_PM_RATE_1 0x00
152 #define BAROMETER3_PM_RATE_2 0x10
153 #define BAROMETER3_PM_RATE_4 0x20
154 #define BAROMETER3_PM_RATE_8 0x30
155 #define BAROMETER3_PM_RATE_16 0x40
156 #define BAROMETER3_PM_RATE_32 0x50
157 #define BAROMETER3_PM_RATE_64 0x60
158 #define BAROMETER3_PM_RATE_128 0x70
159 #define BAROMETER3_PM_PRC_1 0x00
160 #define BAROMETER3_PM_PRC_2 0x01
161 #define BAROMETER3_PM_PRC_4 0x02
162 #define BAROMETER3_PM_PRC_8 0x03
163 #define BAROMETER3_PM_PRC_16 0x04
164 #define BAROMETER3_PM_PRC_32 0x05
165 #define BAROMETER3_PM_PRC_64 0x06
166 #define BAROMETER3_PM_PRC_128 0x07
167 
173 #define BAROMETER3_TMP_INT 0x00
174 #define BAROMETER3_TMP_EXT 0x80
175 #define BAROMETER3_TMP_RATE_1 0x00
176 #define BAROMETER3_TMP_RATE_2 0x10
177 #define BAROMETER3_TMP_RATE_4 0x20
178 #define BAROMETER3_TMP_RATE_8 0x30
179 #define BAROMETER3_TMP_RATE_16 0x40
180 #define BAROMETER3_TMP_RATE_32 0x50
181 #define BAROMETER3_TMP_RATE_64 0x60
182 #define BAROMETER3_TMP_RATE_128 0x70
183 #define BAROMETER3_TMP_PRC_1 0x00
184 #define BAROMETER3_TMP_PRC_2 0x01
185 #define BAROMETER3_TMP_PRC_4 0x02
186 #define BAROMETER3_TMP_PRC_8 0x03
187 #define BAROMETER3_TMP_PRC_16 0x04
188 #define BAROMETER3_TMP_PRC_32 0x05
189 #define BAROMETER3_TMP_PRC_64 0x06
190 #define BAROMETER3_TMP_PRC_128 0x07
191 
197 #define BAROMETER3_COEF_RDY 0x80
198 #define BAROMETER3_SENSOR_RDY 0x40
199 #define BAROMETER3_TMP_RDY 0x20
200 #define BAROMETER3_PRS_RDY 0x10
201 #define BAROMETER3_MEAS_CTRL_IDLE 0x00
202 #define BAROMETER3_MEAS_CTRL_CMD_PM 0x01
203 #define BAROMETER3_MEAS_CTRL_CMD_TM 0x02
204 #define BAROMETER3_MEAS_CTRL_CONT_PM 0x05
205 #define BAROMETER3_MEAS_CTRL_CONT_TM 0x06
206 #define BAROMETER3_MEAS_CTRL_CONT_MEAS 0x07
207 
213 #define BAROMETER3_INT_HL_ACT_L 0x00
214 #define BAROMETER3_INT_HL_ACT_H 0x80
215 #define BAROMETER3_INT_FIFO 0x40
216 #define BAROMETER3_INT_TMP 0x20
217 #define BAROMETER3_INT_PRS 0x10
218 #define BAROMETER3_T_SHIFT 0x08
219 #define BAROMETER3_P_SHIFT 0x04
220 #define BAROMETER3_FIFO_EN 0x02
221 #define BAROMETER3_SPI_MODE_4_WIRE 0x00
222 #define BAROMETER3_SPI_MODE_3_WIRE 0x01
223 
229 #define BAROMETER3_INT_FIFO_FULL 0x04
230 #define BAROMETER3_INT_TMP_FLG 0x02
231 #define BAROMETER3_INT_PRS_FLG 0x01
232 
238 #define BAROMETER3_FIFO_FULL 0x02
239 #define BAROMETER3_FIFO_EMPTY 0x01
240 #define BAROMETER3_FIFO_SIZE 32
241 
247 #define BAROMETER3_FIFO_FLUSH 0x80
248 #define BAROMETER3_SOFT_RST 0x09
249 
255 #define BAROMETER3_TMP_COEF_SRCE 0x80
256 
262 #define BAROMETER3_SCALE_FCTR_OSR_1 524288
263 #define BAROMETER3_SCALE_FCTR_OSR_2 1572864
264 #define BAROMETER3_SCALE_FCTR_OSR_4 3670016
265 #define BAROMETER3_SCALE_FCTR_OSR_8 7864320
266 #define BAROMETER3_SCALE_FCTR_OSR_16 253952
267 #define BAROMETER3_SCALE_FCTR_OSR_32 516096
268 #define BAROMETER3_SCALE_FCTR_OSR_64 1040384
269 #define BAROMETER3_SCALE_FCTR_OSR_128 2088960
270 
276 #define BAROMETER3_SUCCESS 0
277 #define BAROMETER3_BUSY 1
278 #define BAROMETER3_MAX_BUSYTIME 990
279 #define BAROMETER3_FAIL 2
280 #define BAROMETER3_UNFIN 3
281 
287 #define BAROMETER3_SPI_DUMMY 0x00
288 
294 #define SPI_COMMUNICATION 1
295 #define I2C_COMMUNICATION 2
296 
302 #define BAROMETER3_PRODUCT_ID 0x10
303 
309 #define BAROMETER3_PASCAL_TO_MBAR 100
310  // End group macro
313 // --------------------------------------------------------------- PUBLIC TYPES
322 typedef uint8_t barometer3_select_t;
323 
327 typedef void ( *barometer3_master_io_t )( struct barometer3_s*, uint8_t, uint8_t*, uint8_t );
328 
332 typedef struct barometer3_s
333 {
334  // Input pins
335 
336  digital_in_t int_pin;
337 
338  // Output pins
339 
340  digital_out_t cs;
341 
342  // Modules
343 
344  i2c_master_t i2c;
345  spi_master_t spi;
346 
347  // ctx variable
348 
349  uint8_t slave_address;
350  pin_name_t chip_select;
354 
355  int32_t coef_c0_half;
356  int32_t coef_c1;
357  int32_t coef_c00;
358  int32_t coef_c10;
359  int32_t coef_c01;
360  int32_t coef_c11;
361  int32_t coef_c20;
362  int32_t coef_c21;
363  int32_t coef_c30;
365  uint8_t cfg_temp_mr;
366  uint8_t cfg_temp_osr;
367  uint8_t cfg_prs_mr;
368  uint8_t cfg_prs_osr;
369  uint8_t cfg_temp_sens;
370  uint8_t cfg_op_mode;
371 
373 
375 
379 typedef struct
380 {
381  // Communication gpio pins
382 
383  pin_name_t scl;
384  pin_name_t sda;
385  pin_name_t miso;
386  pin_name_t mosi;
387  pin_name_t sck;
388  pin_name_t cs;
389 
390  // Additional gpio pins
391 
392  pin_name_t int_pin;
393 
394  // static variable
395 
396  uint32_t i2c_speed;
397  uint8_t i2c_address;
398 
399  uint32_t spi_speed;
400  spi_master_mode_t spi_mode;
401  spi_master_chip_select_polarity_t cs_polarity;
402 
404 
406  // End types group
408 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
414 #ifdef __cplusplus
415 extern "C"{
416 #endif
417 
427 
436 
447 void barometer3_generic_write ( barometer3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
448 
459 void barometer3_generic_read ( barometer3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
460 
472 uint8_t barometer3_read_byte ( barometer3_t *ctx, uint8_t reg_adr );
473 
482 
491 void barometer3_set_op_mode ( barometer3_t *ctx, uint8_t op_mode );
492 
501 
510 
519 
529 void barometer3_cfg_temp ( barometer3_t *ctx, uint8_t temp_mr, uint8_t temp_osr );
530 
540 void barometer3_cfg_pres ( barometer3_t *ctx, uint8_t prs_mr, uint8_t prs_osr );
541 
556 uint8_t barometer3_st_meas_temp_once ( barometer3_t *ctx, uint8_t temp_osr );
557 
572 uint8_t barometer3_st_meas_pres_once ( barometer3_t *ctx, uint8_t prs_osr );
573 
583 void barometer3_get_raw_res ( barometer3_t *ctx, uint8_t reg_adr, int32_t *raw );
584 
595 float barometer3_calc_temp ( barometer3_t *ctx, int32_t raw );
596 
607 float barometer3_calc_pres ( barometer3_t *ctx, int32_t raw );
608 
623 uint8_t barometer3_get_single_res ( barometer3_t *ctx, float *result );
624 
641 uint8_t barometer3_meas_temp_once ( barometer3_t *ctx, float *result, uint8_t temp_osr );
642 
659 uint8_t barometer3_meas_prs_once ( barometer3_t *ctx, float *result, uint8_t prs_osr );
660 
669 
684 uint8_t barometer3_get_fifo_val ( barometer3_t *ctx, int32_t *value );
685 
703 uint8_t barometer3_get_cont_res ( barometer3_t *ctx, float *temp_buf, float *prs_buf );
704 
718 
719 #ifdef __cplusplus
720 }
721 #endif
722 #endif // _BAROMETER3_H_
723  // End public_function group
726 
727 // ------------------------------------------------------------------------- END
barometer3_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: barometer3.h:400
barometer3_s::coef_temp_scal
float coef_temp_scal
Definition: barometer3.h:364
barometer3_s::chip_select
pin_name_t chip_select
Definition: barometer3.h:350
barometer3_s::coef_c30
int32_t coef_c30
Definition: barometer3.h:363
barometer3_s
Click ctx object definition.
Definition: barometer3.h:333
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:327
barometer3_flush_fifo
void barometer3_flush_fifo(barometer3_t *ctx)
Flush FIFO function.
barometer3_cfg_t::cs
pin_name_t cs
Definition: barometer3.h:388
barometer3_cfg_t
Click configuration structure definition.
Definition: barometer3.h:380
barometer3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: barometer3.h:396
barometer3_s::i2c
i2c_master_t i2c
Definition: barometer3.h:344
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:358
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:399
barometer3_t
struct barometer3_s barometer3_t
Click ctx object definition.
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:401
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:353
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:392
barometer3_s::cfg_temp_mr
uint8_t cfg_temp_mr
Definition: barometer3.h:365
barometer3_cfg_t::i2c_address
uint8_t i2c_address
Definition: barometer3.h:397
barometer3_s::read_f
barometer3_master_io_t read_f
Definition: barometer3.h:352
barometer3_disable_fifo
void barometer3_disable_fifo(barometer3_t *ctx)
Disable FIFO function.
barometer3_cfg_t::sda
pin_name_t sda
Definition: barometer3.h:384
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:368
barometer3_calc_temp
float barometer3_calc_temp(barometer3_t *ctx, int32_t raw)
Temperature Calculation function.
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:403
barometer3_s::coef_c0_half
int32_t coef_c0_half
Definition: barometer3.h:355
barometer3_s::write_f
barometer3_master_io_t write_f
Definition: barometer3.h:351
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:359
barometer3_s::cfg_op_mode
uint8_t cfg_op_mode
Definition: barometer3.h:370
barometer3_s::cfg_prs_mr
uint8_t cfg_prs_mr
Definition: barometer3.h:367
barometer3_s::coef_c20
int32_t coef_c20
Definition: barometer3.h:361
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:336
barometer3_get_single_res
uint8_t barometer3_get_single_res(barometer3_t *ctx, float *result)
Get Single measurement function.
barometer3_calc_pres
float barometer3_calc_pres(barometer3_t *ctx, int32_t raw)
Pressure Calculation 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:362
barometer3_select_t
uint8_t barometer3_select_t
Communication type.
Definition: barometer3.h:322
barometer3_s::cfg_temp_osr
uint8_t cfg_temp_osr
Definition: barometer3.h:366
barometer3_cfg_t::sck
pin_name_t sck
Definition: barometer3.h:387
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:86
barometer3_standby
void barometer3_standby(barometer3_t *ctx)
Standby function.
barometer3_s::slave_address
uint8_t slave_address
Definition: barometer3.h:349
barometer3_s::cs
digital_out_t cs
Definition: barometer3.h:340
barometer3_s::coef_c11
int32_t coef_c11
Definition: barometer3.h:360
barometer3_s::spi
spi_master_t spi
Definition: barometer3.h:345
barometer3_s::cfg_temp_sens
uint8_t cfg_temp_sens
Definition: barometer3.h:369
barometer3_s::coef_c00
int32_t coef_c00
Definition: barometer3.h:357
barometer3_s::coef_c1
int32_t coef_c1
Definition: barometer3.h:356
barometer3_cfg_t::miso
pin_name_t miso
Definition: barometer3.h:385
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:383
barometer3_cfg_t::mosi
pin_name_t mosi
Definition: barometer3.h:386
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:372