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_OK 0
76 #define PRESSURE4_ERROR -1
77 
83 #define PRESSURE4_ADDR0 0x76
84 #define PRESSURE4_ADDR1 0x77
85 #define PRESSURE4_ID 0xD0
86 #define PRESSURE4_RESET 0xE0
87 #define PRESSURE4_STATUS 0xF3
88 #define PRESSURE4_CTL_MEAS 0xF4
89 #define PRESSURE4_CONFIG 0xF5
90 #define PRESSURE4_PRESS_MSB 0xF7
91 #define PRESSURE4_PRESS_LSB 0xF8
92 #define PRESSURE4_PRESS_XLSB 0xF9
93 #define PRESSURE4_TEMP_MSB 0xFA
94 #define PRESSURE4_TEMP_LSB 0xFB
95 #define PRESSURE4_TEMP_XLSB 0xFC
96 
102 #define PRESSURE4_CALIBRATION_DIG_T1 0x88
103 #define PRESSURE4_CALIBRATION_DIG_T2 0x8A
104 #define PRESSURE4_CALIBRATION_DIG_T3 0x8C
105 #define PRESSURE4_CALIBRATION_DIG_P1 0x8E
106 #define PRESSURE4_CALIBRATION_DIG_P2 0x90
107 #define PRESSURE4_CALIBRATION_DIG_P3 0x92
108 #define PRESSURE4_CALIBRATION_DIG_P4 0x94
109 #define PRESSURE4_CALIBRATION_DIG_P5 0x96
110 #define PRESSURE4_CALIBRATION_DIG_P6 0x98
111 #define PRESSURE4_CALIBRATION_DIG_P7 0x9A
112 #define PRESSURE4_CALIBRATION_DIG_P8 0x9C
113 #define PRESSURE4_CALIBRATION_DIG_P9 0x9E
114  // End group macro
117 // --------------------------------------------------------------- PUBLIC TYPES
126 typedef void ( *pressure4_master_io_t )( struct pressure4_s*, uint8_t, uint8_t*, uint8_t );
127 
131 typedef struct pressure4_s
132 {
133  // Output pins
134  digital_out_t cs;
135 
136  // Modules
137  i2c_master_t i2c;
138  spi_master_t spi;
139 
140  // ctx variable
141  uint8_t slave_address;
142  pin_name_t chip_select;
145  uint8_t master_sel;
146 
147  uint16_t dig_t1;
148  int16_t dig_t2;
149  int16_t dig_t3;
150 
151  uint16_t dig_p1;
152  int16_t dig_p2;
153  int16_t dig_p3;
154  int16_t dig_p4;
155  int16_t dig_p5;
156  int16_t dig_p6;
157  int16_t dig_p7;
158  int16_t dig_p8;
159  int16_t dig_p9;
160 
161  int32_t t_fine;
162  float t1_calc_1;
163  float p3_calc_1;
164 
166 
170 typedef struct
171 {
172  // Communication gpio pins
173  pin_name_t scl;
174  pin_name_t sda;
175  pin_name_t miso;
176  pin_name_t mosi;
177  pin_name_t sck;
178  pin_name_t cs;
179 
180  // static variable
181  uint32_t i2c_speed;
182  uint8_t i2c_address;
183 
184  uint32_t spi_speed;
185  spi_master_mode_t spi_mode;
186  spi_master_chip_select_polarity_t cs_polarity;
187 
188  uint8_t sel;
189 
191  // End types group
193 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
199 #ifdef __cplusplus
200 extern "C"{
201 #endif
202 
212 
222 
231 
242 void pressure4_generic_write ( pressure4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
243 
254 void pressure4_generic_read ( pressure4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
255 
265 void pressure4_write_reg_8_bit ( pressure4_t *ctx, uint8_t w_reg, uint8_t w_data );
266 
275 uint8_t pressure4_read_reg_8_bit ( pressure4_t *ctx, uint8_t r_reg );
276 
285 
294 
303 
312 
313 #ifdef __cplusplus
314 }
315 #endif
316 #endif // _PRESSURE4_H_
317  // End public_function group
320 
321 // ------------------------------------------------------------------------- END
pressure4_s::dig_t1
uint16_t dig_t1
Definition: pressure4.h:147
pressure4_cfg_t::sck
pin_name_t sck
Definition: pressure4.h:177
pressure4_s::spi
spi_master_t spi
Definition: pressure4.h:138
pressure4_cfg_t::sda
pin_name_t sda
Definition: pressure4.h:174
pressure4_s::chip_select
pin_name_t chip_select
Definition: pressure4.h:142
pressure4_s::dig_p6
int16_t dig_p6
Definition: pressure4.h:156
pressure4_s
Click ctx object definition.
Definition: pressure4.h:132
pressure4_get_status
uint8_t pressure4_get_status(pressure4_t *ctx)
Get status function.
pressure4_master_io_t
void(* pressure4_master_io_t)(struct pressure4_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: pressure4.h:126
pressure4_s::dig_p5
int16_t dig_p5
Definition: pressure4.h:155
pressure4_cfg_t::miso
pin_name_t miso
Definition: pressure4.h:175
pressure4_t
struct pressure4_s pressure4_t
Click ctx object definition.
pressure4_cfg_t::mosi
pin_name_t mosi
Definition: pressure4.h:176
pressure4_s::cs
digital_out_t cs
Definition: pressure4.h:134
pressure4_s::t_fine
int32_t t_fine
Definition: pressure4.h:161
pressure4_s::dig_t2
int16_t dig_t2
Definition: pressure4.h:148
pressure4_s::dig_p9
int16_t dig_p9
Definition: pressure4.h:159
pressure4_s::dig_p1
uint16_t dig_p1
Definition: pressure4.h:151
pressure4_s::dig_p2
int16_t dig_p2
Definition: pressure4.h:152
pressure4_generic_write
void pressure4_generic_write(pressure4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
pressure4_s::p3_calc_1
float p3_calc_1
Definition: pressure4.h:163
pressure4_s::slave_address
uint8_t slave_address
Definition: pressure4.h:141
pressure4_default_cfg
void pressure4_default_cfg(pressure4_t *ctx)
Click Default Configuration function.
pressure4_s::dig_p4
int16_t dig_p4
Definition: pressure4.h:154
pressure4_get_pressure
float pressure4_get_pressure(pressure4_t *ctx)
Get pressure function.
pressure4_cfg_setup
void pressure4_cfg_setup(pressure4_cfg_t *cfg)
Config Object Initialization function.
pressure4_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: pressure4.h:186
pressure4_write_reg_8_bit
void pressure4_write_reg_8_bit(pressure4_t *ctx, uint8_t w_reg, uint8_t w_data)
8 bit writing function.
pressure4_s::master_sel
uint8_t master_sel
Definition: pressure4.h:145
pressure4_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: pressure4.h:185
pressure4_s::dig_p7
int16_t dig_p7
Definition: pressure4.h:157
pressure4_s::dig_p8
int16_t dig_p8
Definition: pressure4.h:158
pressure4_s::read_f
pressure4_master_io_t read_f
Definition: pressure4.h:144
pressure4_cfg_t::spi_speed
uint32_t spi_speed
Definition: pressure4.h:184
pressure4_cfg_t::cs
pin_name_t cs
Definition: pressure4.h:178
pressure4_read_id
uint8_t pressure4_read_id(pressure4_t *ctx)
Read ID function.
pressure4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pressure4.h:181
pressure4_cfg_t::scl
pin_name_t scl
Definition: pressure4.h:173
pressure4_s::i2c
i2c_master_t i2c
Definition: pressure4.h:137
pressure4_read_reg_8_bit
uint8_t pressure4_read_reg_8_bit(pressure4_t *ctx, uint8_t r_reg)
8 bit reading function.
pressure4_s::t1_calc_1
float t1_calc_1
Definition: pressure4.h:162
pressure4_cfg_t
Click configuration structure definition.
Definition: pressure4.h:171
pressure4_s::dig_t3
int16_t dig_t3
Definition: pressure4.h:149
pressure4_generic_read
void pressure4_generic_read(pressure4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
pressure4_cfg_t::sel
uint8_t sel
Definition: pressure4.h:188
pressure4_cfg_t::i2c_address
uint8_t i2c_address
Definition: pressure4.h:182
pressure4_get_temperature
float pressure4_get_temperature(pressure4_t *ctx)
Get temperature function.
pressure4_init
err_t pressure4_init(pressure4_t *ctx, pressure4_cfg_t *cfg)
Initialization function.
pressure4_s::dig_p3
int16_t dig_p3
Definition: pressure4.h:153
pressure4_s::write_f
pressure4_master_io_t write_f
Definition: pressure4.h:143