airflow 2.0.0.0
airflow.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 AIRFLOW_H
29#define AIRFLOW_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#include "drv_spi_master.h"
39
60#define AIRFLOW_I2C_CMD_RESET 0x11
61#define AIRFLOW_I2C_CMD_GET_SIG 0x23
62#define AIRFLOW_I2C_CMD_GET_DATA 0x26
63#define AIRFLOW_I2C_CMD_CONV 0x27
64#define AIRFLOW_I2C_CMD_GET_NON_BAR 0x50
65#define AIRFLOW_I2C_CMD_GET_NON_BLOCK_BAR 0x51
70#define AIRFLOW_SPI_CMD_NONE 0x00
71#define AIRFLOW_SPI_CMD_RESET 0x01
72#define AIRFLOW_SPI_CMD_CONV 0x04
73#define AIRFLOW_SPI_CMD_STOP 0x05
74#define AIRFLOW_SPI_CMD_GET_DATA 0x06
75#define AIRFLOW_SPI_CMD_GET_BAR 0x07
76#define AIRFLOW_SPI_CMD_GET_SIG 0x0C
77 // airflow_reg
79
94#define AIRFLOW_NO_BAROMETRIC_CORRECTION 0x01
95#define AIRFLOW_BAROMETRIC_CORRECTION 0x03
96
102#define AIRFLOW_SET_DEV_ADDR 0x5B
103 // airflow_set
105
120#define AIRFLOW_MAP_MIKROBUS( cfg, mikrobus ) \
121 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
122 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
123 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
124 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
125 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
126 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
127 cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
128 // airflow_map // airflow
131
136typedef enum
137{
142
147typedef err_t ( *airflow_master_io_t )( struct airflow_s*, uint8_t, uint8_t*, uint8_t );
153typedef struct airflow_s
154{
155 digital_in_t rdy;
157 i2c_master_t i2c;
158 spi_master_t spi;
161 pin_name_t chip_select;
169 char part_number[ 12 ];
170 char lot_number[ 8 ];
173 uint16_t scale_factor;
174 char calibration_id[ 3 ];
175 uint8_t week;
176 uint8_t year;
178
180
185typedef struct
186{
187 pin_name_t scl;
188 pin_name_t sda;
189 pin_name_t miso;
190 pin_name_t mosi;
191 pin_name_t sck;
192 pin_name_t cs;
193 pin_name_t rdy;
195 uint32_t i2c_speed;
196 uint8_t i2c_address;
198 uint32_t spi_speed;
199 spi_master_mode_t spi_mode;
200 spi_master_chip_select_polarity_t cs_polarity;
205
210typedef enum
211{
213 AIRFLOW_ERROR = -1
214
216
233
249
265
280
295err_t airflow_generic_write ( airflow_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
296
311err_t airflow_generic_read ( airflow_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
312
322
332
344err_t airflow_get_differential_pressure ( airflow_t *ctx, float *pressure );
345
358err_t airflow_get_atmospheric_pressure ( airflow_t *ctx, float *pressure, float *temperature );
359
372err_t airflow_get_status ( airflow_t *ctx, uint8_t *status );
373
374#ifdef __cplusplus
375}
376#endif
377#endif // AIRFLOW_H
378 // airflow
380
381// ------------------------------------------------------------------------ END
airflow_drv_t
Air Flow Click driver selector.
Definition: airflow.h:137
@ AIRFLOW_DRV_SEL_I2C
Definition: airflow.h:139
@ AIRFLOW_DRV_SEL_SPI
Definition: airflow.h:138
err_t(* airflow_master_io_t)(struct airflow_s *, uint8_t, uint8_t *, uint8_t)
Air Flow Click driver interface.
Definition: airflow.h:147
airflow_return_value_t
Air Flow Click return value data.
Definition: airflow.h:211
@ AIRFLOW_OK
Definition: airflow.h:212
@ AIRFLOW_ERROR
Definition: airflow.h:213
struct airflow_s airflow_t
Air Flow Click context object.
void airflow_reset_device(airflow_t *ctx)
Reset device.
err_t airflow_get_status(airflow_t *ctx, uint8_t *status)
Reads status data.
err_t airflow_generic_write(airflow_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Air Flow data writing function.
err_t airflow_get_differential_pressure(airflow_t *ctx, float *pressure)
Reads differential pressure.
err_t airflow_default_cfg(airflow_t *ctx)
Air Flow default configuration function.
void airflow_drv_interface_selection(airflow_cfg_t *cfg, airflow_drv_t drv_sel)
Air Flow driver interface setup function.
err_t airflow_init(airflow_t *ctx, airflow_cfg_t *cfg)
Air Flow initialization function.
err_t airflow_get_atmospheric_pressure(airflow_t *ctx, float *pressure, float *temperature)
Reads atmospheric pressure and temperature.
uint8_t airflow_check_ready(airflow_t *ctx)
Reads ready pin state.
void airflow_cfg_setup(airflow_cfg_t *cfg)
Air Flow configuration object setup function.
err_t airflow_generic_read(airflow_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Air Flow data reading function.
Air Flow Click configuration object.
Definition: airflow.h:186
uint32_t i2c_speed
Definition: airflow.h:195
airflow_drv_t drv_sel
Definition: airflow.h:202
spi_master_chip_select_polarity_t cs_polarity
Definition: airflow.h:200
pin_name_t sck
Definition: airflow.h:191
spi_master_mode_t spi_mode
Definition: airflow.h:199
pin_name_t mosi
Definition: airflow.h:190
uint32_t spi_speed
Definition: airflow.h:198
pin_name_t scl
Definition: airflow.h:187
pin_name_t rdy
Definition: airflow.h:193
pin_name_t miso
Definition: airflow.h:189
pin_name_t sda
Definition: airflow.h:188
pin_name_t cs
Definition: airflow.h:192
uint8_t i2c_address
Definition: airflow.h:196
Air Flow Click context object.
Definition: airflow.h:154
spi_master_t spi
Definition: airflow.h:158
uint8_t major_fw_ver
Definition: airflow.h:167
char output_type
Definition: airflow.h:172
uint16_t pressure_range
Definition: airflow.h:171
uint8_t minor_fw_ver
Definition: airflow.h:168
uint8_t week
Definition: airflow.h:175
airflow_drv_t drv_sel
Definition: airflow.h:162
char lot_number[8]
Definition: airflow.h:170
uint8_t year
Definition: airflow.h:176
char calibration_id[3]
Definition: airflow.h:174
char part_number[12]
Definition: airflow.h:169
i2c_master_t i2c
Definition: airflow.h:157
airflow_master_io_t write_f
Definition: airflow.h:164
uint16_t scale_factor
Definition: airflow.h:173
airflow_master_io_t read_f
Definition: airflow.h:165
uint8_t slave_address
Definition: airflow.h:160
uint16_t sequence_number
Definition: airflow.h:177
pin_name_t chip_select
Definition: airflow.h:161
digital_in_t rdy
Definition: airflow.h:155