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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define AIRQUALITY7_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
66 
72 #define AIRQUALITY7_RETVAL uint8_t
73 #define airquality7_err_t uint8_t
74 
75 #define AIRQUALITY7_OK 0x00
76 #define AIRQUALITY7_INIT_ERROR 0xFF
77 
83 #define AIRQUALITY7_CMD_SET_PPMCO2 0x08
84 #define AIRQUALITY7_CMD_GET_STATUS 0x0C
85 #define AIRQUALITY7_CMD_GET_REVISION 0x0D
86 #define AIRQUALITY7_CMD_GET_R0 0x10
87 
93 #define AIRQUALITY7_DEV_ADDR 0x70
94 
100 #define AIRQUALITY7_ERR_OK 0x00
101 #define AIRQUALITY7_ERR_CRC 0x01
102 
108 #define AIRQUALITY7_NULL 0x00
109 #define AIRQUALITY7_DUMMY 0x00
110  // End group macro
114 // --------------------------------------------------------------- PUBLIC TYPES
123 typedef struct
124 {
125  // Input pins
126 
127  digital_in_t int_pin;
128 
129  // Modules
130 
131  i2c_master_t i2c;
132 
133  // ctx variable
134 
135  uint8_t slave_address;
136 
137 } airquality7_t;
138 
142 typedef struct
143 {
144  // Communication gpio pins
145 
146  pin_name_t scl;
147  pin_name_t sda;
148 
149  // Additional gpio pins
150 
151  pin_name_t int_pin;
152 
153  // static variable
154 
155  uint32_t i2c_speed;
156  uint8_t i2c_address;
157 
159  // End types group
161 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
162 
168 #ifdef __cplusplus
169 extern "C"{
170 #endif
171 
181 
190 
199 void airquality7_generic_write ( airquality7_t *ctx, uint8_t *data_buf );
200 
210 void airquality7_generic_read ( airquality7_t *ctx, uint8_t *data_buf );
211 
222 void airquality7_set_ppmco2( airquality7_t *ctx, uint8_t *ppmco2_value );
223 
241  uint16_t *co2_ppm,
242  uint32_t *res_val_ohm,
243  uint8_t *err_byte );
244 
262  uint8_t *month,
263  uint8_t *day,
264  uint8_t *ascii_code );
265 
279 
280 #ifdef __cplusplus
281 }
282 #endif
283 #endif // _AIRQUALITY7_H_
284  // End public_function group
287 
288 // ------------------------------------------------------------------------- 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:131
airquality7_cfg_t::sda
pin_name_t sda
Definition: airquality7.h:147
AIRQUALITY7_RETVAL
#define AIRQUALITY7_RETVAL
Definition: airquality7.h:72
airquality7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: airquality7.h:155
airquality7_t
Click ctx object definition.
Definition: airquality7.h:124
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:73
airquality7_cfg_t::int_pin
pin_name_t int_pin
Definition: airquality7.h:151
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:127
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:146
airquality7_t::slave_address
uint8_t slave_address
Definition: airquality7.h:135
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:143
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:156