barometer  2.0.0.0
barometer.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 BAROMETER_H
36 #define BAROMETER_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 BAROMETER_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.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
62 
68 #define BAROMETER_MASTER_I2C 0
69 #define BAROMETER_MASTER_SPI 1
70 
76 #define BAROMETER_RETVAL uint8_t
77 
78 #define BAROMETER_OK 0x00
79 #define BAROMETER_INIT_ERROR 0xFF
80 
86  #define BAROMETER_I2C_ADDRESS_0 0x5C
87 
93  #define BAROMETER_I2C_ADDRESS_1 0x5D
94 
100  #define BAROMETER_REF_P_XL 0x08
101  #define BAROMETER_REF_P_L 0x09
102  #define BAROMETER_REF_P_H 0x0A
103 
109  #define BAROMETER_WHO_AM_I 0x0F
110 
116  #define BAROMETER_RES_CONF 0x10
117  #define BAROMETER_CTRL_REG1 0x20
118  #define BAROMETER_CTRL_REG2 0x21
119  #define BAROMETER_CTRL_REG3 0x22
120  #define BAROMETER_CTRL_REG4 0x23
121  #define BAROMETER_INTERRUPT_CFG 0x24
122  #define BAROMETER_INT_SOURCE 0x25
123  #define BAROMETER_STATUS_REG 0x27
124  #define BAROMETER_PRESS_OUT_XL 0x28
125  #define BAROMETER_PRESS_OUT_L 0x29
126  #define BAROMETER_PRESS_OUT_H 0x2A
127  #define BAROMETER_TEMP_OUT_L 0x2B
128  #define BAROMETER_TEMP_OUT_H 0x2C
129  #define BAROMETER_FIFO_CTRL 0x2E
130  #define BAROMETER_FIFO_STATUS 0x2F
131  #define BAROMETER_THS_P_L 0x30
132  #define BAROMETER_THS_P_H 0x31
133  #define BAROMETER_RPDS_L 0x39
134  #define BAROMETER_RPDS_H 0x3A
135  #define BAROMETER_DEVICE_ID 0xBD
136 
142  #define BAROMETER_DEFAULT_CONFIG 0xB0
143  #define BAROMETER_CONFIG_ACTIVE_MODE 0x80
144  // End group macro
147 
148 // --------------------------------------------------------------- PUBLIC TYPES
149 
158 typedef uint8_t barometer_select_t;
159 
163 typedef void ( *barometer_master_io_t )( struct barometer_s*, uint8_t, uint8_t*, uint8_t );
164 
168 typedef struct barometer_s
169 {
170  digital_out_t cs;
171 
172  // Input pins
173 
174  digital_in_t rdy;
175 
176  // Modules
177 
178  i2c_master_t i2c;
179  spi_master_t spi;
180 
181  // ctx variable
182 
183  uint8_t slave_address;
184  pin_name_t chip_select;
188 
189 } barometer_t;
190 
194 typedef struct
195 {
196  // Communication gpio pins
197 
198  pin_name_t scl;
199  pin_name_t sda;
200  pin_name_t miso;
201  pin_name_t mosi;
202  pin_name_t sck;
203  pin_name_t cs;
204 
205  // Additional gpio pins
206 
207  pin_name_t rdy;
208 
209  // static variable
210 
211  uint32_t i2c_speed;
212  uint8_t i2c_address;
213 
214  uint32_t spi_speed;
215  spi_master_mode_t spi_mode;
216  spi_master_chip_select_polarity_t cs_polarity;
217 
219 
221  // End types group
223 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
229 #ifdef __cplusplus
230 extern "C"{
231 #endif
232 
242 
251 
264 void barometer_default_cfg ( barometer_t *ctx );
265 
276 void barometer_generic_write ( barometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
277 
288 void barometer_generic_read ( barometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
289 
302 uint8_t barometer_read_data( barometer_t *ctx, uint8_t address );
303 
311 void barometer_set_active( barometer_t *ctx );
312 
324 
336 
347 float barometer_get_pressure( barometer_t *ctx );
348 
359 uint8_t barometer_check_id ( barometer_t *ctx );
360 
371 uint8_t barometer_check_status ( barometer_t *ctx );
372 
382 uint8_t barometer_check_interrupt ( barometer_t *ctx );
383 
384 #ifdef __cplusplus
385 }
386 #endif
387 #endif // _BAROMETER_H_
388  // End public_function group
391 
392 // ------------------------------------------------------------------------- END
barometer_master_io_t
void(* barometer_master_io_t)(struct barometer_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: barometer.h:163
barometer_s::rdy
digital_in_t rdy
Definition: barometer.h:174
barometer_set_active
void barometer_set_active(barometer_t *ctx)
Sets the module active function.
barometer_cfg_t::sel
barometer_select_t sel
Definition: barometer.h:218
barometer_generic_read
void barometer_generic_read(barometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
barometer_get_temperature_c
float barometer_get_temperature_c(barometer_t *ctx)
Read temperature in degrees Celsius function.
barometer_s::spi
spi_master_t spi
Definition: barometer.h:179
barometer_cfg_t::spi_speed
uint32_t spi_speed
Definition: barometer.h:214
barometer_cfg_t::cs
pin_name_t cs
Definition: barometer.h:203
barometer_cfg_setup
void barometer_cfg_setup(barometer_cfg_t *cfg)
Config Object Initialization function.
barometer_s::slave_address
uint8_t slave_address
Definition: barometer.h:183
barometer_s::read_f
barometer_master_io_t read_f
Definition: barometer.h:186
barometer_s::master_sel
barometer_select_t master_sel
Definition: barometer.h:187
barometer_s::cs
digital_out_t cs
Definition: barometer.h:170
barometer_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: barometer.h:211
barometer_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: barometer.h:215
barometer_t
struct barometer_s barometer_t
Click ctx object definition.
barometer_cfg_t::sck
pin_name_t sck
Definition: barometer.h:202
barometer_read_data
uint8_t barometer_read_data(barometer_t *ctx, uint8_t address)
Generic read 8-bit data function.
barometer_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: barometer.h:216
barometer_s::write_f
barometer_master_io_t write_f
Definition: barometer.h:185
barometer_cfg_t::rdy
pin_name_t rdy
Definition: barometer.h:207
barometer_cfg_t
Click configuration structure definition.
Definition: barometer.h:194
barometer_cfg_t::sda
pin_name_t sda
Definition: barometer.h:199
barometer_cfg_t::scl
pin_name_t scl
Definition: barometer.h:198
barometer_cfg_t::mosi
pin_name_t mosi
Definition: barometer.h:201
barometer_init
BAROMETER_RETVAL barometer_init(barometer_t *ctx, barometer_cfg_t *cfg)
Initialization function.
barometer_get_pressure
float barometer_get_pressure(barometer_t *ctx)
Read pressure in milibars function.
barometer_cfg_t::miso
pin_name_t miso
Definition: barometer.h:200
barometer_select_t
uint8_t barometer_select_t
Communication type.
Definition: barometer.h:158
barometer_s::chip_select
pin_name_t chip_select
Definition: barometer.h:184
barometer_check_interrupt
uint8_t barometer_check_interrupt(barometer_t *ctx)
State of interrupt pin function.
barometer_cfg_t::i2c_address
uint8_t i2c_address
Definition: barometer.h:212
BAROMETER_RETVAL
#define BAROMETER_RETVAL
Definition: barometer.h:76
barometer_s
Click ctx object definition.
Definition: barometer.h:168
barometer_generic_write
void barometer_generic_write(barometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
barometer_get_temperature_f
float barometer_get_temperature_f(barometer_t *ctx)
Read temperature in degrees of Fahrenheit function.
barometer_check_id
uint8_t barometer_check_id(barometer_t *ctx)
Check sensor id - Who Am I function.
barometer_check_status
uint8_t barometer_check_status(barometer_t *ctx)
Check sensor status function.
barometer_s::i2c
i2c_master_t i2c
Definition: barometer.h:178
barometer_default_cfg
void barometer_default_cfg(barometer_t *ctx)
Click Default Configuration function.