airquality8 2.0.0.0
airquality8.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 AIRQUALITY8_H
29#define AIRQUALITY8_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
48#define AIRQUALITY8_REG_PID 0x00
49#define AIRQUALITY8_REG_CONF 0x20
50#define AIRQUALITY8_REG_PROD_DATA 0x26
51#define AIRQUALITY8_REG_CMD 0x93
52#define AIRQUALITY8_REG_STATUS 0x94
53#define AIRQUALITY8_REG_TRACKING 0x3A
54
55#define AIRQUALITY8_REG_CFG_H 0x40
56#define AIRQUALITY8_REG_CFG_D 0x50
57#define AIRQUALITY8_REG_CFG_M 0x60
58#define AIRQUALITY8_REG_CFG_S 0x68
59#define AIRQUALITY8_REG_CFG_R 0x97
60 // airquality8_reg
62
77#define AIRQUALITY8_PRODUCT_ID 0x6320
78
83#define AIRQUALITY8_GAS_DETECTION_STRATEGY_AUTO 0
84#define AIRQUALITY8_GAS_DETECTION_STRATEGY_FORCE_O3 1
85#define AIRQUALITY8_GAS_DETECTION_STRATEGY_FORCE_NO2 2
86
91#define AIRQUALITY8_RCDA_STRATEGY_FIX 0
92#define AIRQUALITY8_RCDA_STRATEGY_SET 1
93#define AIRQUALITY8_RCDA_STRATEGY_ADJ 2
94
99#define AIRQUALITY8_STATUS_SEQUENCER_RUNNING_MASK 0x80
100#define AIRQUALITY8_STATUS_SLEEP_TIMER_ENABLED_MASK 0x40
101#define AIRQUALITY8_STATUS_ALARM_MASK 0x20
102#define AIRQUALITY8_STATUS_LAST_SEQ_STEP_MASK 0x1F
103#define AIRQUALITY8_STATUS_POR_EVENT_MASK 0x80
104#define AIRQUALITY8_STATUS_ACCESS_CONFLICT_MASK 0x40
105
111#define AIRQUALITY8_SET_DEV_ADDR 0x33
112 // airquality8_set
114
129#define AIRQUALITY8_MAP_MIKROBUS( cfg, mikrobus ) \
130 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
131 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
132 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
133 // airquality8_map // airquality8
136
141typedef struct
142{
143 // Output pins
144 digital_out_t rst;
146 // Input pins
147 digital_in_t int_pin;
149 // Modules
150 i2c_master_t i2c;
152 // I2C slave address
156
161typedef struct
162{
163 pin_name_t scl;
164 pin_name_t sda;
166 pin_name_t rst;
167 pin_name_t int_pin;
169 uint32_t i2c_speed;
170 uint8_t i2c_address;
173
178typedef enum
179{
190
192
209
225
240
256err_t airquality8_generic_write ( airquality8_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
257
273err_t airquality8_generic_read ( airquality8_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
274
287
302err_t airquality8_get_status ( airquality8_t *ctx, uint8_t *status );
303
328err_t airquality8_get_sensor_info ( airquality8_t *ctx, uint8_t *cfg_data, uint8_t *prod_data, uint16_t *pid );
329
353err_t airquality8_init_sensor ( airquality8_t *ctx, uint16_t *mox_lr, uint16_t *mox_er );
354
377
392
417err_t airquality8_read_rmox ( airquality8_t *ctx, float *rmox, uint16_t mox_lr, uint16_t mox_er );
418
437float airquality8_calc_oaq ( float *rmox, uint8_t rcda_strategy, uint8_t gas_detection_strategy );
438
452
453#ifdef __cplusplus
454}
455#endif
456#endif // AIRQUALITY8_H
457 // airquality8
459
460// ------------------------------------------------------------------------ END
airquality8_return_value_t
Air Quality 8 Click return value data.
Definition: airquality8.h:179
@ AIRQUALITY8_ERROR_GAS_TIMEOUT
Definition: airquality8.h:183
@ AIRQUALITY8_ERROR
Definition: airquality8.h:181
@ AIRQUALITY8_ERROR_POR_EVENT
Definition: airquality8.h:189
@ AIRQUALITY8_ERROR_SENSOR_UNSUPPORTED
Definition: airquality8.h:185
@ AIRQUALITY8_ERROR_INIT_OUT_OF_RANGE
Definition: airquality8.h:182
@ AIRQUALITY8_ERROR_CONFIG_MISSING
Definition: airquality8.h:186
@ AIRQUALITY8_ERROR_ACCESS_CONFLICT
Definition: airquality8.h:188
@ AIRQUALITY8_ERROR_I2C
Definition: airquality8.h:184
@ AIRQUALITY8_OK
Definition: airquality8.h:180
@ AIRQUALITY8_ERROR_SENSOR
Definition: airquality8.h:187
float airquality8_calc_oaq(float *rmox, uint8_t rcda_strategy, uint8_t gas_detection_strategy)
Air Quality 8 calculates AQI function.
err_t airquality8_read_rmox(airquality8_t *ctx, float *rmox, uint16_t mox_lr, uint16_t mox_er)
Air Quality 8 calculate rmox resistance function.
err_t airquality8_default_cfg(airquality8_t *ctx)
Air Quality 8 default configuration function.
err_t airquality8_generic_write(airquality8_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Air Quality 8 I2C writing function.
err_t airquality8_start_measurement(airquality8_t *ctx)
Air Quality 8 start measurement function.
err_t airquality8_get_sensor_info(airquality8_t *ctx, uint8_t *cfg_data, uint8_t *prod_data, uint16_t *pid)
Air Quality 8 get sensor info function.
err_t airquality8_init_measurement(airquality8_t *ctx)
Air Quality 8 init measurement function.
void airquality8_hw_reset(airquality8_t *ctx)
Air Quality 8 reset function.
err_t airquality8_get_status(airquality8_t *ctx, uint8_t *status)
Air Quality 8 get status function.
err_t airquality8_init_sensor(airquality8_t *ctx, uint16_t *mox_lr, uint16_t *mox_er)
Air Quality 8 init sensor function.
void airquality8_cfg_setup(airquality8_cfg_t *cfg)
Air Quality 8 configuration object setup function.
err_t airquality8_generic_read(airquality8_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Air Quality 8 I2C reading function.
err_t airquality8_init(airquality8_t *ctx, airquality8_cfg_t *cfg)
Air Quality 8 initialization function.
uint8_t raq_check_interrupt(airquality8_t *ctx)
Air Quality 8 check interrupt function.
Air Quality 8 Click configuration object.
Definition: airquality8.h:162
uint32_t i2c_speed
Definition: airquality8.h:169
pin_name_t scl
Definition: airquality8.h:163
pin_name_t int_pin
Definition: airquality8.h:167
pin_name_t sda
Definition: airquality8.h:164
pin_name_t rst
Definition: airquality8.h:166
uint8_t i2c_address
Definition: airquality8.h:170
Air Quality 8 Click context object.
Definition: airquality8.h:142
digital_in_t int_pin
Definition: airquality8.h:147
i2c_master_t i2c
Definition: airquality8.h:150
digital_out_t rst
Definition: airquality8.h:144
uint8_t slave_address
Definition: airquality8.h:153