pressure4  2.0.0.0
pressure4.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 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  // Output pins
141 
142  digital_out_t cs;
143 
144  // Modules
145 
146  i2c_master_t i2c;
147  spi_master_t spi;
148 
149  // ctx variable
150 
151  uint8_t slave_address;
152  pin_name_t chip_select;
156 
157  uint16_t dig_t1;
158  int16_t dig_t2;
159  int16_t dig_t3;
160 
161  uint16_t dig_p1;
162  int16_t dig_p2;
163  int16_t dig_p3;
164  int16_t dig_p4;
165  int16_t dig_p5;
166  int16_t dig_p6;
167  int16_t dig_p7;
168  int16_t dig_p8;
169  int16_t dig_p9;
170 
171  int32_t t_fine;
173 
174 } pressure4_t;
175 
179 typedef struct
180 {
181  // Communication gpio pins
182 
183  pin_name_t scl;
184  pin_name_t sda;
185  pin_name_t miso;
186  pin_name_t mosi;
187  pin_name_t sck;
188  pin_name_t cs;
189 
190  // static variable
191 
192  uint32_t i2c_speed;
193  uint8_t i2c_address;
194 
195  uint32_t spi_speed;
196  spi_master_mode_t spi_mode;
197  spi_master_chip_select_polarity_t cs_polarity;
198 
200 
202  // End types group
204 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
210 #ifdef __cplusplus
211 extern "C"{
212 #endif
213 
223 
233 
241 void pressure4_default_cfg ( pressure4_t *ctx );
242 
253 void pressure4_generic_write ( pressure4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
254 
265 void pressure4_generic_read ( pressure4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
266 
276 void pressure4_write_reg_8_bit ( pressure4_t *ctx, uint8_t w_reg, uint8_t w_data );
277 
286 uint8_t pressure4_read_reg_8_bit ( pressure4_t *ctx, uint8_t r_reg );
287 
295 uint8_t pressure4_read_id ( pressure4_t *ctx );
296 
304 uint8_t pressure4_get_status ( pressure4_t *ctx );
305 
313 double pressure4_get_temperature ( pressure4_t *ctx );
314 
322 double pressure4_get_pressure ( pressure4_t *ctx );
323 
324 #ifdef __cplusplus
325 }
326 #endif
327 #endif // _PRESSURE4_H_
328  // End public_function group
331 
332 // ------------------------------------------------------------------------- END
double pressure4_get_temperature(pressure4_t *ctx)
Get temperature function.
pin_name_t cs
Definition: pressure4.h:188
int16_t dig_p6
Definition: pressure4.h:166
pressure4_master_io_t write_f
Definition: pressure4.h:153
int16_t dig_p3
Definition: pressure4.h:163
int32_t t_fine
Definition: pressure4.h:171
int16_t dig_p9
Definition: pressure4.h:169
int16_t dig_t2
Definition: pressure4.h:158
uint32_t i2c_speed
Definition: pressure4.h:192
uint8_t i2c_address
Definition: pressure4.h:193
Click ctx object definition.
Definition: pressure4.h:138
uint16_t dig_p1
Definition: pressure4.h:161
uint8_t slave_address
Definition: pressure4.h:151
uint32_t spi_speed
Definition: pressure4.h:195
int16_t dig_p8
Definition: pressure4.h:168
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:179
int16_t dig_p5
Definition: pressure4.h:165
uint8_t pressure4_get_status(pressure4_t *ctx)
Get status function.
spi_master_chip_select_polarity_t cs_polarity
Definition: pressure4.h:197
int16_t dig_p4
Definition: pressure4.h:164
spi_master_mode_t spi_mode
Definition: pressure4.h:196
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:185
pin_name_t mosi
Definition: pressure4.h:186
int16_t dig_p2
Definition: pressure4.h:162
PRESSURE4_RETVAL pressure4_init(pressure4_t *ctx, pressure4_cfg_t *cfg)
Initialization function.
int16_t dig_p7
Definition: pressure4.h:167
struct pressure4_s pressure4_t
Click ctx object definition.
pressure4_select_t sel
Definition: pressure4.h:199
pin_name_t sda
Definition: pressure4.h:184
digital_out_t cs
Definition: pressure4.h:142
int16_t dig_t3
Definition: pressure4.h:159
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:172
void pressure4_default_cfg(pressure4_t *ctx)
Click Default Configuration function.
pin_name_t scl
Definition: pressure4.h:183
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:155
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:157
double p3_calc_1
Definition: pressure4.h:172
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:146
pressure4_master_io_t read_f
Definition: pressure4.h:154
uint8_t pressure4_select_t
Communication type.
Definition: pressure4.h:128
spi_master_t spi
Definition: pressure4.h:147
pin_name_t sck
Definition: pressure4.h:187
pin_name_t chip_select
Definition: pressure4.h:152