airquality3  2.0.0.0
airquality3.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 AIRQUALITY3_H
36 #define AIRQUALITY3_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 AIRQUALITY3_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
56  cfg.wke = MIKROBUS( mikrobus, MIKROBUS_CS ); \
57  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
58 
64 #define AIRQUALITY3_RETVAL uint8_t
65 
66 #define AIRQUALITY3_OK 0x00
67 #define AIRQUALITY3_INIT_ERROR 0xFF
68 
74 #define AIRQUALITY3_REG_ID 0x20
75 #define AIRQUALITY3_REG_ERROR_ID 0xE0
76 #define AIRQUALITY3_REG_STATUS 0x00
77 #define AIRQUALITY3_REG_HW_VERSION 0x21
78 #define AIRQUALITY3_REG_FW_BOOT_VERSION 0x23
79 #define AIRQUALITY3_REG_FW_APP_VERSION 0x24
80 #define AIRQUALITY3_REG_SW_RESET 0xFF
81 #define AIRQUALITY3_REG_ALG_DATA 0x02
82 #define AIRQUALITY3_REG_RAW_DATA 0x03
83 #define AIRQUALITY3_REG_ENV_DATA 0x05
84 #define AIRQUALITY3_REG_NTC 0x06
85 #define AIRQUALITY3_REG_MEAS_MODE 0x01
86 #define AIRQUALITY3_REG_BASELINE 0x11
87 
93 #define AIRQUALITY3_DRIVE_MODE_0 ( 0x00 << 4 )
94 #define AIRQUALITY3_DRIVE_MODE_1 ( 0x01 << 4 )
95 #define AIRQUALITY3_DRIVE_MODE_2 ( 0x02 << 4 )
96 #define AIRQUALITY3_DRIVE_MODE_3 ( 0x03 << 4 )
97 #define AIRQUALITY3_DRIVE_MODE_4 ( 0x04 << 4 )
98 #define AIRQUALITY3_INT_DATARDY_0 ( 0x00 << 3 )
99 #define AIRQUALITY3_INT_DATARDY_1 ( 0x01 << 3 )
100 #define AIRQUALITY3_INT_THRESH_0 ( 0x00 << 2 )
101 #define AIRQUALITY3_INT_THRESH_1 ( 0x01 << 2 )
102 
108 #define AIRQUALITY3_APP_START 0xF4
109 #define AIRQUALITY3_APP_VERIFY 0xF3
110 #define AIRQUALITY3_APP_DATA 0xF2
111 #define AIRQUALITY3_APP_ERASE 0xF1
112 
118 #define AIRQUALITY3_DEVICE_SLAVE_ADDRESS 0x5A
119 
125 #define AIRQUALITY3_POWER_STATE_ON 0
126 #define AIRQUALITY3_POWER_STATE_OFF 1
127  // End group macro
130 // --------------------------------------------------------------- PUBLIC TYPES
139 typedef struct
140 {
141  // Output pins
142 
143  digital_out_t rst;
144  digital_out_t wke;
145 
146  // Input pins
147 
148  digital_in_t int_pin;
149 
150  // Modules
151 
152  i2c_master_t i2c;
153 
154  // ctx variable
155 
156  uint8_t slave_address;
157 
158 } airquality3_t;
159 
163 typedef struct
164 {
165  // Communication gpio pins
166 
167  pin_name_t scl;
168  pin_name_t sda;
169 
170  // Additional gpio pins
171 
172  pin_name_t rst;
173  pin_name_t wke;
174  pin_name_t int_pin;
175 
176  // static variable
177 
178  uint32_t i2c_speed;
179  uint8_t i2c_address;
180 
182 
186 typedef struct
187 {
188  uint8_t device_id;
189  uint8_t hw_ver;
190  uint8_t fw_boot_ver;
191  uint8_t fw_app_ver;
192 
194 
198 typedef struct
199 {
200  uint16_t co2;
201  uint16_t tvoc;
202  uint16_t raw_data;
203  uint8_t m_status;
204 
206  // End types group
208 
209 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
210 
216 #ifdef __cplusplus
217 extern "C"{
218 #endif
219 
229 
239 
253 
264 void airquality3_generic_write ( airquality3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
265 
276 void airquality3_generic_read ( airquality3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
277 
284 uint8_t airquality3_get_starus ( airquality3_t *ctx );
285 
294 
308 void airquality3_software_reset ( airquality3_t *ctx, uint32_t reset ); // 0x11,0xE5,0x72,0x8A
309 
325 
326 
333 void airquality3_get_raw_data ( airquality3_t *ctx, uint16_t *raw_data );
334 
348 void airquality3_set_environment_data ( airquality3_t *ctx, uint32_t env_data ); // 0x11,0xE5,0x72,0x8A
349 
363 void airquality3_get_ntc_data ( airquality3_t *ctx, uint8_t *data_buf );
364 
389 void airquality3_set_measurement_mode ( airquality3_t *ctx, uint8_t mode );
390 
403 void airquality3_set_baseline ( airquality3_t *ctx, uint16_t baseline );
404 
418 void airquality3_app_function ( airquality3_t *ctx, uint8_t app_task );
419 
426 void airquality3_set_power( airquality3_t *ctx, uint16_t pwr_state );
427 
434 
442 
443 #ifdef __cplusplus
444 }
445 #endif
446 #endif // _AIRQUALITY3_H_
447  // End public_function group
450 
451 // ------------------------------------------------------------------------- END
airquality3_cfg_t::sda
pin_name_t sda
Definition: airquality3.h:168
airquality3_app_function
void airquality3_app_function(airquality3_t *ctx, uint8_t app_task)
function to start APP task
airguality3_info_t::device_id
uint8_t device_id
Definition: airquality3.h:188
airguality3_info_t::fw_boot_ver
uint8_t fw_boot_ver
Definition: airquality3.h:190
airquality3_software_reset
void airquality3_software_reset(airquality3_t *ctx, uint32_t reset)
Software reset.
airquality3_cfg_t::i2c_address
uint8_t i2c_address
Definition: airquality3.h:179
airquality3_set_environment_data
void airquality3_set_environment_data(airquality3_t *ctx, uint32_t env_data)
Temperature and humidity data settings.
airquality3_cfg_t::wke
pin_name_t wke
Definition: airquality3.h:173
airguality3_info_t::hw_ver
uint8_t hw_ver
Definition: airquality3.h:189
airquality3_air_data_t::m_status
uint8_t m_status
Definition: airquality3.h:203
airquality3_generic_write
void airquality3_generic_write(airquality3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
airquality3_cfg_t::scl
pin_name_t scl
Definition: airquality3.h:167
airquality3_t::i2c
i2c_master_t i2c
Definition: airquality3.h:152
airquality3_air_data_t
Air data structure definition.
Definition: airquality3.h:198
airquality3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: airquality3.h:178
airquality3_air_data_t::raw_data
uint16_t raw_data
Definition: airquality3.h:202
airquality3_get_device_info
void airquality3_get_device_info(airquality3_t *ctx, airguality3_info_t *info)
Get device info.
airquality3_set_measurement_mode
void airquality3_set_measurement_mode(airquality3_t *ctx, uint8_t mode)
Function for settings sensor drive mode and interrupts.
airquality3_generic_read
void airquality3_generic_read(airquality3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
airquality3_get_starus
uint8_t airquality3_get_starus(airquality3_t *ctx)
Reads status.
airquality3_t::slave_address
uint8_t slave_address
Definition: airquality3.h:156
airquality3_air_data_t::co2
uint16_t co2
Definition: airquality3.h:200
AIRQUALITY3_RETVAL
#define AIRQUALITY3_RETVAL
Definition: airquality3.h:64
airquality3_t::rst
digital_out_t rst
Definition: airquality3.h:143
airquality3_hardware_reset
void airquality3_hardware_reset(airquality3_t *ctx)
Hardware reset.
airquality3_cfg_t
Click configuration structure definition.
Definition: airquality3.h:163
airquality3_cfg_setup
void airquality3_cfg_setup(airquality3_cfg_t *cfg)
Config Object Initialization function.
airquality3_get_interrupt_state
uint8_t airquality3_get_interrupt_state(airquality3_t *ctx)
Get interrupt state.
airquality3_set_baseline
void airquality3_set_baseline(airquality3_t *ctx, uint16_t baseline)
Function for settings baseline value.
airguality3_info_t
Info structure definition.
Definition: airquality3.h:186
airquality3_t::int_pin
digital_in_t int_pin
Definition: airquality3.h:148
airquality3_get_ntc_data
void airquality3_get_ntc_data(airquality3_t *ctx, uint8_t *data_buf)
Get NTC value.
airquality3_get_raw_data
void airquality3_get_raw_data(airquality3_t *ctx, uint16_t *raw_data)
Function reads raw ADC data values for resistance and current source used.
airquality3_cfg_t::rst
pin_name_t rst
Definition: airquality3.h:172
airquality3_init
AIRQUALITY3_RETVAL airquality3_init(airquality3_t *ctx, airquality3_cfg_t *cfg)
Initialization function.
airguality3_info_t::fw_app_ver
uint8_t fw_app_ver
Definition: airquality3.h:191
airquality3_t
Click ctx object definition.
Definition: airquality3.h:139
airquality3_cfg_t::int_pin
pin_name_t int_pin
Definition: airquality3.h:174
airquality3_default_cfg
void airquality3_default_cfg(airquality3_t *ctx)
Click Default Configuration function.
airquality3_set_power
void airquality3_set_power(airquality3_t *ctx, uint16_t pwr_state)
Function for power ON/OFF chip.
airquality3_t::wke
digital_out_t wke
Definition: airquality3.h:144
airquality3_get_co2_and_tvoc
uint8_t airquality3_get_co2_and_tvoc(airquality3_t *ctx, airquality3_air_data_t *air_data)
Get CO2 and TVOC data.
airquality3_air_data_t::tvoc
uint16_t tvoc
Definition: airquality3.h:201