airquality12 2.1.0.0
Loading...
Searching...
No Matches
airquality12.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 AIRQUALITY12_H
29#define AIRQUALITY12_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
39#ifdef PREINIT_SUPPORTED
40#include "preinit.h"
41#endif
42
43#ifdef MikroCCoreVersion
44 #if MikroCCoreVersion >= 1
45 #include "delays.h"
46 #endif
47#endif
48
49#include "drv_digital_out.h"
50#include "drv_digital_in.h"
51#include "drv_i2c_master.h"
52#include "drv_uart.h"
53
74#define AIRQUALITY12_CMD_GET_PRODUCT_ID 0x00
75#define AIRQUALITY12_CMD_GET_TRACKING_NUMBER 0x01
76#define AIRQUALITY12_CMD_GET_OPERATION_MODE 0x10
77#define AIRQUALITY12_CMD_SET_OPERATION_MODE 0x11
78#define AIRQUALITY12_CMD_SET_HUMIDITY 0x12
79#define AIRQUALITY12_CMD_GET_MEASUREMENT 0x18
80#define AIRQUALITY12_CMD_CONFIG_GPIO 0x20
81#define AIRQUALITY12_CMD_GET_GPIO 0x21
82#define AIRQUALITY12_CMD_SET_GPIO 0x22
83#define AIRQUALITY12_CMD_CLEAR_GPIO 0x23
84#define AIRQUALITY12_CMD_READ_FLASH_SHADOW 0x40
85#define AIRQUALITY12_CMD_WRITE_FLASH_SHADOW 0x41
86#define AIRQUALITY12_CMD_WRITE_FLASH 0x42
87#define AIRQUALITY12_CMD_RESET 0x8F
88
89 // airquality12_reg
90
105#define AIRQUALITY12_OP_MODE_SUSPEND 0x00
106#define AIRQUALITY12_OP_MODE_IAQ_2ND_GEN 0x01
107#define AIRQUALITY12_OP_MODE_IAQ_2ND_GEN_ULP 0x02
108#define AIRQUALITY12_OP_MODE_PBAQ 0x05
109#define AIRQUALITY12_OP_MODE_SENSOR_CLEANING 0x80
110
115#define AIRQUALITY12_HUMIDITY_MIN 0
116#define AIRQUALITY12_HUMIDITY_DEFAULT 50
117#define AIRQUALITY12_HUMIDITY_MAX 100
118
123#define AIRQUALITY12_PRODUCT_ID 0x2310
124
129#define AIRQUALITY12_STATUS_INVALID_CMD 0x80
130#define AIRQUALITY12_STATUS_WRONG_CHECKSUM 0x40
131#define AIRQUALITY12_STATUS_I2C_NACK 0x20
132#define AIRQUALITY12_STATUS_DATA_NOT_READY 0x10
133#define AIRQUALITY12_STATUS_NO_MORE_CLEANING 0x08
134#define AIRQUALITY12_STATUS_OK 0x00
135
141#define AIRQUALITY12_DEVICE_ADDRESS 0x38
142
148#define AIRQUALITY12_TX_DRV_BUFFER_SIZE 100
149#define AIRQUALITY12_RX_DRV_BUFFER_SIZE 300
150
151 // airquality12_set
152
167#define AIRQUALITY12_MAP_MIKROBUS( cfg, mikrobus ) \
168 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
169 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
170 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
171 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
172 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
173 cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
174 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
175
176 // airquality12_map
177 // airquality12
178
189
211
216typedef struct
217{
218 pin_name_t scl;
219 pin_name_t sda;
220 pin_name_t rx_pin;
221 pin_name_t tx_pin;
222 pin_name_t rst;
223 pin_name_t gp1;
224 pin_name_t int_pin;
226 uint32_t i2c_speed;
227 uint8_t i2c_address;
229 uint32_t baud_rate;
231 uart_data_bits_t data_bit;
232 uart_parity_t parity_bit;
233 uart_stop_bits_t stop_bit;
238
243typedef struct
244{
245 uint8_t req_buf[ 2 ];
246 uint8_t req_len;
247 uint8_t resp_buf[ 9 ];
248 uint8_t resp_len;
249 uint8_t status;
252
257typedef struct
258{
259 uint16_t product_id;
260 uint8_t fw_ver_major;
261 uint8_t fw_ver_minor;
262 uint8_t fw_ver_patch;
263 uint8_t tracking_num[ 6 ];
266
271typedef struct
272{
273 uint8_t sample_num;
274 float iaq;
275 float tvoc;
276 float etoh;
277 uint16_t eco2;
278 uint16_t rel_iaq;
281
292
309
325
340
354
368err_t airquality12_send_cmd ( airquality12_t *ctx, uint8_t cmd, airquality12_param_t *params );
369
379void airquality12_set_rst_pin ( airquality12_t *ctx, uint8_t state );
380
390void airquality12_set_gp1_pin ( airquality12_t *ctx, uint8_t state );
391
401
411
423
437
449err_t airquality12_get_op_mode ( airquality12_t *ctx, uint8_t *op_mode );
450
462err_t airquality12_set_op_mode ( airquality12_t *ctx, uint8_t op_mode );
463
476err_t airquality12_set_humidity ( airquality12_t *ctx, float humidity );
477
491
503err_t airquality12_config_gpio ( airquality12_t *ctx, uint8_t gpio_mask );
504
516err_t airquality12_get_gpio ( airquality12_t *ctx, uint8_t *gpio_mask );
517
529err_t airquality12_set_gpio ( airquality12_t *ctx, uint8_t gpio_mask );
530
542err_t airquality12_clear_gpio ( airquality12_t *ctx, uint8_t gpio_mask );
543
556
557#ifdef __cplusplus
558}
559#endif
560#endif // AIRQUALITY12_H
561
562 // airquality12
563
564// ------------------------------------------------------------------------ END
airquality12_return_value_t
Air Quality 12 Click return value data.
Definition airquality12.h:287
@ AIRQUALITY12_ERROR
Definition airquality12.h:289
@ AIRQUALITY12_OK
Definition airquality12.h:288
struct airquality12_s airquality12_t
Air Quality 12 Click context object.
airquality12_drv_t
Air Quality 12 Click driver selector.
Definition airquality12.h:184
@ AIRQUALITY12_DRV_SEL_I2C
Definition airquality12.h:186
@ AIRQUALITY12_DRV_SEL_UART
Definition airquality12.h:185
#define AIRQUALITY12_TX_DRV_BUFFER_SIZE
Air Quality 12 driver buffer size.
Definition airquality12.h:148
#define AIRQUALITY12_RX_DRV_BUFFER_SIZE
Definition airquality12.h:149
err_t airquality12_perform_cleaning(airquality12_t *ctx)
Air Quality 12 perform cleaning function.
err_t airquality12_set_humidity(airquality12_t *ctx, float humidity)
Air Quality 12 set humidity function.
err_t airquality12_set_gpio(airquality12_t *ctx, uint8_t gpio_mask)
Air Quality 12 set gpio function.
err_t airquality12_clear_gpio(airquality12_t *ctx, uint8_t gpio_mask)
Air Quality 12 clear gpio function.
err_t airquality12_init(airquality12_t *ctx, airquality12_cfg_t *cfg)
Air Quality 12 initialization function.
void airquality12_drv_interface_sel(airquality12_cfg_t *cfg, airquality12_drv_t drv_sel)
Air Quality 12 driver interface setup function.
void airquality12_set_gp1_pin(airquality12_t *ctx, uint8_t state)
Air Quality 12 set gp1 pin function.
err_t airquality12_set_op_mode(airquality12_t *ctx, uint8_t op_mode)
Air Quality 12 set op mode function.
void airquality12_cfg_setup(airquality12_cfg_t *cfg)
Air Quality 12 configuration object setup function.
err_t airquality12_send_cmd(airquality12_t *ctx, uint8_t cmd, airquality12_param_t *params)
Air Quality 12 send cmd function.
err_t airquality12_config_gpio(airquality12_t *ctx, uint8_t gpio_mask)
Air Quality 12 config gpio function.
void airquality12_set_rst_pin(airquality12_t *ctx, uint8_t state)
Air Quality 12 set rst pin function.
void airquality12_reset_device(airquality12_t *ctx)
Air Quality 12 reset device function.
err_t airquality12_check_comm(airquality12_t *ctx)
Air Quality 12 check comm function.
err_t airquality12_get_gpio(airquality12_t *ctx, uint8_t *gpio_mask)
Air Quality 12 get gpio function.
err_t airquality12_get_measurement(airquality12_t *ctx, airquality12_results_t *results)
Air Quality 12 get measurement function.
uint8_t airquality12_get_int_pin(airquality12_t *ctx)
Air Quality 12 get int pin function.
err_t airquality12_default_cfg(airquality12_t *ctx)
Air Quality 12 default configuration function.
err_t airquality12_get_sensor_info(airquality12_t *ctx, airquality12_info_t *info)
Air Quality 12 get sensor info function.
err_t airquality12_get_op_mode(airquality12_t *ctx, uint8_t *op_mode)
Air Quality 12 get op mode function.
Air Quality 12 Click configuration object.
Definition airquality12.h:217
uint32_t baud_rate
Definition airquality12.h:229
uint32_t i2c_speed
Definition airquality12.h:226
bool uart_blocking
Definition airquality12.h:230
uart_data_bits_t data_bit
Definition airquality12.h:231
pin_name_t tx_pin
Definition airquality12.h:221
airquality12_drv_t drv_sel
Definition airquality12.h:235
pin_name_t rx_pin
Definition airquality12.h:220
uart_stop_bits_t stop_bit
Definition airquality12.h:233
pin_name_t scl
Definition airquality12.h:218
pin_name_t int_pin
Definition airquality12.h:224
pin_name_t gp1
Definition airquality12.h:223
uart_parity_t parity_bit
Definition airquality12.h:232
pin_name_t sda
Definition airquality12.h:219
pin_name_t rst
Definition airquality12.h:222
uint8_t i2c_address
Definition airquality12.h:227
Air Quality 12 Click device info object.
Definition airquality12.h:258
uint16_t product_id
Definition airquality12.h:259
uint8_t fw_ver_minor
Definition airquality12.h:261
uint8_t fw_ver_major
Definition airquality12.h:260
uint8_t fw_ver_patch
Definition airquality12.h:262
Air Quality 12 Click request and response parameters object.
Definition airquality12.h:244
uint8_t resp_len
Definition airquality12.h:248
uint8_t req_len
Definition airquality12.h:246
uint8_t status
Definition airquality12.h:249
Air Quality 12 Click measurement results object.
Definition airquality12.h:272
uint16_t rel_iaq
Definition airquality12.h:278
float etoh
Definition airquality12.h:276
uint16_t eco2
Definition airquality12.h:277
float tvoc
Definition airquality12.h:275
float iaq
Definition airquality12.h:274
uint8_t sample_num
Definition airquality12.h:273
Air Quality 12 Click context object.
Definition airquality12.h:195
uint8_t uart_tx_buffer[AIRQUALITY12_TX_DRV_BUFFER_SIZE]
Definition airquality12.h:208
uart_t uart
Definition airquality12.h:202
digital_in_t int_pin
Definition airquality12.h:199
i2c_master_t i2c
Definition airquality12.h:201
digital_out_t gp1
Definition airquality12.h:197
airquality12_drv_t drv_sel
Definition airquality12.h:205
digital_out_t rst
Definition airquality12.h:196
uint8_t slave_address
Definition airquality12.h:204
uint8_t uart_rx_buffer[AIRQUALITY12_RX_DRV_BUFFER_SIZE]
Definition airquality12.h:207