pressure4  2.0.0.0
pressure4.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef PRESSURE4_H
36 #define PRESSURE4_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 PRESSURE4_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 PRESSURE4_MASTER_I2C 0
68 #define PRESSURE4_MASTER_SPI 1
69 
75 #define PRESSURE4_RETVAL uint8_t
76 
77 #define PRESSURE4_OK 0x00
78 #define PRESSURE4_INIT_ERROR 0xFF
79 
85 #define PRESSURE4_ADDR0 0x76
86 #define PRESSURE4_ADDR1 0x77
87 #define PRESSURE4_ID 0xD0
88 #define PRESSURE4_RESET 0xE0
89 #define PRESSURE4_STATUS 0xF3
90 #define PRESSURE4_CTL_MEAS 0xF4
91 #define PRESSURE4_CONFIG 0xF5
92 #define PRESSURE4_PRESS_MSB 0xF7
93 #define PRESSURE4_PRESS_LSB 0xF8
94 #define PRESSURE4_PRESS_XLSB 0xF9
95 #define PRESSURE4_TEMP_MSB 0xFA
96 #define PRESSURE4_TEMP_LSB 0xFB
97 #define PRESSURE4_TEMP_XLSB 0xFC
98 
104 #define PRESSURE4_CALLIBRATION_DIG_T1 0x88
105 #define PRESSURE4_CALLIBRATION_DIG_T2 0x8A
106 #define PRESSURE4_CALLIBRATION_DIG_T3 0x8C
107 #define PRESSURE4_CALLIBRATION_DIG_P1 0x8E
108 #define PRESSURE4_CALLIBRATION_DIG_P2 0x90
109 #define PRESSURE4_CALLIBRATION_DIG_P3 0x92
110 #define PRESSURE4_CALLIBRATION_DIG_P4 0x94
111 #define PRESSURE4_CALLIBRATION_DIG_P5 0x96
112 #define PRESSURE4_CALLIBRATION_DIG_P6 0x98
113 #define PRESSURE4_CALLIBRATION_DIG_P7 0x9A
114 #define PRESSURE4_CALLIBRATION_DIG_P8 0x9C
115 #define PRESSURE4_CALLIBRATION_DIG_P9 0x9E
116  // End group macro
119 // --------------------------------------------------------------- PUBLIC TYPES
128 typedef uint8_t pressure4_select_t;
129 
133 typedef void ( *pressure4_master_io_t )( struct pressure4_s*, uint8_t, uint8_t*, uint8_t );
134 
138 typedef struct pressure4_s
139 {
140  // Modules
141 
142  i2c_master_t i2c;
143  spi_master_t spi;
144 
145  // ctx variable
146 
147  hal_i2c_address_t slave_address;
151 
152  uint16_t dig_t1;
153  int16_t dig_t2;
154  int16_t dig_t3;
155 
156  uint16_t dig_p1;
157  int16_t dig_p2;
158  int16_t dig_p3;
159  int16_t dig_p4;
160  int16_t dig_p5;
161  int16_t dig_p6;
162  int16_t dig_p7;
163  int16_t dig_p8;
164  int16_t dig_p9;
165 
166  int32_t t_fine;
168 
169 } pressure4_t;
170 
174 typedef struct
175 {
176  // Communication gpio pins
177 
178  pin_name_t scl;
179  pin_name_t sda;
180  pin_name_t miso;
181  pin_name_t mosi;
182  pin_name_t sck;
183  pin_name_t cs;
184 
185  // static variable
186 
187  hal_i2c_speed_t i2c_speed;
188  hal_i2c_address_t i2c_address;
189  hal_spi_speed_t spi_speed;
190  hal_spi_mode_t spi_mode;
191 
193 
195  // End types group
197 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
203 #ifdef __cplusplus
204 extern "C"{
205 #endif
206 
216 
225 
233 void pressure4_default_cfg ( pressure4_t *ctx );
234 
245 void pressure4_generic_write ( pressure4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
246 
257 void pressure4_generic_read ( pressure4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
258 
268 void pressure4_write_reg_8_bit ( pressure4_t *ctx, uint8_t w_reg, uint8_t w_data );
269 
278 uint8_t pressure4_read_reg_8_bit ( pressure4_t *ctx, uint8_t r_reg );
279 
287 uint8_t pressure4_read_id ( pressure4_t *ctx );
288 
296 uint8_t pressure4_get_status ( pressure4_t *ctx );
297 
305 double pressure4_get_temperature ( pressure4_t *ctx );
306 
314 double pressure4_get_pressure ( pressure4_t *ctx );
315 
316 #ifdef __cplusplus
317 }
318 #endif
319 #endif // _PRESSURE4_H_
320  // End public_function group
323 
324 // ------------------------------------------------------------------------- END
double pressure4_get_temperature(pressure4_t *ctx)
Get temperature function.
pin_name_t cs
Definition: pressure4.h:183
int16_t dig_p6
Definition: pressure4.h:161
pressure4_master_io_t write_f
Definition: pressure4.h:148
int16_t dig_p3
Definition: pressure4.h:158
hal_i2c_address_t i2c_address
Definition: pressure4.h:188
int32_t t_fine
Definition: pressure4.h:166
int16_t dig_p9
Definition: pressure4.h:164
int16_t dig_t2
Definition: pressure4.h:153
Click ctx object definition.
Definition: pressure4.h:138
uint16_t dig_p1
Definition: pressure4.h:156
int16_t dig_p8
Definition: pressure4.h:163
void pressure4_generic_read(pressure4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
Click configuration structure definition.
Definition: pressure4.h:174
int16_t dig_p5
Definition: pressure4.h:160
uint8_t pressure4_get_status(pressure4_t *ctx)
Get status function.
int16_t dig_p4
Definition: pressure4.h:159
void pressure4_generic_write(pressure4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
pin_name_t miso
Definition: pressure4.h:180
pin_name_t mosi
Definition: pressure4.h:181
int16_t dig_p2
Definition: pressure4.h:157
PRESSURE4_RETVAL pressure4_init(pressure4_t *ctx, pressure4_cfg_t *cfg)
Initialization function.
int16_t dig_p7
Definition: pressure4.h:162
struct pressure4_s pressure4_t
Click ctx object definition.
pressure4_select_t sel
Definition: pressure4.h:192
pin_name_t sda
Definition: pressure4.h:179
int16_t dig_t3
Definition: pressure4.h:154
hal_spi_speed_t spi_speed
Definition: pressure4.h:189
void pressure4_cfg_setup(pressure4_cfg_t *cfg)
Config Object Initialization function.
void(* pressure4_master_io_t)(struct pressure4_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: pressure4.h:133
double t1_calc_1
Definition: pressure4.h:167
void pressure4_default_cfg(pressure4_t *ctx)
Click Default Configuration function.
pin_name_t scl
Definition: pressure4.h:178
uint8_t pressure4_read_reg_8_bit(pressure4_t *ctx, uint8_t r_reg)
8 bit reading function.
#define PRESSURE4_RETVAL
Definition: pressure4.h:75
pressure4_select_t master_sel
Definition: pressure4.h:150
hal_i2c_address_t slave_address
Definition: pressure4.h:147
void pressure4_write_reg_8_bit(pressure4_t *ctx, uint8_t w_reg, uint8_t w_data)
8 bit writing function.
uint16_t dig_t1
Definition: pressure4.h:152
double p3_calc_1
Definition: pressure4.h:167
hal_spi_mode_t spi_mode
Definition: pressure4.h:190
double pressure4_get_pressure(pressure4_t *ctx)
Get pressure function.
uint8_t pressure4_read_id(pressure4_t *ctx)
Read ID function.
i2c_master_t i2c
Definition: pressure4.h:142
pressure4_master_io_t read_f
Definition: pressure4.h:149
uint8_t pressure4_select_t
Communication type.
Definition: pressure4.h:128
spi_master_t spi
Definition: pressure4.h:143
pin_name_t sck
Definition: pressure4.h:182
hal_i2c_speed_t i2c_speed
Definition: pressure4.h:187