barometer12  2.1.0.0
barometer12.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef BAROMETER12_H
29 #define BAROMETER12_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
74 #define BAROMETER12_CMD_OP_MODE_T_FIRST_LOW_POWER 0x609C
75 #define BAROMETER12_CMD_OP_MODE_T_FIRST_NORMAL 0x6825
76 #define BAROMETER12_CMD_OP_MODE_T_FIRST_LOW_NOISE 0x70DF
77 #define BAROMETER12_CMD_OP_MODE_T_FIRST_ULTRA_LOW_NOISE 0x7866
78 #define BAROMETER12_CMD_OP_MODE_P_FIRST_LOW_POWER 0x401A
79 #define BAROMETER12_CMD_OP_MODE_P_FIRST_NORMAL 0x48A3
80 #define BAROMETER12_CMD_OP_MODE_P_FIRST_LOW_NOISE 0x5059
81 #define BAROMETER12_CMD_OP_MODE_P_FIRST_ULTRA_LOW_NOISE 0x58E0
82 #define BAROMETER12_CMD_SOFT_RESET 0x805D
83 #define BAROMETER12_CMD_DEVICE_ID 0xEFC8
84 #define BAROMETER12_CMD_READ_OTP 0xC7F7
85 #define BAROMETER12_CMD_OTP_READ_ADDRESS_REG 0xC595
86 #define BAROMETER12_CMD_OTP_READ_ADDRESS_PARAM 0x0066
87 
92 #define BAROMETER12_P_PA_CALIB_0 45000.0f
93 #define BAROMETER12_P_PA_CALIB_1 80000.0f
94 #define BAROMETER12_P_PA_CALIB_2 96700.0f
95 #define BAROMETER12_LUT_LOWER 3670016.0f
96 #define BAROMETER12_LUT_UPPER 12058624.0f
97 #define BAROMETER12_QUADR_FACTOR 5.960464477539063e-8f
98 #define BAROMETER12_OFFSET_FACTOR 2048.0f
99 #define BAROMETER12_TEMPERATURE_COEF_1 45.0f
100 #define BAROMETER12_TEMPERATURE_COEF_2 175.0f
101 #define BAROMETER12_TEMPERATURE_COEF_3 65536.0f
102 
107 #define BAROMETER12_OP_MODE_LOW_POWER 0
108 #define BAROMETER12_OP_MODE_NORMAL 1
109 #define BAROMETER12_OP_MODE_LOW_NOISE 2
110 #define BAROMETER12_OP_MODE_ULTRA_LOW_NOISE 3
111 
117 #define BAROMETER12_DEVICE_ADDRESS 0x63
118  // barometer12_set
120 
135 #define BAROMETER12_MAP_MIKROBUS( cfg, mikrobus ) \
136  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
137  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
138  // barometer12_map // barometer12
141 
146 typedef struct
147 {
148  // Modules
149  i2c_master_t i2c;
151  // I2C slave address
152  uint8_t slave_address;
154 } barometer12_t;
155 
160 typedef struct
161 {
162  pin_name_t scl;
163  pin_name_t sda;
165  uint32_t i2c_speed;
166  uint8_t i2c_address;
169 
176 typedef struct
177 {
178  uint16_t op_mode;
179  float sensor_constants[ 4 ];
180  float p_pa_calib[ 3 ];
181  float lut_lower;
182  float lut_upper;
183  float quadr_factor;
184  float offst_factor;
187 
192 typedef enum
193 {
195  BAROMETER12_ERROR = -1
196 
198 
215 
230 
244 
259 err_t barometer12_generic_write ( barometer12_t *ctx, uint16_t cmd, uint16_t *data_in, uint8_t len );
260 
275 err_t barometer12_generic_read ( barometer12_t *ctx, uint16_t cmd, uint16_t *data_out, uint8_t len );
276 
288 err_t barometer12_set_command ( barometer12_t *ctx, uint16_t cmd ) ;
289 
301 
313 err_t barometer12_get_device_id ( barometer12_t *ctx, uint16_t *device_id );
314 
326 
338 err_t barometer12_get_otp ( barometer12_t *ctx, uint16_t *otp_data );
339 
352 
366 err_t barometer12_get_raw_data ( barometer12_t *ctx, uint16_t measurement_comd, uint32_t *pressure, uint16_t *temperature );
367 
381 err_t barometer12_get_press_and_temp ( barometer12_t *ctx, float *pressure, float *temperature );
382 
383 #ifdef __cplusplus
384 }
385 #endif
386 #endif // BAROMETER12_H
387  // barometer12
389 
390 // ------------------------------------------------------------------------ END
barometer12_t
Barometer 12 Click context object.
Definition: barometer12.h:147
barometer12_cfg_setup
void barometer12_cfg_setup(barometer12_cfg_t *cfg)
Barometer 12 configuration object setup function.
barometer12_cfg_t::i2c_address
uint8_t i2c_address
Definition: barometer12.h:166
barometer12_t::slave_address
uint8_t slave_address
Definition: barometer12.h:152
barometer12_invpres_t::lut_upper
float lut_upper
Definition: barometer12.h:182
barometer12_invpres_t::lut_lower
float lut_lower
Definition: barometer12.h:181
barometer12_default_cfg
err_t barometer12_default_cfg(barometer12_t *ctx)
Barometer 12 default configuration function.
barometer12_set_up_otp_read
err_t barometer12_set_up_otp_read(barometer12_t *ctx)
Barometer 12 set up OTP read function.
barometer12_cfg_t::scl
pin_name_t scl
Definition: barometer12.h:162
barometer12_get_otp
err_t barometer12_get_otp(barometer12_t *ctx, uint16_t *otp_data)
Barometer 12 get OTP function.
barometer12_invpres_t
Barometer 12 Click structure to hold pressure sensor related parameters object.
Definition: barometer12.h:177
barometer12_generic_read
err_t barometer12_generic_read(barometer12_t *ctx, uint16_t cmd, uint16_t *data_out, uint8_t len)
Barometer 12 I2C reading function.
barometer12_t::i2c
i2c_master_t i2c
Definition: barometer12.h:149
barometer12_return_value_t
barometer12_return_value_t
Barometer 12 Click return value data.
Definition: barometer12.h:193
barometer12_invpres_t::op_mode
uint16_t op_mode
Definition: barometer12.h:178
barometer12_cfg_t::sda
pin_name_t sda
Definition: barometer12.h:163
barometer12_get_press_and_temp
err_t barometer12_get_press_and_temp(barometer12_t *ctx, float *pressure, float *temperature)
Barometer 12 get pressure and temperature function.
barometer12_cfg_t
Barometer 12 Click configuration object.
Definition: barometer12.h:161
barometer12_generic_write
err_t barometer12_generic_write(barometer12_t *ctx, uint16_t cmd, uint16_t *data_in, uint8_t len)
Barometer 12 I2C writing function.
barometer12_set_command
err_t barometer12_set_command(barometer12_t *ctx, uint16_t cmd)
Barometer 12 set command function.
BAROMETER12_ERROR
@ BAROMETER12_ERROR
Definition: barometer12.h:195
barometer12_get_device_id
err_t barometer12_get_device_id(barometer12_t *ctx, uint16_t *device_id)
Barometer 12 get device ID function.
barometer12_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: barometer12.h:165
barometer12_init
err_t barometer12_init(barometer12_t *ctx, barometer12_cfg_t *cfg)
Barometer 12 initialization function.
barometer12_get_raw_data
err_t barometer12_get_raw_data(barometer12_t *ctx, uint16_t measurement_comd, uint32_t *pressure, uint16_t *temperature)
Barometer 12 get RAW data function.
barometer12_invpres_t::offst_factor
float offst_factor
Definition: barometer12.h:184
barometer12_inv_invpres_calib
err_t barometer12_inv_invpres_calib(barometer12_t *ctx, barometer12_invpres_t *cfg_data)
Barometer 12 inverse process data function.
BAROMETER12_OK
@ BAROMETER12_OK
Definition: barometer12.h:194
barometer12_invpres_t::quadr_factor
float quadr_factor
Definition: barometer12.h:183
barometer12_soft_reset
err_t barometer12_soft_reset(barometer12_t *ctx)
Barometer 12 software reset function.