altitude2  2.0.0.0
altitude2.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 ALTITUDE2_H
36 #define ALTITUDE2_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 ALTITUDE2_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 
68 #define ALTITUDE2_MASTER_I2C 0
69 #define ALTITUDE2_MASTER_SPI 1
70 
76 #define ALTITUDE2_RETVAL uint8_t
77 
78 #define ALTITUDE2_OK 0x00
79 #define ALTITUDE2_INIT_ERROR 0xFF
80 
86 #define ALTITUDE2_DEVICE_ADDR_0 0x76
87 #define ALTITUDE2_DEVICE_ADDR_1 0x77
88 
95 #define ALTITUDE2_RATIO_256 0x00
96 #define ALTITUDE2_RATIO_512 0x01
97 #define ALTITUDE2_RATIO_1024 0x02
98 #define ALTITUDE2_RATIO_2048 0x03
99 #define ALTITUDE2_RATIO_4096 0x04
100 
107 #define ALTITUDE2_MANUFACTURER_RESERVED 0x00
108 #define ALTITUDE2_C1_SENS 0x01
109 #define ALTITUDE2_C2_OFF 0x02
110 #define ALTITUDE2_C3_TCS 0x03
111 #define ALTITUDE2_C4_TCO 0x04
112 #define ALTITUDE2_C5_TREF 0x05
113 #define ALTITUDE2_C6_TEMPSENS 0x06
114 #define ALTITUDE2_CRC 0x07
115  // End group macro
120 // --------------------------------------------------------------- PUBLIC TYPES
129 typedef uint8_t altitude2_select_t;
130 
134 typedef void ( *altitude2_master_io_t )( struct altitude2_s*, uint8_t, uint32_t*, uint8_t );
135 
139 typedef struct altitude2_s
140 {
141 
142  digital_out_t cs;
143 
144  // Modules
145 
146  i2c_master_t i2c;
147  spi_master_t spi;
148 
149  // ctx variable
150 
151  uint8_t slave_address;
152  pin_name_t chip_select;
156 
157  uint8_t select_driver;
158  uint8_t ratio_temp;
159  uint8_t ratio_press;
160  volatile uint32_t data_prom[ 6 ];
161 
162 
163 
165 
169 typedef struct
170 {
171  // Communication gpio pins
172 
173  pin_name_t scl;
174  pin_name_t sda;
175  pin_name_t miso;
176  pin_name_t mosi;
177  pin_name_t sck;
178  pin_name_t cs;
179 
180  // static variable
181 
182  uint32_t i2c_speed;
183  uint8_t i2c_address;
184  uint32_t spi_speed;
185  uint8_t spi_mode;
186  spi_master_chip_select_polarity_t cs_polarity;
187 
189 
191  // End types group
193 // ------------------------------------------------------------------ CONSTANTS // End constants group
202 // ------------------------------------------------------------------ VARIABLES // End variable group
210 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
216 #ifdef __cplusplus
217 extern "C"{
218 #endif
219 
229 
238 
248 uint8_t altitude2_read_prom ( altitude2_t *ctx, uint8_t select_data, uint32_t *data_out );
249 
257 
258 
268 uint8_t altitude2_set_ratio( altitude2_t *ctx, uint8_t temp_ratio, uint8_t press_ratio );
269 
270 
283 void altitude2_read_data( altitude2_t *ctx, float *temp_data, float *press_data, float *altitude_data );
284 
285 
286 #ifdef __cplusplus
287 }
288 #endif
289 #endif // _ALTITUDE2_H_
290  // End public_function group
293 
294 // ------------------------------------------------------------------------- END
altitude2_cfg_t::cs
pin_name_t cs
Definition: altitude2.h:178
altitude2_s::cs
digital_out_t cs
Definition: altitude2.h:142
altitude2_s::i2c
i2c_master_t i2c
Definition: altitude2.h:146
altitude2_reset
void altitude2_reset(altitude2_t *ctx)
Reset function.
altitude2_s::data_prom
volatile uint32_t data_prom[6]
Definition: altitude2.h:160
altitude2_s::master_sel
altitude2_select_t master_sel
Definition: altitude2.h:155
altitude2_s
Click ctx object definition.
Definition: altitude2.h:140
altitude2_cfg_setup
void altitude2_cfg_setup(altitude2_cfg_t *cfg)
Config Object Initialization function.
altitude2_s::ratio_temp
uint8_t ratio_temp
Definition: altitude2.h:158
altitude2_select_t
uint8_t altitude2_select_t
Communication type.
Definition: altitude2.h:129
altitude2_cfg_t::sda
pin_name_t sda
Definition: altitude2.h:174
altitude2_cfg_t::miso
pin_name_t miso
Definition: altitude2.h:175
altitude2_cfg_t::spi_speed
uint32_t spi_speed
Definition: altitude2.h:184
altitude2_cfg_t::spi_mode
uint8_t spi_mode
Definition: altitude2.h:185
altitude2_read_prom
uint8_t altitude2_read_prom(altitude2_t *ctx, uint8_t select_data, uint32_t *data_out)
Calibration data read function.
ALTITUDE2_RETVAL
#define ALTITUDE2_RETVAL
Definition: altitude2.h:76
altitude2_cfg_t::scl
pin_name_t scl
Definition: altitude2.h:173
altitude2_cfg_t::sck
pin_name_t sck
Definition: altitude2.h:177
altitude2_init
ALTITUDE2_RETVAL altitude2_init(altitude2_t *ctx, altitude2_cfg_t *cfg)
Initialization function.
altitude2_s::select_driver
uint8_t select_driver
Definition: altitude2.h:157
altitude2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: altitude2.h:182
altitude2_s::slave_address
uint8_t slave_address
Definition: altitude2.h:151
altitude2_cfg_t
Click configuration structure definition.
Definition: altitude2.h:170
altitude2_s::send_comm_f
altitude2_master_io_t send_comm_f
Definition: altitude2.h:153
altitude2_cfg_t::mosi
pin_name_t mosi
Definition: altitude2.h:176
altitude2_s::ratio_press
uint8_t ratio_press
Definition: altitude2.h:159
altitude2_s::chip_select
pin_name_t chip_select
Definition: altitude2.h:152
altitude2_read_data
void altitude2_read_data(altitude2_t *ctx, float *temp_data, float *press_data, float *altitude_data)
Data read function.
altitude2_t
struct altitude2_s altitude2_t
Click ctx object definition.
altitude2_s::send_comm_resp_f
altitude2_master_io_t send_comm_resp_f
Definition: altitude2.h:154
altitude2_set_ratio
uint8_t altitude2_set_ratio(altitude2_t *ctx, uint8_t temp_ratio, uint8_t press_ratio)
Set ratio function.
altitude2_s::spi
spi_master_t spi
Definition: altitude2.h:147
altitude2_cfg_t::sel
altitude2_select_t sel
Definition: altitude2.h:188
altitude2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: altitude2.h:186
altitude2_cfg_t::i2c_address
uint8_t i2c_address
Definition: altitude2.h:183
altitude2_master_io_t
void(* altitude2_master_io_t)(struct altitude2_s *, uint8_t, uint32_t *, uint8_t)
Master Input/Output type.
Definition: altitude2.h:134