altitude3  2.0.0.0
altitude3.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 ALTITUDE3_H
36 #define ALTITUDE3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 #include "math.h"
43 #include "string.h"
44 
45 // -------------------------------------------------------------- PUBLIC MACROS
55 #define ALTITUDE3_MAP_MIKROBUS( cfg, mikrobus ) \
56  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
57  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
58 
64 #define ALTITUDE3_RETVAL uint8_t
65 
66 #define ALTITUDE3_OK 0x00
67 #define ALTITUDE3_INIT_ERROR 0xFF
68 
70 #define ALTITUDE3_SLAVE_ADDR 0x63
71 
72 #define ALTITUDE3_LOW_POWER_T_FIRST 0x609C
73 #define ALTITUDE3_LOW_POWER_P_FIRST 0x401A
74 #define ALTITUDE3_NORMAL_T_FIRST 0x6825
75 #define ALTITUDE3_NORMAL_P_FIRST 0x48A3
76 #define ALTITUDE3_LOW_NOISE_T_FIRST 0x70DF
77 #define ALTITUDE3_LOW_NOISE_P_FIRST 0x5059
78 #define ALTITUDE3_ULTRA_LOW_NOISE_T_FIRST 0x7866
79 #define ALTITUDE3_ULTRA_LOW_NOISE_P_FIRST 0x58E0
80 
81 #define ALTITUDE3_OK 0x00
82 #define ALTITUDE3_T_FIRST_ORDER 0x01
83 #define ALTITUDE3_P_FIRST_ORDER 0x02
84 #define ALTITUDE3_INITIALIZED 0x03
85 #define ALTITUDE3_ERROR 0xFF
86  // End group macro
88 // --------------------------------------------------------------- PUBLIC TYPES
94 typedef struct
95 {
96 
97  uint32_t min_delay_us;
98  uint16_t sensor_const[ 4 ];
99  uint32_t p_pa_calib[ 3 ];
100  float lut_lower;
101  float lut_upper;
102  double quadr_factor;
103  uint16_t offst_factor;
104 
106 
107 typedef struct
108 {
109  //Sensor data
110 
111  int8_t temperature;
112  uint32_t pressure;
113  int16_t altitude;
114 
115 } sensor_data_t;
116 
120 typedef struct
121 {
122  // Modules
123 
124  i2c_master_t i2c;
125 
126  // ctx variable
127 
128  uint8_t slave_address;
129 
130  uint8_t update_check;
131 
133 
134 } altitude3_t;
135 
139 typedef struct
140 {
141  // Communication gpio pins
142 
143  pin_name_t scl;
144  pin_name_t sda;
145 
146  // static variable
147 
148  uint32_t i2c_speed;
149  uint8_t i2c_address;
150 
152 
154  // End types group
156 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
157 
163 #ifdef __cplusplus
164 extern "C"{
165 #endif
166 
176 
186 
195 
206 void altitude3_generic_write ( altitude3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
207 
219 void altitude3_generic_read ( altitude3_t *ctx, uint8_t *reg_buf, uint8_t *data_buf, uint8_t len );
220 
231 uint8_t altitude3_measurement_mode ( altitude3_t *ctx, uint16_t mode_cmd );
232 
242 
255 uint8_t altitude3_read_adc_results ( altitude3_t *ctx, uint8_t read_order, int16_t *temperature, uint32_t *pressure );
256 
266 
280 uint8_t altitude3_get_data ( altitude3_t *ctx, uint8_t read_order );
281 
282 #ifdef __cplusplus
283 }
284 #endif
285 #endif // _ALTITUDE3_H_
286  // End public_function group
289 
290 // ------------------------------------------------------------------------- END
altitude3_cfg_t::i2c_address
uint8_t i2c_address
Definition: altitude3.h:149
altitude3_read_adc_results
uint8_t altitude3_read_adc_results(altitude3_t *ctx, uint8_t read_order, int16_t *temperature, uint32_t *pressure)
Read AD Conversion function.
altitude3_generic_write
void altitude3_generic_write(altitude3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
altitude3_param_t::lut_upper
float lut_upper
Definition: altitude3.h:101
altitude3_param_t
Definition: altitude3.h:95
altitude3_get_data
uint8_t altitude3_get_data(altitude3_t *ctx, uint8_t read_order)
Get Data function.
altitude3_cfg_setup
void altitude3_cfg_setup(altitude3_cfg_t *cfg)
Config Object Initialization function.
ALTITUDE3_RETVAL
#define ALTITUDE3_RETVAL
Definition: altitude3.h:64
altitude3_t
Click ctx object definition.
Definition: altitude3.h:121
altitude3_cfg_t::update_check_cfg
uint8_t update_check_cfg
Definition: altitude3.h:151
altitude3_measurement_mode
uint8_t altitude3_measurement_mode(altitude3_t *ctx, uint16_t mode_cmd)
Set Measurement Mode function.
altitude3_t::sens_data
sensor_data_t sens_data
Definition: altitude3.h:132
altitude3_generic_read
void altitude3_generic_read(altitude3_t *ctx, uint8_t *reg_buf, uint8_t *data_buf, uint8_t len)
Generic read function.
altitude3_t::slave_address
uint8_t slave_address
Definition: altitude3.h:128
sensor_data_t::pressure
uint32_t pressure
Definition: altitude3.h:112
altitude3_init_cfg
void altitude3_init_cfg(altitude3_t *ctx, altitude3_param_t *s)
Init configuration function.
altitude3_cfg_t::sda
pin_name_t sda
Definition: altitude3.h:144
altitude3_soft_reset
void altitude3_soft_reset(altitude3_t *ctx)
Software Reset function.
altitude3_cfg_t
Click configuration structure definition.
Definition: altitude3.h:140
sensor_data_t::temperature
int8_t temperature
Definition: altitude3.h:111
altitude3_param_t::min_delay_us
uint32_t min_delay_us
Definition: altitude3.h:97
altitude3_param_t::offst_factor
uint16_t offst_factor
Definition: altitude3.h:103
sensor_data_t::altitude
int16_t altitude
Definition: altitude3.h:113
altitude3_param_t::lut_lower
float lut_lower
Definition: altitude3.h:100
altitude3_cfg_t::scl
pin_name_t scl
Definition: altitude3.h:143
altitude3_param_t::quadr_factor
double quadr_factor
Definition: altitude3.h:102
altitude3_default_cfg
void altitude3_default_cfg(altitude3_t *ctx)
Click Default Configuration function.
sensor_data_t
Definition: altitude3.h:108
altitude3_init
ALTITUDE3_RETVAL altitude3_init(altitude3_t *ctx, altitude3_cfg_t *cfg)
Initialization function.
altitude3_t::update_check
uint8_t update_check
Definition: altitude3.h:130
altitude3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: altitude3.h:148
altitude3_t::i2c
i2c_master_t i2c
Definition: altitude3.h:124