airquality7  2.0.0.0
airquality7.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 AIRQUALITY7_H
36 #define AIRQUALITY7_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 AIRQUALITY7_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
56 
62 #define AIRQUALITY7_RETVAL uint8_t
63 #define airquality7_err_t uint8_t
64 
65 #define AIRQUALITY7_OK 0x00
66 #define AIRQUALITY7_INIT_ERROR 0xFF
67 
73 #define AIRQUALITY7_CMD_SET_PPMCO2 0x08
74 #define AIRQUALITY7_CMD_GET_STATUS 0x0C
75 #define AIRQUALITY7_CMD_GET_REVISION 0x0D
76 #define AIRQUALITY7_CMD_GET_R0 0x10
77 
83 #define AIRQUALITY7_DEV_ADDR 0x70
84 
90 #define AIRQUALITY7_ERR_OK 0x00
91 #define AIRQUALITY7_ERR_CRC 0x01
92 
98 #define AIRQUALITY7_NULL 0x00
99 #define AIRQUALITY7_DUMMY 0x00
100  // End group macro
104 // --------------------------------------------------------------- PUBLIC TYPES
113 typedef struct
114 {
115  // Input pins
116 
117  digital_in_t int_pin;
118 
119  // Modules
120 
121  i2c_master_t i2c;
122 
123  // ctx variable
124 
125  uint8_t slave_address;
126 
127 } airquality7_t;
128 
132 typedef struct
133 {
134  // Communication gpio pins
135 
136  pin_name_t scl;
137  pin_name_t sda;
138 
139  // Additional gpio pins
140 
141  pin_name_t int_pin;
142 
143  // static variable
144 
145  uint32_t i2c_speed;
146  uint8_t i2c_address;
147 
149  // End types group
151 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
152 
158 #ifdef __cplusplus
159 extern "C"{
160 #endif
161 
171 
180 
189 void airquality7_generic_write ( airquality7_t *ctx, uint8_t *data_buf );
190 
200 void airquality7_generic_read ( airquality7_t *ctx, uint8_t *data_buf );
201 
212 void airquality7_set_ppmco2( airquality7_t *ctx, uint8_t *ppmco2_value );
213 
231  uint16_t *co2_ppm,
232  uint32_t *res_val_ohm,
233  uint8_t *err_byte );
234 
252  uint8_t *month,
253  uint8_t *day,
254  uint8_t *ascii_code );
255 
269 
270 #ifdef __cplusplus
271 }
272 #endif
273 #endif // _AIRQUALITY7_H_
274  // End public_function group
277 
278 // ------------------------------------------------------------------------- END
airquality7_set_ppmco2
void airquality7_set_ppmco2(airquality7_t *ctx, uint8_t *ppmco2_value)
Set CO2 [ppm] function.
airquality7_t::i2c
i2c_master_t i2c
Definition: airquality7.h:121
airquality7_cfg_t::sda
pin_name_t sda
Definition: airquality7.h:137
AIRQUALITY7_RETVAL
#define AIRQUALITY7_RETVAL
Definition: airquality7.h:62
airquality7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: airquality7.h:145
airquality7_t
Click ctx object definition.
Definition: airquality7.h:114
airquality7_get_revision
airquality7_err_t airquality7_get_revision(airquality7_t *ctx, uint8_t *year, uint8_t *month, uint8_t *day, uint8_t *ascii_code)
Get Revision function.
airquality7_err_t
#define airquality7_err_t
Definition: airquality7.h:63
airquality7_cfg_t::int_pin
pin_name_t int_pin
Definition: airquality7.h:141
airquality7_generic_write
void airquality7_generic_write(airquality7_t *ctx, uint8_t *data_buf)
Generic write function.
airquality7_t::int_pin
digital_in_t int_pin
Definition: airquality7.h:117
airquality7_get_r0_calib
airquality7_err_t airquality7_get_r0_calib(airquality7_t *ctx, uint16_t *r0_kohm)
Get R0 Calibration function.
airquality7_get_status
airquality7_err_t airquality7_get_status(airquality7_t *ctx, uint16_t *tvoc_ppb, uint16_t *co2_ppm, uint32_t *res_val_ohm, uint8_t *err_byte)
Get Status function.
airquality7_cfg_t::scl
pin_name_t scl
Definition: airquality7.h:136
airquality7_t::slave_address
uint8_t slave_address
Definition: airquality7.h:125
airquality7_generic_read
void airquality7_generic_read(airquality7_t *ctx, uint8_t *data_buf)
Generic read function.
airquality7_cfg_setup
void airquality7_cfg_setup(airquality7_cfg_t *cfg)
Config Object Initialization function.
airquality7_cfg_t
Click configuration structure definition.
Definition: airquality7.h:133
airquality7_init
AIRQUALITY7_RETVAL airquality7_init(airquality7_t *ctx, airquality7_cfg_t *cfg)
Initialization function.
airquality7_cfg_t::i2c_address
uint8_t i2c_address
Definition: airquality7.h:146