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
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
70 // TODO -- dodati makroe koji definisu komande/vrednosti koje se upisuju u registre
71 
77 #define AIRVELOCITY_DEVICE_ADDRESS 0x28
78  // airvelocity_set
80 
95 #define AIRVELOCITY_MAP_MIKROBUS( cfg, mikrobus ) \
96  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
97  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
98  // airvelocity_map // airvelocity
101 
106 typedef struct
107 {
108  // Modules
109  i2c_master_t i2c;
111  // I2C slave address
112  uint8_t slave_address;
114 } airvelocity_t;
115 
120 typedef struct
121 {
122  pin_name_t scl;
123  pin_name_t sda;
125  uint32_t i2c_speed;
126  uint8_t i2c_address;
129 
134 typedef enum
135 {
137  AIRVELOCITY_ERROR = -1
138 
140 
157 
172 
184 err_t airvelocity_read_output ( airvelocity_t *ctx, uint16_t *out_counts );
185 
193 float airvelocity_convert_counts_to_mps ( uint16_t out_counts );
194 
195 #ifdef __cplusplus
196 }
197 #endif
198 #endif // AIRVELOCITY_H
199  // airvelocity
201 
202 // ------------------------------------------------------------------------ END
airvelocity_cfg_t
Air Velocity Click configuration object.
Definition: airvelocity.h:121
airvelocity_t
Air Velocity Click context object.
Definition: airvelocity.h:107
AIRVELOCITY_ERROR
@ AIRVELOCITY_ERROR
Definition: airvelocity.h:137
airvelocity_cfg_t::scl
pin_name_t scl
Definition: airvelocity.h:122
airvelocity_init
err_t airvelocity_init(airvelocity_t *ctx, airvelocity_cfg_t *cfg)
Air Velocity initialization function.
airvelocity_convert_counts_to_mps
float airvelocity_convert_counts_to_mps(uint16_t out_counts)
Air Velocity convert counts to mps function.
airvelocity_t::slave_address
uint8_t slave_address
Definition: airvelocity.h:112
airvelocity_cfg_t::sda
pin_name_t sda
Definition: airvelocity.h:123
AIRVELOCITY_OK
@ AIRVELOCITY_OK
Definition: airvelocity.h:136
airvelocity_t::i2c
i2c_master_t i2c
Definition: airvelocity.h:109
airvelocity_cfg_setup
void airvelocity_cfg_setup(airvelocity_cfg_t *cfg)
Air Velocity configuration object setup function.
airvelocity_return_value_t
airvelocity_return_value_t
Air Velocity Click return value data.
Definition: airvelocity.h:135
airvelocity_cfg_t::i2c_address
uint8_t i2c_address
Definition: airvelocity.h:126
airvelocity_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: airvelocity.h:125
airvelocity_read_output
err_t airvelocity_read_output(airvelocity_t *ctx, uint16_t *out_counts)
Air Velocity read output function.