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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
64#define BAROMETER12_CMD_OP_MODE_T_FIRST_LOW_POWER 0x609C
65#define BAROMETER12_CMD_OP_MODE_T_FIRST_NORMAL 0x6825
66#define BAROMETER12_CMD_OP_MODE_T_FIRST_LOW_NOISE 0x70DF
67#define BAROMETER12_CMD_OP_MODE_T_FIRST_ULTRA_LOW_NOISE 0x7866
68#define BAROMETER12_CMD_OP_MODE_P_FIRST_LOW_POWER 0x401A
69#define BAROMETER12_CMD_OP_MODE_P_FIRST_NORMAL 0x48A3
70#define BAROMETER12_CMD_OP_MODE_P_FIRST_LOW_NOISE 0x5059
71#define BAROMETER12_CMD_OP_MODE_P_FIRST_ULTRA_LOW_NOISE 0x58E0
72#define BAROMETER12_CMD_SOFT_RESET 0x805D
73#define BAROMETER12_CMD_DEVICE_ID 0xEFC8
74#define BAROMETER12_CMD_READ_OTP 0xC7F7
75
80#define BAROMETER12_P_PA_CALIB_0 45000.0f
81#define BAROMETER12_P_PA_CALIB_1 80000.0f
82#define BAROMETER12_P_PA_CALIB_2 96700.0f
83#define BAROMETER12_LUT_LOWER 3670016.0f
84#define BAROMETER12_LUT_UPPER 12058624.0f
85#define BAROMETER12_QUADR_FACTOR 5.960464477539063e-8f
86#define BAROMETER12_OFFSET_FACTOR 2048.0f
87#define BAROMETER12_TEMPERATURE_COEF_1 45.0f
88#define BAROMETER12_TEMPERATURE_COEF_2 175.0f
89#define BAROMETER12_TEMPERATURE_COEF_3 65536.0f
90
95#define BAROMETER12_OP_MODE_LOW_POWER 0
96#define BAROMETER12_OP_MODE_NORMAL 1
97#define BAROMETER12_OP_MODE_LOW_NOISE 2
98#define BAROMETER12_OP_MODE_ULTRA_LOW_NOISE 3
99
105#define BAROMETER12_DEVICE_ADDRESS 0x63
106 // barometer12_set
108
123#define BAROMETER12_MAP_MIKROBUS( cfg, mikrobus ) \
124 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
125 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
126 // barometer12_map // barometer12
129
134typedef struct
135{
136 // Modules
137 i2c_master_t i2c;
139 // I2C slave address
143
148typedef struct
149{
150 pin_name_t scl;
151 pin_name_t sda;
153 uint32_t i2c_speed;
154 uint8_t i2c_address;
157
164typedef struct
165{
166 uint16_t op_mode;
167 float sensor_constants[ 4 ];
168 float p_pa_calib[ 3 ];
169 float lut_lower;
170 float lut_upper;
175
180typedef enum
181{
184
186
203
218
232
247err_t barometer12_generic_write ( barometer12_t *ctx, uint16_t cmd, uint16_t *data_in, uint8_t len );
248
263err_t barometer12_generic_read ( barometer12_t *ctx, uint16_t cmd, uint16_t *data_out, uint8_t len );
264
276err_t barometer12_set_command ( barometer12_t *ctx, uint16_t cmd ) ;
277
289
301err_t barometer12_get_device_id ( barometer12_t *ctx, uint16_t *device_id );
302
314
326err_t barometer12_get_otp ( barometer12_t *ctx, uint16_t *otp_data );
327
340
354err_t barometer12_get_raw_data ( barometer12_t *ctx, uint16_t measurement_comd, uint32_t *pressure, uint16_t *temperature );
355
369err_t barometer12_get_pressure_and_temperature ( barometer12_t *ctx, float *pressure, float *temperature );
370
371#ifdef __cplusplus
372}
373#endif
374#endif // BAROMETER12_H
375 // barometer12
377
378// ------------------------------------------------------------------------ END
barometer12_return_value_t
Barometer 12 Click return value data.
Definition: barometer12.h:181
@ BAROMETER12_OK
Definition: barometer12.h:182
@ BAROMETER12_ERROR
Definition: barometer12.h:183
err_t barometer12_set_up_otp_read(barometer12_t *ctx)
Barometer 12 set up OTP read function.
err_t barometer12_default_cfg(barometer12_t *ctx)
Barometer 12 default configuration function.
err_t barometer12_inv_invpres_calibration(barometer12_t *ctx, barometer12_invpres_t *cfg_data)
Barometer 12 inverse process data function.
err_t barometer12_get_device_id(barometer12_t *ctx, uint16_t *device_id)
Barometer 12 get device ID function.
err_t barometer12_generic_write(barometer12_t *ctx, uint16_t cmd, uint16_t *data_in, uint8_t len)
Barometer 12 I2C writing function.
err_t barometer12_set_command(barometer12_t *ctx, uint16_t cmd)
Barometer 12 set command function.
err_t barometer12_generic_read(barometer12_t *ctx, uint16_t cmd, uint16_t *data_out, uint8_t len)
Barometer 12 I2C reading function.
err_t barometer12_soft_reset(barometer12_t *ctx)
Barometer 12 software reset function.
err_t barometer12_get_pressure_and_temperature(barometer12_t *ctx, float *pressure, float *temperature)
Barometer 12 get pressure and temperature function.
err_t barometer12_init(barometer12_t *ctx, barometer12_cfg_t *cfg)
Barometer 12 initialization function.
void barometer12_cfg_setup(barometer12_cfg_t *cfg)
Barometer 12 configuration object setup function.
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.
err_t barometer12_get_otp(barometer12_t *ctx, uint16_t *otp_data)
Barometer 12 get OTP function.
Barometer 12 Click configuration object.
Definition: barometer12.h:149
uint32_t i2c_speed
Definition: barometer12.h:153
pin_name_t scl
Definition: barometer12.h:150
pin_name_t sda
Definition: barometer12.h:151
uint8_t i2c_address
Definition: barometer12.h:154
Barometer 12 Click structure to hold pressure sensor related parameters object.
Definition: barometer12.h:165
float lut_lower
Definition: barometer12.h:169
float offst_factor
Definition: barometer12.h:172
float quadr_factor
Definition: barometer12.h:171
float lut_upper
Definition: barometer12.h:170
uint16_t op_mode
Definition: barometer12.h:166
Barometer 12 Click context object.
Definition: barometer12.h:135
i2c_master_t i2c
Definition: barometer12.h:137
uint8_t slave_address
Definition: barometer12.h:140