airvelocity 2.1.0.0
airvelocity.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 AIRVELOCITY_H
29#define AIRVELOCITY_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
39#ifdef PREINIT_SUPPORTED
40#include "preinit.h"
41#endif
42
43#ifdef MikroCCoreVersion
44 #if MikroCCoreVersion >= 1
45 #include "delays.h"
46 #endif
47#endif
48
49#include "drv_digital_out.h"
50#include "drv_digital_in.h"
51#include "drv_i2c_master.h"
52
74// TODO -- dodati makroe koji definisu komande/vrednosti koje se upisuju u registre
75
81#define AIRVELOCITY_DEVICE_ADDRESS 0x28
82
83 // airvelocity_set
84
99#define AIRVELOCITY_MAP_MIKROBUS( cfg, mikrobus ) \
100 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
101 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
102
103 // airvelocity_map
104 // airvelocity
105
110typedef struct
111{
112 // Modules
113 i2c_master_t i2c;
115 // I2C slave address
119
124typedef struct
125{
126 pin_name_t scl;
127 pin_name_t sda;
129 uint32_t i2c_speed;
130 uint8_t i2c_address;
133
144
161
176
188err_t airvelocity_read_output ( airvelocity_t *ctx, uint16_t *out_counts );
189
197float airvelocity_convert_counts_to_mps ( uint16_t out_counts );
198
199#ifdef __cplusplus
200}
201#endif
202#endif // AIRVELOCITY_H
203
204 // airvelocity
205
206// ------------------------------------------------------------------------ END
airvelocity_return_value_t
Air Velocity Click return value data.
Definition airvelocity.h:139
@ AIRVELOCITY_OK
Definition airvelocity.h:140
@ AIRVELOCITY_ERROR
Definition airvelocity.h:141
err_t airvelocity_read_output(airvelocity_t *ctx, uint16_t *out_counts)
Air Velocity read output function.
void airvelocity_cfg_setup(airvelocity_cfg_t *cfg)
Air Velocity configuration object setup function.
err_t airvelocity_init(airvelocity_t *ctx, airvelocity_cfg_t *cfg)
Air Velocity initialization function.
float airvelocity_convert_counts_to_mps(uint16_t out_counts)
Air Velocity convert counts to mps function.
Air Velocity Click configuration object.
Definition airvelocity.h:125
uint32_t i2c_speed
Definition airvelocity.h:129
pin_name_t scl
Definition airvelocity.h:126
pin_name_t sda
Definition airvelocity.h:127
uint8_t i2c_address
Definition airvelocity.h:130
Air Velocity Click context object.
Definition airvelocity.h:111
i2c_master_t i2c
Definition airvelocity.h:113
uint8_t slave_address
Definition airvelocity.h:116