pressure3  2.0.0.0
pressure3.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 PRESSURE3_H
36 #define PRESSURE3_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 PRESSURE3_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 PRESSURE3_MASTER_I2C 0
69 #define PRESSURE3_MASTER_SPI 1
70 
76 #define PRESSURE3_RETVAL uint8_t
77 
78 #define PRESSURE3_OK 0x00
79 #define PRESSURE3_INIT_ERROR 0xFF
80 
86 #define PRESSURE3_I2C_SELECT 0
87 #define PRESSURE3_SPI_SELECT 1
88 #define PRESSURE3_SPI_CMD_WRITE 0x7F
89 #define PRESSURE3_SPI_CMD_READ 0x80
90 
96 #define PRESSURE3_I2C_ADDRESS 0x76
97 #define PRESSURE3_REG_PSR_B2 0x00
98 #define PRESSURE3_REG_PSR_B1 0x01
99 #define PRESSURE3_REG_PSR_B0 0x02
100 #define PRESSURE3_REG_TMP_B2 0x03
101 #define PRESSURE3_REG_TMP_B1 0x04
102 #define PRESSURE3_REG_TMP_B0 0x05
103 #define PRESSURE3_REG_PRS_CFG 0x06
104 #define PRESSURE3_REG_TMP_CFG 0x07
105 #define PRESSURE3_REG_MEAS_CFG 0x08
106 #define PRESSURE3_REG_CFG_REG 0x09
107 #define PRESSURE3_REG_INT_STS 0x0A
108 #define PRESSURE3_REG_FIFO_STS 0x0B
109 #define PRESSURE3_REG_RESET 0x0C
110 #define PRESSURE3_REG_PRODUCT_ID 0x0D
111 #define PRESSURE3_REG_COEF_C0_MBS 0x10
112 #define PRESSURE3_REG_COEF_C0_LBS_C1_MBS 0x11
113 #define PRESSURE3_REG_COEF_C1_LBS 0x12
114 #define PRESSURE3_REG_COEF_C00_MBS 0x13
115 #define PRESSURE3_REG_COEF_C00_LSB 0x14
116 #define PRESSURE3_REG_COEF_C00_XLSB_C10_MSB 0x15
117 #define PRESSURE3_REG_COEF_C10_LSB 0x16
118 #define PRESSURE3_REG_COEF_C10_XLSB 0x17
119 #define PRESSURE3_REG_COEF_C01_MSB 0x18
120 #define PRESSURE3_REG_COEF_C01_LSB 0x19
121 #define PRESSURE3_REG_COEF_C11_MSB 0x1A
122 #define PRESSURE3_REG_COEF_C11_LSB 0x1B
123 #define PRESSURE3_REG_COEF_C20_MSB 0x1C
124 #define PRESSURE3_REG_COEF_C20_LSB 0x1D
125 #define PRESSURE3_REG_COEF_C21_MSB 0x1E
126 #define PRESSURE3_REG_COEF_C21_LSB 0x1F
127 #define PRESSURE3_REG_COEF_C30_MSB 0x20
128 #define PRESSURE3_REG_COEF_C30_LSB 0x21
129 #define PRESSURE3_REG_COEF_SRCE 0x28
130 
136 #define PRESSURE3_BIT_MASK_PM_RATE_1_PER_SEC 0x00
137 #define PRESSURE3_BIT_MASK_PM_RATE_2_PER_SEC 0x10
138 #define PRESSURE3_BIT_MASK_PM_RATE_4_PER_SEC 0x20
139 #define PRESSURE3_BIT_MASK_PM_RATE_8_PER_SEC 0x30
140 #define PRESSURE3_BIT_MASK_PM_RATE_16_PER_SEC 0x40
141 #define PRESSURE3_BIT_MASK_PM_RATE_32_PER_SEC 0x50
142 #define PRESSURE3_BIT_MASK_PM_RATE_64_PER_SEC 0x60
143 #define PRESSURE3_BIT_MASK_PM_RATE_128_PER_SEC 0x70
144 #define PRESSURE3_BIT_MASK_PM_PRC_1_PER_SEC 0x00
145 #define PRESSURE3_BIT_MASK_PM_PRC_2_PER_SEC 0x01
146 #define PRESSURE3_BIT_MASK_PM_PRC_4_PER_SEC 0x02
147 #define PRESSURE3_BIT_MASK_PM_PRC_8_PER_SEC 0x03
148 #define PRESSURE3_BIT_MASK_PM_PRC_16_PER_SEC 0x04
149 #define PRESSURE3_BIT_MASK_PM_PRC_32_PER_SEC 0x05
150 #define PRESSURE3_BIT_MASK_PM_PRC_64_PER_SEC 0x06
151 #define PRESSURE3_BIT_MASK_PM_PRC_128_PER_SEC 0x07
152 
158 #define PRESSURE3_BIT_MASK_TMP_EXT_INTERNAL_SENSOR 0x00
159 #define PRESSURE3_BIT_MASK_TMP_EXT_EXTERNAL_SENSOR 0x80
160 #define PRESSURE3_BIT_MASK_TMP_RATE_1_PER_SEC 0x00
161 #define PRESSURE3_BIT_MASK_TMP_RATE_2_PER_SEC 0x10
162 #define PRESSURE3_BIT_MASK_TMP_RATE_4_PER_SEC 0x20
163 #define PRESSURE3_BIT_MASK_TMP_RATE_8_PER_SEC 0x30
164 #define PRESSURE3_BIT_MASK_TMP_RATE_16_PER_SEC 0x40
165 #define PRESSURE3_BIT_MASK_TMP_RATE_32_PER_SEC 0x50
166 #define PRESSURE3_BIT_MASK_TMP_RATE_64_PER_SEC 0x60
167 #define PRESSURE3_BIT_MASK_TMP_RATE_128_PER_SEC 0x70
168 #define PRESSURE3_BIT_MASK_TMP_PRC_1_PER_SEC 0x00
169 #define PRESSURE3_BIT_MASK_TMP_PRC_2_PER_SEC 0x01
170 #define PRESSURE3_BIT_MASK_TMP_PRC_4_PER_SEC 0x02
171 #define PRESSURE3_BIT_MASK_TMP_PRC_8_PER_SEC 0x03
172 #define PRESSURE3_BIT_MASK_TMP_PRC_16_PER_SEC 0x04
173 #define PRESSURE3_BIT_MASK_TMP_PRC_32_PER_SEC 0x05
174 #define PRESSURE3_BIT_MASK_TMP_PRC_64_PER_SEC 0x06
175 #define PRESSURE3_BIT_MASK_TMP_PRC_128_PER_SEC 0x07
176 
182 #define PRESSURE3_BIT_MASK_MEAS_CFG_COEF_RDY_AVB 0x80
183 #define PRESSURE3_BIT_MASK_MEAS_CFG_COEF_RDY_NO_AVB 0x00
184 #define PRESSURE3_BIT_MASK_MEAS_CFG_SENSOR_RDY_CMP 0x40
185 #define PRESSURE3_BIT_MASK_MEAS_CFG_SENSOR_RDY_NO_CMP 0x00
186 #define PRESSURE3_BIT_MASK_MEAS_CFG_TMP_RDY 0x20
187 #define PRESSURE3_BIT_MASK_MEAS_CFG_PRS_RDY 0x10
188 #define PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_IDLE 0x00
189 #define PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_PRS 0x01
190 #define PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_TMP 0x02
191 #define PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_CNT_PRS 0x05
192 #define PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_CNT_TMP 0x06
193 #define PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_CNT_PRS_TMP 0x07
194 
200 #define PRESSURE3_BIT_MASK_CFG_REG_INT_HL_LOW 0x00
201 #define PRESSURE3_BIT_MASK_CFG_REG_INT_HL_HIGH 0x80
202 #define PRESSURE3_BIT_MASK_CFG_REG_INT_FIFO_DISABLE 0x00
203 #define PRESSURE3_BIT_MASK_CFG_REG_INT_FIFO_ENABLE 0x40
204 #define PRESSURE3_BIT_MASK_CFG_REG_INT_TMP_DISABLE 0x00
205 #define PRESSURE3_BIT_MASK_CFG_REG_INT_TMP_ENABLE 0x20
206 #define PRESSURE3_BIT_MASK_CFG_REG_INT_PRS_DISABLE 0x00
207 #define PRESSURE3_BIT_MASK_CFG_REG_INT_PRS_ENABLE 0x10
208 #define PRESSURE3_BIT_MASK_CFG_REG_T_SHIFT_NO_SHIFT 0x00
209 #define PRESSURE3_BIT_MASK_CFG_REG_T_SHIFT_SHIFT 0x08
210 #define PRESSURE3_BIT_MASK_CFG_REG_P_SHIFT_NO_SHIFT 0x00
211 #define PRESSURE3_BIT_MASK_CFG_REG_P_SHIFT_SHIFT 0x04
212 #define PRESSURE3_BIT_MASK_CFG_REG_FIFO_EN_DISABLE 0x00
213 #define PRESSURE3_BIT_MASK_CFG_REG_FIFO_EN_ENABLE 0x02
214 #define PRESSURE3_BIT_MASK_CFG_REG_SPI_MODE_DISABLE 0x00
215 #define PRESSURE3_BIT_MASK_CFG_REG_SPI_MODE_ENABLE 0x01
216 
222 #define PRESSURE3_BIT_MASK_INT_STS_INT_FIFO_FULL_NO_ACTIVE 0x00
223 #define PRESSURE3_BIT_MASK_INT_STS_INT_FIFO_FULL_ACTIVE 0x04
224 #define PRESSURE3_BIT_MASK_INT_STS_INT_TMP_NO_ACTIVE 0x00
225 #define PRESSURE3_BIT_MASK_INT_STS_INT_TMP_ACTIVE 0x02
226 #define PRESSURE3_BIT_MASK_INT_STS_INT_PRS_NO_ACTIVE 0x00
227 #define PRESSURE3_BIT_MASK_INT_STS_INT_PRS_ACTIVE 0x01
228 
234 #define PRESSURE3_BIT_MASK_FIFO_STS_FIFO_FULL_NO 0x00
235 #define PRESSURE3_BIT_MASK_FIFO_STS_FIFO_FULL_FULL 0x02
236 #define PRESSURE3_BIT_MASK_FIFO_STS_FIFO_EMPTY_NO 0x00
237 #define PRESSURE3_BIT_MASK_FIFO_STS_FIFO_EMPTY_EMPTY 0x01
238 
244 #define PRESSURE3_BIT_MASK_RESET_SOFT_RST 0x09
245 
251 #define PRESSURE3_BIT_MASK_TMP_COEF_SRCE_INTERNAL_SENSOR 0x00
252 #define PRESSURE3_BIT_MASK_TMP_COEF_SRCE_EXTERNAL_SENSOR 0x80
253  // End group macro
256 // --------------------------------------------------------------- PUBLIC TYPES
265 typedef uint8_t pressure3_select_t;
266 
270 typedef void ( *pressure3_master_io_t )( struct pressure3_s*, uint8_t, uint8_t*, uint8_t );
271 
275 typedef struct
276 {
277  int16_t coeff_c0;
278  int16_t coeff_c1;
279  int32_t coeff_c00;
280  int32_t coeff_c10;
281  int16_t coeff_c01;
282  int16_t coeff_c11;
283  int16_t coeff_c20;
284  int16_t coeff_c21;
285  int16_t coeff_c30;
286 
288 
292 typedef struct pressure3_s
293 {
294  // Output pins
295 
296  digital_out_t cs;
297 
298  // Input pins
299 
300  digital_in_t int_pin;
301 
302  // Modules
303 
304  i2c_master_t i2c;
305  spi_master_t spi;
306 
307  // ctx variable
308 
309  uint8_t slave_address;
310  pin_name_t chip_select;
314 
315 } pressure3_t;
316 
320 typedef struct
321 {
322  // Communication gpio pins
323 
324  pin_name_t scl;
325  pin_name_t sda;
326  pin_name_t miso;
327  pin_name_t mosi;
328  pin_name_t sck;
329  pin_name_t cs;
330 
331  // Additional gpio pins
332 
333  pin_name_t int_pin;
334 
335  // static variable
336 
337  uint32_t i2c_speed;
338  uint8_t i2c_address;
339 
340  uint32_t spi_speed;
341  spi_master_mode_t spi_mode;
342  spi_master_chip_select_polarity_t cs_polarity;
343 
345 
347  // End types group
349 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
355 #ifdef __cplusplus
356 extern "C"{
357 #endif
358 
368 
378 
386 void pressure3_default_cfg ( pressure3_t *ctx );
387 
398 void pressure3_generic_write ( pressure3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
399 
410 void pressure3_generic_read ( pressure3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
411 
422 void pressure3_get_t_p_data ( pressure3_t *ctx, float *temperature, float *presure, pressure3_coeff_t *coeff_struct );
423 
433 void pressure3_get_coefficients ( pressure3_t *ctx, pressure3_coeff_t *coeff_struct );
434 
443 int32_t pressure3_get_measurement_data ( pressure3_t *ctx, uint8_t mbs_reg_addr );
444 
475 void pressure3_set_pressure_configuration ( pressure3_t *ctx, uint8_t press_config );
476 
486 
518 void pressure3_set_temperature_configuration ( pressure3_t *ctx, uint8_t temp_config );
519 
529 
538 void pressure3_set_operating_mode( pressure3_t *ctx, uint8_t operation_mode );
539 
549 
558 void pressure3_set_configuration ( pressure3_t *ctx,uint8_t confg_data );
559 
569 
579 
588 uint8_t pressure3_get_fifo_status ( pressure3_t *ctx );
589 
598 void pressure3_soft_reset ( pressure3_t *ctx );
599 
600 #ifdef __cplusplus
601 }
602 #endif
603 #endif // _PRESSURE3_H_
604  // End public_function group
607 
608 // ------------------------------------------------------------------------- END
pressure3_cfg_t::miso
pin_name_t miso
Definition: pressure3.h:326
PRESSURE3_RETVAL
#define PRESSURE3_RETVAL
Definition: pressure3.h:76
pressure3_s::i2c
i2c_master_t i2c
Definition: pressure3.h:304
pressure3_cfg_t::cs
pin_name_t cs
Definition: pressure3.h:329
pressure3_s
Click ctx object definition.
Definition: pressure3.h:292
pressure3_master_io_t
void(* pressure3_master_io_t)(struct pressure3_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: pressure3.h:270
pressure3_get_measurement_data
int32_t pressure3_get_measurement_data(pressure3_t *ctx, uint8_t mbs_reg_addr)
Read the coefficients value for calculation function.
pressure3_set_pressure_configuration
void pressure3_set_pressure_configuration(pressure3_t *ctx, uint8_t press_config)
Set the pressure configuration function.
pressure3_s::write_f
pressure3_master_io_t write_f
Definition: pressure3.h:311
pressure3_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: pressure3.h:342
pressure3_get_interrupt_status
uint8_t pressure3_get_interrupt_status(pressure3_t *ctx)
Get the interrupt status function.
pressure3_get_coefficients
void pressure3_get_coefficients(pressure3_t *ctx, pressure3_coeff_t *coeff_struct)
Get coefficients.
pressure3_soft_reset
void pressure3_soft_reset(pressure3_t *ctx)
Soft reset function.
pressure3_set_temperature_configuration
void pressure3_set_temperature_configuration(pressure3_t *ctx, uint8_t temp_config)
Set the temperature configuration function.
pressure3_get_pressure_configuration
uint8_t pressure3_get_pressure_configuration(pressure3_t *ctx)
Get the pressure configuration function.
pressure3_default_cfg
void pressure3_default_cfg(pressure3_t *ctx)
Click Default Configuration function.
pressure3_s::read_f
pressure3_master_io_t read_f
Definition: pressure3.h:312
pressure3_set_configuration
void pressure3_set_configuration(pressure3_t *ctx, uint8_t confg_data)
Set the configuration function.
pressure3_cfg_setup
void pressure3_cfg_setup(pressure3_cfg_t *cfg)
Config Object Initialization function.
pressure3_s::chip_select
pin_name_t chip_select
Definition: pressure3.h:310
pressure3_t
struct pressure3_s pressure3_t
Click ctx object definition.
pressure3_cfg_t::int_pin
pin_name_t int_pin
Definition: pressure3.h:333
pressure3_cfg_t::scl
pin_name_t scl
Definition: pressure3.h:324
pressure3_coeff_t::coeff_c11
int16_t coeff_c11
Definition: pressure3.h:282
pressure3_select_t
uint8_t pressure3_select_t
Communication type.
Definition: pressure3.h:265
pressure3_cfg_t::sda
pin_name_t sda
Definition: pressure3.h:325
pressure3_cfg_t::mosi
pin_name_t mosi
Definition: pressure3.h:327
pressure3_coeff_t::coeff_c30
int16_t coeff_c30
Definition: pressure3.h:285
pressure3_get_configuration
uint8_t pressure3_get_configuration(pressure3_t *ctx)
Get the configuration function.
pressure3_get_temperature_configuration
uint8_t pressure3_get_temperature_configuration(pressure3_t *ctx)
Get the temperature configuration function.
pressure3_coeff_t::coeff_c00
int32_t coeff_c00
Definition: pressure3.h:279
pressure3_s::int_pin
digital_in_t int_pin
Definition: pressure3.h:300
pressure3_coeff_t::coeff_c10
int32_t coeff_c10
Definition: pressure3.h:280
pressure3_get_fifo_status
uint8_t pressure3_get_fifo_status(pressure3_t *ctx)
Get the FIFO Status function.
pressure3_coeff_t::coeff_c20
int16_t coeff_c20
Definition: pressure3.h:283
pressure3_coeff_t::coeff_c21
int16_t coeff_c21
Definition: pressure3.h:284
pressure3_coeff_t
Coefficients structure.
Definition: pressure3.h:275
pressure3_generic_read
void pressure3_generic_read(pressure3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
pressure3_coeff_t::coeff_c0
int16_t coeff_c0
Definition: pressure3.h:277
pressure3_cfg_t::i2c_address
uint8_t i2c_address
Definition: pressure3.h:338
pressure3_s::master_sel
pressure3_select_t master_sel
Definition: pressure3.h:313
pressure3_set_operating_mode
void pressure3_set_operating_mode(pressure3_t *ctx, uint8_t operation_mode)
Get the sensor operating mode function.
pressure3_get_operating_mode
uint8_t pressure3_get_operating_mode(pressure3_t *ctx)
Get the sensor operating mode function.
pressure3_coeff_t::coeff_c1
int16_t coeff_c1
Definition: pressure3.h:278
pressure3_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: pressure3.h:341
pressure3_s::spi
spi_master_t spi
Definition: pressure3.h:305
pressure3_cfg_t
Click configuration structure definition.
Definition: pressure3.h:320
pressure3_cfg_t::sck
pin_name_t sck
Definition: pressure3.h:328
pressure3_generic_write
void pressure3_generic_write(pressure3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
pressure3_coeff_t::coeff_c01
int16_t coeff_c01
Definition: pressure3.h:281
pressure3_get_t_p_data
void pressure3_get_t_p_data(pressure3_t *ctx, float *temperature, float *presure, pressure3_coeff_t *coeff_struct)
Get temperature pressure.
pressure3_s::cs
digital_out_t cs
Definition: pressure3.h:296
pressure3_cfg_t::sel
pressure3_select_t sel
Definition: pressure3.h:344
pressure3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pressure3.h:337
pressure3_init
PRESSURE3_RETVAL pressure3_init(pressure3_t *ctx, pressure3_cfg_t *cfg)
Initialization function.
pressure3_cfg_t::spi_speed
uint32_t spi_speed
Definition: pressure3.h:340
pressure3_s::slave_address
uint8_t slave_address
Definition: pressure3.h:309