airquality9  2.0.0.0
airquality9.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 AIRQUALITY9_H
29 #define AIRQUALITY9_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 #include "drv_spi_master.h"
39 #include "spi_specifics.h"
40 
61 #define AIRQUALITY9_REG_PART_ID 0x00
62 #define AIRQUALITY9_REG_OPMODE 0x10
63 #define AIRQUALITY9_REG_CONFIG 0x11
64 #define AIRQUALITY9_REG_COMMAND 0x12
65 #define AIRQUALITY9_REG_TEMP_IN 0x13
66 #define AIRQUALITY9_REG_RH_IN 0x15
67 #define AIRQUALITY9_REG_DATA_STATUS 0x20
68 #define AIRQUALITY9_REG_DATA_AQI 0x21
69 #define AIRQUALITY9_REG_DATA_TVOC 0x22
70 #define AIRQUALITY9_REG_DATA_ECO2 0x24
71 #define AIRQUALITY9_REG_DATA_T 0x30
72 #define AIRQUALITY9_REG_DATA_RH 0x32
73 #define AIRQUALITY9_REG_DATA_MISR 0x38
74 #define AIRQUALITY9_REG_GPR_WRITE 0x40
75 #define AIRQUALITY9_REG_GPR_READ 0x48
76  // airquality9_reg
78 
93 #define AIRQUALITY9_OPMODE_DEEP_SLEEP 0x00
94 #define AIRQUALITY9_OPMODE_IDLE 0x01
95 #define AIRQUALITY9_OPMODE_STANDARD 0x02
96 #define AIRQUALITY9_OPMODE_RESET 0xF0
97 
102 #define AIRQUALITY_CONFIG_INTPOL_LOW 0x00
103 #define AIRQUALITY_CONFIG_INTPOL_HIGH 0x40
104 #define AIRQUALITY_CONFIG_INTCFG_OPEN_DRAIN 0x00
105 #define AIRQUALITY_CONFIG_INTCFG_PUSH_PULL 0x20
106 #define AIRQUALITY_CONFIG_INTGPR_BIT 0x08
107 #define AIRQUALITY_CONFIG_INTDAT_BIT 0x02
108 #define AIRQUALITY_CONFIG_INTEN_BIT 0x01
109 
114 #define AIRQUALITY_STATUS_OPMODE_RUNNING 0x80
115 #define AIRQUALITY_STATUS_ERROR_DETECTED 0x40
116 #define AIRQUALITY_STATUS_VALID_NORMAL_OP 0x00
117 #define AIRQUALITY_STATUS_VALID_WARM_UP 0x04
118 #define AIRQUALITY_STATUS_VALID_INIT_START_UP 0x08
119 #define AIRQUALITY_STATUS_VALID_INVALID 0x0C
120 #define AIRQUALITY_STATUS_VALID_FLAG_BITS 0x0C
121 #define AIRQUALITY_STATUS_NEW_DATA 0x02
122 #define AIRQUALITY_STATUS_NEW_GPR 0x01
123 
128 #define AIRQUALITY9_PART_ID_LSB 0x60
129 #define AIRQUALITY9_PART_ID_MSB 0x01
130 
135 #define AIRQUALITY9_AQI_UBA_EXELLENT 1
136 #define AIRQUALITY9_AQI_UBA_GOOD 2
137 #define AIRQUALITY9_AQI_UBA_MODERATE 3
138 #define AIRQUALITY9_AQI_UBA_POOR 4
139 #define AIRQUALITY9_AQI_UBA_UNHEALTHY 5
140 
146 #define AIRQUALITY9_DEVICE_ADDRESS_0 0x52
147 #define AIRQUALITY9_DEVICE_ADDRESS_1 0x53
148 
157 #define AIRQUALITY9_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
158 #define AIRQUALITY9_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
159  // airquality9_set
161 
176 #define AIRQUALITY9_MAP_MIKROBUS( cfg, mikrobus ) \
177  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
178  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
179  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
180  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
181  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
182  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
183  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
184  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
185  // airquality9_map // airquality9
188 
193 typedef enum
194 {
199 
204 typedef err_t ( *airquality9_master_io_t )( struct airquality9_s*, uint8_t, uint8_t*, uint8_t );
210 typedef struct airquality9_s
211 {
212  digital_out_t en;
214  digital_in_t int_pin;
216  i2c_master_t i2c;
217  spi_master_t spi;
219  uint8_t slave_address;
220  pin_name_t chip_select;
227 
232 typedef struct
233 {
234  pin_name_t scl;
235  pin_name_t sda;
236  pin_name_t miso;
237  pin_name_t mosi;
238  pin_name_t sck;
239  pin_name_t cs;
240  pin_name_t en;
241  pin_name_t int_pin;
243  uint32_t i2c_speed;
244  uint8_t i2c_address;
246  uint32_t spi_speed;
247  spi_master_mode_t spi_mode;
248  spi_master_chip_select_polarity_t cs_polarity;
253 
258 typedef enum
259 {
261  AIRQUALITY9_ERROR = -1
262 
264 
281 
297 
313 
328 
343 err_t airquality9_generic_write ( airquality9_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
344 
359 err_t airquality9_generic_read ( airquality9_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
360 
370 
380 
390 
402 
417 err_t airquality9_set_operating_mode ( airquality9_t *ctx, uint8_t opmode );
418 
430 err_t airquality9_set_interrupt_config ( airquality9_t *ctx, uint8_t int_cfg );
431 
443 err_t airquality9_read_status ( airquality9_t *ctx, uint8_t *status );
444 
456 err_t airquality9_read_aqi_uba ( airquality9_t *ctx, uint8_t *aqi_uba );
457 
470 err_t airquality9_read_tvoc ( airquality9_t *ctx, uint16_t *tvoc );
471 
483 err_t airquality9_read_eco2 ( airquality9_t *ctx, uint16_t *eco2 );
484 
485 #ifdef __cplusplus
486 }
487 #endif
488 #endif // AIRQUALITY9_H
489  // airquality9
491 
492 // ------------------------------------------------------------------------ END
airquality9_drv_t
airquality9_drv_t
Air Quality 9 Click driver selector.
Definition: airquality9.h:194
airquality9_set_interrupt_config
err_t airquality9_set_interrupt_config(airquality9_t *ctx, uint8_t int_cfg)
Air Quality 9 set interrupt config function.
airquality9_s::spi
spi_master_t spi
Definition: airquality9.h:217
airquality9_s::i2c
i2c_master_t i2c
Definition: airquality9.h:216
airquality9_cfg_t::scl
pin_name_t scl
Definition: airquality9.h:234
airquality9_cfg_setup
void airquality9_cfg_setup(airquality9_cfg_t *cfg)
Air Quality 9 configuration object setup function.
airquality9_master_io_t
err_t(* airquality9_master_io_t)(struct airquality9_s *, uint8_t, uint8_t *, uint8_t)
Air Quality 9 Click driver interface.
Definition: airquality9.h:204
AIRQUALITY9_ERROR
@ AIRQUALITY9_ERROR
Definition: airquality9.h:261
airquality9_s::en
digital_out_t en
Definition: airquality9.h:212
airquality9_s::write_f
airquality9_master_io_t write_f
Definition: airquality9.h:223
airquality9_default_cfg
err_t airquality9_default_cfg(airquality9_t *ctx)
Air Quality 9 default configuration function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
airquality9_return_value_t
airquality9_return_value_t
Air Quality 9 Click return value data.
Definition: airquality9.h:259
airquality9_get_int_pin
uint8_t airquality9_get_int_pin(airquality9_t *ctx)
Air Quality 9 get int pin function.
airquality9_s::int_pin
digital_in_t int_pin
Definition: airquality9.h:214
airquality9_cfg_t::sck
pin_name_t sck
Definition: airquality9.h:238
AIRQUALITY9_OK
@ AIRQUALITY9_OK
Definition: airquality9.h:260
airquality9_read_eco2
err_t airquality9_read_eco2(airquality9_t *ctx, uint16_t *eco2)
Air Quality 9 read eco2 function.
airquality9_cfg_t::mosi
pin_name_t mosi
Definition: airquality9.h:237
airquality9_cfg_t::en
pin_name_t en
Definition: airquality9.h:240
airquality9_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: airquality9.h:247
airquality9_read_status
err_t airquality9_read_status(airquality9_t *ctx, uint8_t *status)
Air Quality 9 read status function.
airquality9_s::slave_address
uint8_t slave_address
Definition: airquality9.h:219
airquality9_cfg_t::miso
pin_name_t miso
Definition: airquality9.h:236
airquality9_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: airquality9.h:243
airquality9_set_operating_mode
err_t airquality9_set_operating_mode(airquality9_t *ctx, uint8_t opmode)
Air Quality 9 set operating mode function.
airquality9_cfg_t::i2c_address
uint8_t i2c_address
Definition: airquality9.h:244
airquality9_cfg_t::drv_sel
airquality9_drv_t drv_sel
Definition: airquality9.h:250
airquality9_s::read_f
airquality9_master_io_t read_f
Definition: airquality9.h:224
airquality9_s::drv_sel
airquality9_drv_t drv_sel
Definition: airquality9.h:221
airquality9_read_tvoc
err_t airquality9_read_tvoc(airquality9_t *ctx, uint16_t *tvoc)
Air Quality 9 read tvoc function.
airquality9_cfg_t::spi_speed
uint32_t spi_speed
Definition: airquality9.h:246
airquality9_generic_read
err_t airquality9_generic_read(airquality9_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Air Quality 9 data reading function.
airquality9_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: airquality9.h:248
airquality9_cfg_t::int_pin
pin_name_t int_pin
Definition: airquality9.h:241
airquality9_generic_write
err_t airquality9_generic_write(airquality9_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Air Quality 9 data writing function.
airquality9_init
err_t airquality9_init(airquality9_t *ctx, airquality9_cfg_t *cfg)
Air Quality 9 initialization function.
airquality9_cfg_t::cs
pin_name_t cs
Definition: airquality9.h:239
airquality9_cfg_t
Air Quality 9 Click configuration object.
Definition: airquality9.h:233
airquality9_s::chip_select
pin_name_t chip_select
Definition: airquality9.h:220
airquality9_read_aqi_uba
err_t airquality9_read_aqi_uba(airquality9_t *ctx, uint8_t *aqi_uba)
Air Quality 9 read aqi uba function.
airquality9_cfg_t::sda
pin_name_t sda
Definition: airquality9.h:235
airquality9_check_communication
err_t airquality9_check_communication(airquality9_t *ctx)
Air Quality 9 check communication function.
airquality9_s
Air Quality 9 Click context object.
Definition: airquality9.h:211
AIRQUALITY9_DRV_SEL_SPI
@ AIRQUALITY9_DRV_SEL_SPI
Definition: airquality9.h:195
airquality9_disable_device
void airquality9_disable_device(airquality9_t *ctx)
Air Quality 9 disable device function.
airquality9_enable_device
void airquality9_enable_device(airquality9_t *ctx)
Air Quality 9 enable device function.
airquality9_drv_interface_selection
void airquality9_drv_interface_selection(airquality9_cfg_t *cfg, airquality9_drv_t drv_sel)
Air Quality 9 driver interface setup function.
airquality9_t
struct airquality9_s airquality9_t
Air Quality 9 Click context object.
AIRQUALITY9_DRV_SEL_I2C
@ AIRQUALITY9_DRV_SEL_I2C
Definition: airquality9.h:196