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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 #include "drv_spi_master.h"
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
64 #define BAROMETER_MAP_MIKROBUS( cfg, mikrobus ) \
65  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
66  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
67  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
68  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
69  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
70  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
71  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
72 
78 #define BAROMETER_MASTER_I2C 0
79 #define BAROMETER_MASTER_SPI 1
80 
86 #define BAROMETER_RETVAL uint8_t
87 
88 #define BAROMETER_OK 0x00
89 #define BAROMETER_INIT_ERROR 0xFF
90 
96  #define BAROMETER_I2C_ADDRESS_0 0x5C
97 
103  #define BAROMETER_I2C_ADDRESS_1 0x5D
104 
110  #define BAROMETER_REF_P_XL 0x08
111  #define BAROMETER_REF_P_L 0x09
112  #define BAROMETER_REF_P_H 0x0A
113 
119  #define BAROMETER_WHO_AM_I 0x0F
120 
126  #define BAROMETER_RES_CONF 0x10
127  #define BAROMETER_CTRL_REG1 0x20
128  #define BAROMETER_CTRL_REG2 0x21
129  #define BAROMETER_CTRL_REG3 0x22
130  #define BAROMETER_CTRL_REG4 0x23
131  #define BAROMETER_INTERRUPT_CFG 0x24
132  #define BAROMETER_INT_SOURCE 0x25
133  #define BAROMETER_STATUS_REG 0x27
134  #define BAROMETER_PRESS_OUT_XL 0x28
135  #define BAROMETER_PRESS_OUT_L 0x29
136  #define BAROMETER_PRESS_OUT_H 0x2A
137  #define BAROMETER_TEMP_OUT_L 0x2B
138  #define BAROMETER_TEMP_OUT_H 0x2C
139  #define BAROMETER_FIFO_CTRL 0x2E
140  #define BAROMETER_FIFO_STATUS 0x2F
141  #define BAROMETER_THS_P_L 0x30
142  #define BAROMETER_THS_P_H 0x31
143  #define BAROMETER_RPDS_L 0x39
144  #define BAROMETER_RPDS_H 0x3A
145  #define BAROMETER_DEVICE_ID 0xBD
146 
152  #define BAROMETER_DEFAULT_CONFIG 0xB0
153  #define BAROMETER_CONFIG_ACTIVE_MODE 0x80
154  // End group macro
157 
158 // --------------------------------------------------------------- PUBLIC TYPES
159 
168 typedef uint8_t barometer_select_t;
169 
173 typedef void ( *barometer_master_io_t )( struct barometer_s*, uint8_t, uint8_t*, uint8_t );
174 
178 typedef struct barometer_s
179 {
180  digital_out_t cs;
181 
182  // Input pins
183 
184  digital_in_t rdy;
185 
186  // Modules
187 
188  i2c_master_t i2c;
189  spi_master_t spi;
190 
191  // ctx variable
192 
193  uint8_t slave_address;
194  pin_name_t chip_select;
198 
200 
204 typedef struct
205 {
206  // Communication gpio pins
207 
208  pin_name_t scl;
209  pin_name_t sda;
210  pin_name_t miso;
211  pin_name_t mosi;
212  pin_name_t sck;
213  pin_name_t cs;
214 
215  // Additional gpio pins
216 
217  pin_name_t rdy;
218 
219  // static variable
220 
221  uint32_t i2c_speed;
222  uint8_t i2c_address;
223 
224  uint32_t spi_speed;
225  spi_master_mode_t spi_mode;
226  spi_master_chip_select_polarity_t cs_polarity;
227 
229 
231  // End types group
233 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
239 #ifdef __cplusplus
240 extern "C"{
241 #endif
242 
252 
261 
275 
286 void barometer_generic_write ( barometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
287 
298 void barometer_generic_read ( barometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
299 
312 uint8_t barometer_read_data( barometer_t *ctx, uint8_t address );
313 
322 
334 
346 
358 
370 
382 
393 
394 #ifdef __cplusplus
395 }
396 #endif
397 #endif // _BAROMETER_H_
398  // End public_function group
401 
402 // ------------------------------------------------------------------------- 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:173
barometer_s::rdy
digital_in_t rdy
Definition: barometer.h:184
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:228
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:189
barometer_cfg_t::spi_speed
uint32_t spi_speed
Definition: barometer.h:224
barometer_cfg_t::cs
pin_name_t cs
Definition: barometer.h:213
barometer_t
struct barometer_s barometer_t
Click ctx object definition.
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:193
barometer_s::read_f
barometer_master_io_t read_f
Definition: barometer.h:196
barometer_s::master_sel
barometer_select_t master_sel
Definition: barometer.h:197
barometer_s::cs
digital_out_t cs
Definition: barometer.h:180
barometer_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: barometer.h:221
barometer_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: barometer.h:225
barometer_cfg_t::sck
pin_name_t sck
Definition: barometer.h:212
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:226
barometer_s::write_f
barometer_master_io_t write_f
Definition: barometer.h:195
barometer_cfg_t::rdy
pin_name_t rdy
Definition: barometer.h:217
barometer_cfg_t
Click configuration structure definition.
Definition: barometer.h:205
barometer_cfg_t::sda
pin_name_t sda
Definition: barometer.h:209
barometer_cfg_t::scl
pin_name_t scl
Definition: barometer.h:208
barometer_cfg_t::mosi
pin_name_t mosi
Definition: barometer.h:211
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:210
barometer_select_t
uint8_t barometer_select_t
Communication type.
Definition: barometer.h:168
barometer_s::chip_select
pin_name_t chip_select
Definition: barometer.h:194
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:222
BAROMETER_RETVAL
#define BAROMETER_RETVAL
Definition: barometer.h:86
barometer_s
Click ctx object definition.
Definition: barometer.h:179
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:188
barometer_default_cfg
void barometer_default_cfg(barometer_t *ctx)
Click Default Configuration function.