pressure5 2.0.0.0
pressure5.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 PRESSURE5_H
36#define PRESSURE5_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 PRESSURE5_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
69#define PRESSURE5_MASTER_I2C 0
70#define PRESSURE5_MASTER_SPI 1
77#define PRESSURE5_RETVAL uint8_t
78
79#define PRESSURE5_OK 0x00
80#define PRESSURE5_INIT_ERROR 0xFF
87#define PRESSURE5_REG_DEVICE_ID 0x00
88#define PRESSURE5_REG_ERROR 0x02
89#define PRESSURE5_REG_PRESSURE_DATA_0 0x04
90#define PRESSURE5_REG_PRESSURE_DATA_1 0x05
91#define PRESSURE5_REG_PRESSURE_DATA_2 0x06
92#define PRESSURE5_REG_TEMPERATURE_DATA_0 0x07
93#define PRESSURE5_REG_TEMPERATURE_DATA_1 0x08
94#define PRESSURE5_REG_TEMPERATURE_DATA_2 0x09
95#define PRESSURE5_REG_SENSOR_TIME_0 0x0C
96#define PRESSURE5_REG_SENSOR_TIME_1 0x0D
97#define PRESSURE5_REG_SENSOR_TIME_2 0x0E
98#define PRESSURE5_REG_EVENT 0x10
99#define PRESSURE5_REG_INT_STATUS 0x11
100#define PRESSURE5_REG_FIFO_LENGTH 0x13
101#define PRESSURE5_REG_FIFO_DATA 0x14
102#define PRESSURE5_REG_FIFO_WATERMARK_0 0x15
103#define PRESSURE5_REG_FIFO_WATERMARK_1 0x16
104#define PRESSURE5_REG_FIFO_CONFIG_1 0x17
105#define PRESSURE5_REG_FIFO_CONFIG_2 0x18
106#define PRESSURE5_REG_INT_CTRL 0x19
107#define PRESSURE5_REG_IF_CONFIG 0x1A
108#define PRESSURE5_REG_POWER_CTRL 0x1B
109#define PRESSURE5_REG_OSR 0x1C
110#define PRESSURE5_REG_ODR 0x1D
111#define PRESSURE5_REG_CONFIGURATION 0x1F
112#define PRESSURE5_REG_COMMAND 0x7E
119#define PRESSURE5_FCFG_FIFO_ENABLE 0x01
120#define PRESSURE5_FCFG_FIFO_DISABLE 0x00
121#define PRESSURE5_FCFG_FIFO_STOP_ON_FULL_ENABLE 0x02
122#define PRESSURE5_FCFG_FIFO_STOP_ON_FULL_DISABLE 0x00
123#define PRESSURE5_FCFG_FIFO_TIME_ENABLE 0x04
124#define PRESSURE5_FCFG_FIFO_TIME_DISABLE 0x00
125#define PRESSURE5_FCFG_FIFO_PRESSURE_STORE_ENABLE 0x08
126#define PRESSURE5_FCFG_FIFO_PRESSURE_STORE_DISABLE 0x00
127#define PRESSURE5_FCFG_FIFO_TEMP_STORE_ENABLE 0x10
128#define PRESSURE5_FCFG_FIFO_TEMP_STORE_DISABLE 0x00
135#define PRESSURE5_INTCFG_INT_OUTPUT_PUSH_PULL 0x00
136#define PRESSURE5_INTCFG_INT_OUTPUT_OPEN_DRAIN 0x01
137#define PRESSURE5_INTCFG_INT_LEVEL_ACTIVE_HIGH 0x02
138#define PRESSURE5_INTCFG_INT_LEVEL_ACTIVE_LOW 0x00
139#define PRESSURE5_INTCFG_INT_LATCH_ENABLE 0x04
140#define PRESSURE5_INTCFG_INT_LATCH_DISABLE 0x00
141#define PRESSURE5_INTCFG_FIFO_WTM_ENABLE 0x08
142#define PRESSURE5_INTCFG_FIFO_WTM_DISABLE 0x00
143#define PRESSURE5_INTCFG_FIFO_FULL_ENABLE 0x10
144#define PRESSURE5_INTCFG_FIFO_FULL_DISABLE 0x00
145#define PRESSURE5_INTCFG_DATA_READY_ENABLE 0x20
146#define PRESSURE5_INTCFG_DATA_READY_DISABLE 0x00
153#define PRESSURE5_IFCFG_SPI_4_WIRE 0x00
154#define PRESSURE5_IFCFG_SPI_3_WIRE 0x01
155#define PRESSURE5_IFCFG_I2C_WATCHDOG_ENABLE 0x02
156#define PRESSURE5_IFCFG_I2C_WATCHDOG_DISABLE 0x00
157#define PRESSURE5_IFCFG_I2C_WATCHDOG_SHORT_1p25ms 0x00
158#define PRESSURE5_IFCFG_I2C_WATCHDOG_LONG_40ms 0x04
165#define PRESSURE5_PCTRL_PRESSURE_SENSOR_DISABLE 0x00
166#define PRESSURE5_PCTRL_PRESSURE_SENSOR_ENABLE 0x01
167#define PRESSURE5_PCTRL_TEMP_SENSOR_DISABLE 0x00
168#define PRESSURE5_PCTRL_TEMP_SENSOR_ENABLE 0x02
169#define PRESSURE5_PCTRL_MODE_SLEEP 0x00
170#define PRESSURE5_PCTRL_MODE_FORCED 0x10
171#define PRESSURE5_PCTRL_MODE_NORMAL 0x30
178#define PRESSURE5_OSR_PRESSURE_x1 0x00
179#define PRESSURE5_OSR_PRESSURE_x2 0x01
180#define PRESSURE5_OSR_PRESSURE_x4 0x02
181#define PRESSURE5_OSR_PRESSURE_x8 0x03
182#define PRESSURE5_OSR_PRESSURE_x16 0x04
183#define PRESSURE5_OSR_PRESSURE_x32 0x05
184#define PRESSURE5_OSR_TEMP_x1 0x00 >> 1
185#define PRESSURE5_OSR_TEMP_x2 0x10 >> 1
186#define PRESSURE5_OSR_TEMP_x4 0x20 >> 1
187#define PRESSURE5_OSR_TEMP_x8 0x30 >> 1
188#define PRESSURE5_OSR_TEMP_x16 0x40 >> 1
189#define PRESSURE5_OSR_TEMP_x32 0x50 >> 1
196#define PRESSURE5_ODR_200 0x00
197#define PRESSURE5_ODR_100 0x01
198#define PRESSURE5_ODR_50 0x02
199#define PRESSURE5_ODR_25 0x03
200#define PRESSURE5_ODR_12p5 0x04
201#define PRESSURE5_ODR_6p25 0x05
202#define PRESSURE5_ODR_3p1 0x06
203#define PRESSURE5_ODR_1p5 0x07
204#define PRESSURE5_ODR_0p75 0x08
205#define PRESSURE5_ODR_0p39 0x09
206#define PRESSURE5_ODR_0p2 0x0A
207#define PRESSURE5_ODR_0p1 0x0B
208#define PRESSURE5_ODR_0p05 0x0C
209#define PRESSURE5_ODR_0p02 0x0D
210#define PRESSURE5_ODR_0p01 0x0E
211#define PRESSURE5_ODR_0p006 0x0F
212#define PRESSURE5_ODR_0p003 0x10
213#define PRESSURE5_ODR_0p0015 0x11
220#define PRESSURE5_CFG_FILTER_COEFF_0 0x00
221#define PRESSURE5_CFG_FILTER_COEFF_1 0x01 << 1
222#define PRESSURE5_CFG_FILTER_COEFF_3 0x02 << 1
223#define PRESSURE5_CFG_FILTER_COEFF_7 0x03 << 1
224#define PRESSURE5_CFG_FILTER_COEFF_15 0x04 << 1
225#define PRESSURE5_CFG_FILTER_COEFF_31 0x05 << 1
226#define PRESSURE5_CFG_FILTER_COEFF_63 0x06 << 1
227#define PRESSURE5_CFG_FILTER_COEFF_127 0x07 << 1
234#define PRESSURE5_CMD_EXTMODE_EN_MIDDLE 0x34
235#define PRESSURE5_CMD_FIFO_FLUSH 0xB0
236#define PRESSURE5_CMD_SOFTWARE_RESET 0xB6
243#define PRESSURE5_DEVICE_SLAVE_ADDR_GND 0x76
244#define PRESSURE5_DEVICE_SLAVE_ADDR_VCC 0x77
251#define PRESSURE5_TEMPERATURE_RAW_DATA 0x07
252#define PRESSURE5_PRESSURE_RAW_DATA 0x04
259#define PRESSURE5_DEVICE_ID 0x50 // End group macro
263// --------------------------------------------------------------- PUBLIC TYPES
272typedef uint8_t pressure5_select_t;
273
277typedef void ( *pressure5_master_io_t )( struct pressure5_s*, uint8_t, uint8_t*, uint8_t );
278
282typedef struct pressure5_s
283{
284 // Output pins
285
286 digital_out_t cs;
287
288 // Input pins
289
290 digital_in_t int_pin;
291
292 // Modules
293
294 i2c_master_t i2c;
295 spi_master_t spi;
296
297 // ctx variable
298
300 pin_name_t chip_select;
304
306
310typedef struct
311{
312 // Communication gpio pins
313
314 pin_name_t scl;
315 pin_name_t sda;
316 pin_name_t miso;
317 pin_name_t mosi;
318 pin_name_t sck;
319 pin_name_t cs;
320
321 // Additional gpio pins
322
323 pin_name_t int_pin;
324
325 // static variable
326
327 uint32_t i2c_speed;
328 uint8_t i2c_address;
329
330 uint32_t spi_speed;
331 spi_master_mode_t spi_mode;
332 spi_master_chip_select_polarity_t cs_polarity;
333
335
337
338typedef struct
339{
340 uint16_t t1;
341 uint16_t t2;
342 int8_t t3;
343
344 int16_t p1;
345 int16_t p2;
346 int8_t p3;
347 int8_t p4;
348 uint16_t p5;
349 uint16_t p6;
350 int8_t p7;
351 int8_t p8;
352 int16_t p9;
353 int8_t p10;
354 int8_t p11;
355
357
358
359typedef struct
360{
361 float t1;
362 float t2;
363 float t3;
364
365 float p1;
366 float p2;
367 float p3;
368 float p4;
369 float p5;
370 float p6;
371 float p7;
372 float p8;
373 float p9;
374 float p10;
375 float p11;
376
378 // End types group
380
381// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
387#ifdef __cplusplus
388extern "C"{
389#endif
390
400
409
418
428void pressure5_generic_write ( pressure5_t *ctx, uint8_t reg, uint8_t reg_data);
429
438uint8_t pressure5_generic_read ( pressure5_t *ctx, uint8_t reg );
450void pressure5_read ( pressure5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
476uint32_t pressure5_get_raw_data ( pressure5_t *ctx, uint8_t data_addr );
507
508
509
510
511#ifdef __cplusplus
512}
513#endif
514#endif // _PRESSURE5_H_
515 // End public_function group
518
519// ------------------------------------------------------------------------- END
#define PRESSURE5_RETVAL
Definition: pressure5.h:77
PRESSURE5_RETVAL pressure5_init(pressure5_t *ctx, pressure5_cfg_t *cfg)
Initialization function.
void pressure5_generic_write(pressure5_t *ctx, uint8_t reg, uint8_t reg_data)
Generic write function.
void pressure5_update_coefficient(pressure5_t *ctx)
Update calibration coefficients.
void pressure5_cfg_setup(pressure5_cfg_t *cfg)
Config Object Initialization function.
void pressure5_read(pressure5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Function for read more bytes from register.
uint8_t pressure5_get_interrupt_state(pressure5_t *ctx)
Get Interrupt pin state.
uint32_t pressure5_get_raw_data(pressure5_t *ctx, uint8_t data_addr)
Get (Temperature or Pressure) Raw data.
float pressure5_get_temperature_data(pressure5_t *ctx)
Get Temperature data in C.
uint8_t pressure5_generic_read(pressure5_t *ctx, uint8_t reg)
Generic read function.
void pressure5_software_reset(pressure5_t *ctx)
Software Reset.
void pressure5_default_cfg(pressure5_t *ctx)
Click Default Configuration function.
float pressure5_get_pressure_data(pressure5_t *ctx)
Get Pressure data in mBar.
struct pressure5_s pressure5_t
Click ctx object definition.
void(* pressure5_master_io_t)(struct pressure5_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: pressure5.h:277
uint8_t pressure5_select_t
Communication type.
Definition: pressure5.h:272
Click configuration structure definition.
Definition: pressure5.h:311
pressure5_select_t sel
Definition: pressure5.h:334
uint32_t i2c_speed
Definition: pressure5.h:327
spi_master_chip_select_polarity_t cs_polarity
Definition: pressure5.h:332
pin_name_t sck
Definition: pressure5.h:318
spi_master_mode_t spi_mode
Definition: pressure5.h:331
pin_name_t mosi
Definition: pressure5.h:317
uint32_t spi_speed
Definition: pressure5.h:330
pin_name_t scl
Definition: pressure5.h:314
pin_name_t int_pin
Definition: pressure5.h:323
pin_name_t miso
Definition: pressure5.h:316
pin_name_t sda
Definition: pressure5.h:315
pin_name_t cs
Definition: pressure5.h:319
uint8_t i2c_address
Definition: pressure5.h:328
Definition: pressure5.h:339
uint16_t t2
Definition: pressure5.h:341
int8_t p4
Definition: pressure5.h:347
int8_t p3
Definition: pressure5.h:346
int16_t p9
Definition: pressure5.h:352
int16_t p2
Definition: pressure5.h:345
int8_t p11
Definition: pressure5.h:354
int8_t p7
Definition: pressure5.h:350
int16_t p1
Definition: pressure5.h:344
uint16_t t1
Definition: pressure5.h:340
uint16_t p6
Definition: pressure5.h:349
int8_t p8
Definition: pressure5.h:351
int8_t t3
Definition: pressure5.h:342
int8_t p10
Definition: pressure5.h:353
uint16_t p5
Definition: pressure5.h:348
Definition: pressure5.h:360
float p3
Definition: pressure5.h:367
float p5
Definition: pressure5.h:369
float p1
Definition: pressure5.h:365
float p11
Definition: pressure5.h:375
float p8
Definition: pressure5.h:372
float p7
Definition: pressure5.h:371
float t3
Definition: pressure5.h:363
float p9
Definition: pressure5.h:373
float p6
Definition: pressure5.h:370
float t2
Definition: pressure5.h:362
float t1
Definition: pressure5.h:361
float p4
Definition: pressure5.h:368
float p2
Definition: pressure5.h:366
float p10
Definition: pressure5.h:374
Click ctx object definition.
Definition: pressure5.h:283
digital_out_t cs
Definition: pressure5.h:286
spi_master_t spi
Definition: pressure5.h:295
pressure5_select_t master_sel
Definition: pressure5.h:303
digital_in_t int_pin
Definition: pressure5.h:290
i2c_master_t i2c
Definition: pressure5.h:294
pressure5_master_io_t write_f
Definition: pressure5.h:301
uint8_t slave_address
Definition: pressure5.h:299
pressure5_master_io_t read_f
Definition: pressure5.h:302
pin_name_t chip_select
Definition: pressure5.h:300