airquality4  2.0.0.0
airquality4.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 AIRQUALITY4_H
36 #define AIRQUALITY4_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define AIRQUALITY4_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
55 
61 #define AIRQUALITY4_RETVAL uint8_t
62 
63 #define AIRQUALITY4_OK 0x00
64 #define AIRQUALITY4_INIT_ERROR 0xFF
65  // End group macro
68 // --------------------------------------------------------------- PUBLIC TYPES
77 typedef struct
78 {
79 
80  // Modules
81 
82  i2c_master_t i2c;
83 
84  // ctx variable
85 
86  uint8_t slave_address;
87 
89 
93 typedef struct
94 {
95  // Communication gpio pins
96 
97  pin_name_t scl;
98  pin_name_t sda;
99 
100  // static variable
101 
102  uint32_t i2c_speed;
103  uint8_t i2c_address;
104 
106  // End types group
108 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
109 
115 #ifdef __cplusplus
116 extern "C"{
117 #endif
118 
128 
138 
147 
156 void air_quality4_get_id ( airquality4_t *ctx, uint8_t *data_buf);
157 
166 
176 void air_quality4_measure_quality ( airquality4_t *ctx, uint8_t *read_air );
177 
187 void air_quality4_get_co2_and_tvoc ( airquality4_t *ctx, uint16_t *value);
188 
198 void air_quality4_measure_signal ( airquality4_t *ctx, uint8_t *read_air);
199 
209 void air_quality4_get_h2_and_ethon ( airquality4_t *ctx, uint16_t *value );
210 
221 void air_quality4_get_baseline ( airquality4_t *ctx, uint8_t *read_air);
222 
231 
241 
250 void air_quality4_get_version ( airquality4_t *ctx, uint8_t *version );
251 
260 void air_quality4_get_version ( airquality4_t *ctx, uint8_t *version );
261 
262 #ifdef __cplusplus
263 }
264 #endif
265 #endif // _AIRQUALITY4_H_
266  // End public_function group
269 
270 // ------------------------------------------------------------------------- END
airquality4_default_cfg
void airquality4_default_cfg(airquality4_t *ctx)
Click Default Configuration function.
air_quality4_get_baseline
void air_quality4_get_baseline(airquality4_t *ctx, uint8_t *read_air)
Get Baseline function.
airquality4_init
AIRQUALITY4_RETVAL airquality4_init(airquality4_t *ctx, airquality4_cfg_t *cfg)
Initialization function.
air_quality4_get_h2_and_ethon
void air_quality4_get_h2_and_ethon(airquality4_t *ctx, uint16_t *value)
Read H2 and EthOH function.
airquality4_t::slave_address
uint8_t slave_address
Definition: airquality4.h:86
air_quality4_measure_signal
void air_quality4_measure_signal(airquality4_t *ctx, uint8_t *read_air)
Signal measurment function.
air_quality4_dev_init
void air_quality4_dev_init(airquality4_t *ctx)
Initialization function.
airquality4_t
Click ctx object definition.
Definition: airquality4.h:78
air_quality4_get_co2_and_tvoc
void air_quality4_get_co2_and_tvoc(airquality4_t *ctx, uint16_t *value)
Read CO2 and TVOC function.
airquality4_cfg_t::sda
pin_name_t sda
Definition: airquality4.h:98
air_quality4_set_baseline
void air_quality4_set_baseline(airquality4_t *ctx)
Set Baseline function.
air_quality4_measure_quality
void air_quality4_measure_quality(airquality4_t *ctx, uint8_t *read_air)
Quality measurment function.
airquality4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: airquality4.h:102
air_quality4_get_id
void air_quality4_get_id(airquality4_t *ctx, uint8_t *data_buf)
Get ID function.
AIRQUALITY4_RETVAL
#define AIRQUALITY4_RETVAL
Definition: airquality4.h:61
airquality4_t::i2c
i2c_master_t i2c
Definition: airquality4.h:82
airquality4_cfg_setup
void airquality4_cfg_setup(airquality4_cfg_t *cfg)
Config Object Initialization function.
air_quality4_get_version
void air_quality4_get_version(airquality4_t *ctx, uint8_t *version)
Get version function.
airquality4_cfg_t
Click configuration structure definition.
Definition: airquality4.h:94
air_quality4_soft_reset
void air_quality4_soft_reset(airquality4_t *ctx)
Software reset function.
airquality4_cfg_t::scl
pin_name_t scl
Definition: airquality4.h:97
airquality4_cfg_t::i2c_address
uint8_t i2c_address
Definition: airquality4.h:103