altitude5 2.0.0.0
altitude5.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 ALTITUDE5_H
29#define ALTITUDE5_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_i2c_master.h"
36#include "drv_analog_in.h"
37
64#define ALTITUDE5_SET_DEV_ADDR 0x4D
65 // altitude5_set
67
82#define ALTITUDE5_MAP_MIKROBUS( cfg, mikrobus ) \
83 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
84 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
85 cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
86 // altitude5_map // altitude5
89
90typedef enum
91{
96
97typedef err_t ( *altitude5_master_io_t )( struct altitude5_s*, uint16_t* );
98
103typedef struct altitude5_s
104{
105 analog_in_t adc;
107 // Modules
108 i2c_master_t i2c;
110 // I2C slave address
117 int16_t offset;
122
127typedef struct
128{
129 pin_name_t an;
131 analog_in_resolution_t resolution;
132 float vref;
134 pin_name_t scl;
135 pin_name_t sda;
137 uint32_t i2c_speed;
138 uint8_t i2c_address;
141
142 int16_t adc_offset;
147
148
153typedef enum
154{
156 ALTITUDE5_ERROR = -1
157
159
176
192
207
222err_t altitude5_get_adc ( altitude5_t *ctx, uint16_t *data_out );
223
237err_t altitude5_read_an_pin_voltage ( altitude5_t *ctx, float *data_out );
238
253err_t altitude5_get_adc_voltage ( altitude5_t *ctx, float *adc_vtg );
254
269err_t altitude5_get_pressure ( altitude5_t *ctx, float *pressure );
270
285err_t altitude5_get_altitude ( altitude5_t *ctx, float *altitude );
286
287#ifdef __cplusplus
288}
289#endif
290#endif // ALTITUDE5_H
291 // altitude5
293
294// ------------------------------------------------------------------------ END
altitude5_drv_t
Definition: altitude5.h:91
@ ALTITUDE5_DRV_SEL_AN
Definition: altitude5.h:92
@ ALTITUDE5_DRV_SEL_I2C
Definition: altitude5.h:93
struct altitude5_s altitude5_t
Altitude 5 Click context object.
altitude5_return_value_t
Altitude 5 Click return value data.
Definition: altitude5.h:154
@ ALTITUDE5_OK
Definition: altitude5.h:155
@ ALTITUDE5_ERROR
Definition: altitude5.h:156
err_t(* altitude5_master_io_t)(struct altitude5_s *, uint16_t *)
Definition: altitude5.h:97
err_t altitude5_read_an_pin_voltage(altitude5_t *ctx, float *data_out)
Altitude 5 read AN pin voltage level function.
err_t altitude5_init(altitude5_t *ctx, altitude5_cfg_t *cfg)
Altitude 5 initialization function.
err_t altitude5_get_adc(altitude5_t *ctx, uint16_t *data_out)
Altitude 5 get ADC function.
err_t altitude5_get_altitude(altitude5_t *ctx, float *altitude)
Altitude 5 get altitude function.
void altitude5_cfg_setup(altitude5_cfg_t *cfg)
Altitude 5 configuration object setup function.
err_t altitude5_get_pressure(altitude5_t *ctx, float *pressure)
Altitude 5 get pressure function.
err_t altitude5_get_adc_voltage(altitude5_t *ctx, float *adc_vtg)
Altitude 5 get ADC voltage function.
err_t altitude5_default_cfg(altitude5_t *ctx)
Altitude 5 default configuration function.
Altitude 5 Click configuration object.
Definition: altitude5.h:128
float temperature_degree_celsius
Definition: altitude5.h:144
analog_in_resolution_t resolution
Definition: altitude5.h:131
float vref
Definition: altitude5.h:132
uint32_t i2c_speed
Definition: altitude5.h:137
altitude5_drv_t drv_sel
Definition: altitude5.h:140
int16_t adc_offset
Definition: altitude5.h:142
float sea_level_pressure
Definition: altitude5.h:143
pin_name_t scl
Definition: altitude5.h:134
pin_name_t sda
Definition: altitude5.h:135
pin_name_t an
Definition: altitude5.h:129
uint8_t i2c_address
Definition: altitude5.h:138
Altitude 5 Click context object.
Definition: altitude5.h:104
float sea_lvl_pressure
Definition: altitude5.h:118
int16_t offset
Definition: altitude5.h:117
altitude5_drv_t drv_sel
Definition: altitude5.h:113
i2c_master_t i2c
Definition: altitude5.h:108
altitude5_master_io_t read_adc_f
Definition: altitude5.h:115
uint8_t slave_address
Definition: altitude5.h:111
analog_in_t adc
Definition: altitude5.h:105
float temperature
Definition: altitude5.h:119