airquality5  2.0.0.0
airquality5.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 AIRQUALITY5_H
36 #define AIRQUALITY5_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 AIRQUALITY5_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
56 
62 #define AIRQUALITY5_RETVAL uint8_t
63 
64 #define AIRQUALITY5_OK 0x00
65 #define AIRQUALITY5_INIT_ERROR 0xFF
66 
72 #define AIRQ5_DATA_CHANNEL_NO2 0x4000
73 #define AIRQ5_DATA_CHANNEL_NH3 0x5000
74 #define AIRQ5_DATA_CHANNEL_CO 0x6000
75 
81 #define AIRQ5_REG_POINTER_CONVERT 0x00
82 #define AIRQ5_REG_POINTER_CONFIG 0x01
83 #define AIRQ5_REG_POINTER_LOW_THRESH 0x02
84 #define AIRQ5_REG_POINTER_HIGH_THRESH 0x03
85 
91 #define AIRQ5_CONFIG_OS_SINGLE 0x8000
92 #define AIRQ5_CONFIG_OS_BUSY 0x0000
93 #define AIRQ5_CONFIG_OS_NOTBUSY 0x8000
94 
100 #define AIRQ5_CONFIG_PGA_6_144V 0x0000
101 #define AIRQ5_CONFIG_PGA_4_096V 0x0200
102 #define AIRQ5_CONFIG_PGA_2_048V 0x0400
103 #define AIRQ5_CONFIG_PGA_1_024V 0x0600
104 #define AIRQ5_CONFIG_PGA_0_512V 0x0800
105 #define AIRQ5_CONFIG_PGA_0_256V 0x0A00
106 
112 #define AIRQ5_CONFIG_CONTINUOUS_MODE 0x0000
113 #define AIRQ5_CONFIG_SINGLE_MODE 0x0100
114 
120 #define AIRQ5_CONFIG_DATA_RATE_128SPS 0x0000
121 #define AIRQ5_CONFIG_DATA_RATE_250SPS 0x0020
122 #define AIRQ5_CONFIG_DATA_RATE_490SPS 0x0040
123 #define AIRQ5_CONFIG_DATA_RATE_920SPS 0x0060
124 #define AIRQ5_CONFIG_DATA_RATE_1600SPS 0x0080
125 #define AIRQ5_CONFIG_DATA_RATE_2400SPS 0x00A0
126 #define AIRQ5_CONFIG_DATA_RATE_3300SPS 0x00C0
127 
133 #define AIRQ5_CONFIG_COMP_MODE_TRADITIONAL 0x0000
134 #define AIRQ5_CONFIG_COMP_MODE_WINDOW 0x0010
135 
141 #define AIRQ5_CONFIG_COMP_POL_ACTIVE_LOW 0x0000
142 #define AIRQ5_CONFIG_COMP_POL_ACTIVE_HIGH 0x0008
143 
149 #define AIRQ5_CONFIG_COMP_LAT_NOT_LATCH 0x0000
150 #define AIRQ5_CONFIG_COMP_LAT_LATCH 0x0004
151 
157 #define AIRQ5_CONFIG_COMP_QUE_1CONV 0x0000
158 #define AIRQ5_CONFIG_COMP_QUE_2CONV 0x0001
159 #define AIRQ5_CONFIG_COMP_QUE_4CONV 0x0002
160 #define AIRQ5_CONFIG_COMP_QUE_0CONV 0x0003
161  // End group macro
164 // --------------------------------------------------------------- PUBLIC TYPES
173 typedef struct
174 {
175 
176  // Input pins
177 
178  digital_in_t rdy;
179 
180  // Modules
181 
182  i2c_master_t i2c;
183 
184  // ctx variable
185 
186  uint8_t slave_address;
187  uint16_t data_config;
188 
189 } airquality5_t;
190 
194 typedef struct
195 {
196  // Communication gpio pins
197 
198  pin_name_t scl;
199  pin_name_t sda;
200 
201  // Additional gpio pins
202 
203  pin_name_t rdy;
204 
205  // static variable
206 
207  uint32_t i2c_speed;
208  uint8_t i2c_address;
209 
211  // End types group
213 
214 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
215 
221 #ifdef __cplusplus
222 extern "C"{
223 #endif
224 
234 
244 
253 
264 void airquality5_generic_write ( airquality5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
265 
277 void airquality5_generic_read ( airquality5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
278 
290 void airq5_write_data ( airquality5_t *ctx, uint8_t reg, uint16_t data_b );
291 
301 uint16_t airq5_read_data ( airquality5_t *ctx, uint8_t reg );
302 
312 void airq5_set_configuration ( airquality5_t *ctx, uint16_t config );
313 
323 uint16_t airq5_read_sensor_data( airquality5_t *ctx, uint16_t channel_data );
324 
333 uint8_t airq5_get_interrupt ( airquality5_t *ctx );
334 #ifdef __cplusplus
335 }
336 #endif
337 #endif // _AIRQUALITY5_H_
338  // End public_function group
341 
342 // ------------------------------------------------------------------------- END
void airquality5_generic_write(airquality5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
void airq5_write_data(airquality5_t *ctx, uint8_t reg, uint16_t data_b)
Functions for write data in register.
pin_name_t scl
Definition: airquality5.h:198
#define AIRQUALITY5_RETVAL
Definition: airquality5.h:62
uint8_t slave_address
Definition: airquality5.h:186
Click ctx object definition.
Definition: airquality5.h:173
i2c_master_t i2c
Definition: airquality5.h:182
pin_name_t sda
Definition: airquality5.h:199
void airq5_set_configuration(airquality5_t *ctx, uint16_t config)
Functions for configuration.
void airquality5_generic_read(airquality5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
Click configuration structure definition.
Definition: airquality5.h:194
pin_name_t rdy
Definition: airquality5.h:203
digital_in_t rdy
Definition: airquality5.h:178
uint16_t airq5_read_data(airquality5_t *ctx, uint8_t reg)
Functions for read data from register.
uint8_t i2c_address
Definition: airquality5.h:208
void airquality5_cfg_setup(airquality5_cfg_t *cfg)
Config Object Initialization function.
uint16_t airq5_read_sensor_data(airquality5_t *ctx, uint16_t channel_data)
Functions for read sensor data.
uint8_t airq5_get_interrupt(airquality5_t *ctx)
Functions for reads interrupt pin.
uint16_t data_config
Definition: airquality5.h:187
void airquality5_default_cfg(airquality5_t *ctx)
Click Default Configuration function.
uint32_t i2c_speed
Definition: airquality5.h:207
AIRQUALITY5_RETVAL airquality5_init(airquality5_t *ctx, airquality5_cfg_t *cfg)
Initialization function.