environment2  2.0.0.0
environment2.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 ENVIRONMENT2_H
29 #define ENVIRONMENT2_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 
59 #define ENVIRONMENT2_SGP40_CMD_MEASURE_RAW 0x260F
60 #define ENVIRONMENT2_SGP40_CMD_MEASURE_TEST 0x280E
61 #define ENVIRONMENT2_SGP40_CMD_HEATER_OFF 0x3615
62 #define ENVIRONMENT2_SGP40_CMD_SOFT_RESET 0x0006
63 
68 #define ENVIRONMENT2_SHT40_CMD_MEASURE_T_RH_HIGH_PRECISION 0xFD
69 #define ENVIRONMENT2_SHT40_CMD_MEASURE_T_RH_MEDIUM_PRECISION 0xF6
70 #define ENVIRONMENT2_SHT40_CMD_MEASURE_T_RH_LOWEST_PRECISION 0xE0
71 #define ENVIRONMENT2_SHT40_CMD_READ_SERIAL 0x89
72 #define ENVIRONMENT2_SHT40_CMD_SOFT_RESET 0x94
73 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_HIGHEST_HEATER_1SEC 0x39
74 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_HIGHEST_HEATER_0_1SEC 0x32
75 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_MEDIUM_HEATER_1SEC 0x2F
76 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_MEDIUM_HEATER_0_1SEC 0x24
77 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_LOWEST_HEATER_1SEC 0x1E
78 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_LOWEST_HEATER_0_1SEC 0x15
79  // environment2_cmd
81 
97 #define ENVIRONMENT2_SGP40_SET_DEV_ADDR 0x59
98 #define ENVIRONMENT2_SHT40_SET_DEV_ADDR 0x44
99 
105 #define ENVIRONMENT2_SEL_SGP40 0x00
106 #define ENVIRONMENT2_SEL_SHT40 0x01
107 
113 #define F16(x) \
114  ((fix16_t)(((x) >= 0) ? ((x)*65536.0 + 0.5) : ((x)*65536.0 - 0.5)))
115 #define VocAlgorithm_SAMPLING_INTERVAL (1.)
116 #define VocAlgorithm_INITIAL_BLACKOUT (45.)
117 #define VocAlgorithm_VOC_INDEX_GAIN (230.)
118 #define VocAlgorithm_SRAW_STD_INITIAL (50.)
119 #define VocAlgorithm_SRAW_STD_BONUS (220.)
120 #define VocAlgorithm_TAU_MEAN_VARIANCE_HOURS (12.)
121 #define VocAlgorithm_TAU_INITIAL_MEAN (20.)
122 #define VocAlgorithm_INIT_DURATION_MEAN ((3600. * 0.75))
123 #define VocAlgorithm_INIT_TRANSITION_MEAN (0.01)
124 #define VocAlgorithm_TAU_INITIAL_VARIANCE (2500.)
125 #define VocAlgorithm_INIT_DURATION_VARIANCE ((3600. * 1.45))
126 #define VocAlgorithm_INIT_TRANSITION_VARIANCE (0.01)
127 #define VocAlgorithm_GATING_THRESHOLD (340.)
128 #define VocAlgorithm_GATING_THRESHOLD_INITIAL (510.)
129 #define VocAlgorithm_GATING_THRESHOLD_TRANSITION (0.09)
130 #define VocAlgorithm_GATING_MAX_DURATION_MINUTES ((60. * 3.))
131 #define VocAlgorithm_GATING_MAX_RATIO (0.3)
132 #define VocAlgorithm_SIGMOID_L (500.)
133 #define VocAlgorithm_SIGMOID_K (-0.0065)
134 #define VocAlgorithm_SIGMOID_X0 (213.)
135 #define VocAlgorithm_VOC_INDEX_OFFSET_DEFAULT (100.)
136 #define VocAlgorithm_LP_TAU_FAST (20.0)
137 #define VocAlgorithm_LP_TAU_SLOW (500.0)
138 #define VocAlgorithm_LP_ALPHA (-0.2)
139 #define VocAlgorithm_PERSISTENCE_UPTIME_GAMMA ((3. * 3600.))
140 #define VocAlgorithm_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING (64.)
141 #define VocAlgorithm_MEAN_VARIANCE_ESTIMATOR__FIX16_MAX (32767.)
142  // environment2_set
144 
154 #define ENVIRONMENT2_SGP40_TEST_PASSED 0xD400
155 #define ENVIRONMENT2_SGP40_TEST_FAILED 0x4B00
156 
157  // environment2_get
159 
174 #define ENVIRONMENT2_MAP_MIKROBUS( cfg, mikrobus ) \
175  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
176  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
177  // environment2_map // environment2
180 
185 typedef struct
186 {
187  // Modules
188 
189  i2c_master_t i2c;
191  // I2C slave address
192 
193  uint8_t slave_address;
196 
201 typedef struct
202 {
203  pin_name_t scl;
204  pin_name_t sda;
206  uint32_t i2c_speed;
207  uint8_t i2c_address;
210 
211 typedef int32_t fix16_t;
212 
213 
218 typedef struct {
252 
257 typedef enum
258 {
260  ENVIRONMENT2_ERROR = -1
261 
263 
282 
300 
318 err_t environment2_generic_write ( environment2_t *ctx, uint8_t select_device, uint16_t cmd, uint8_t *tx_buf );
319 
337 err_t environment2_generic_read ( environment2_t *ctx, uint8_t select_device, uint16_t cmd, uint8_t *rx_buf );
338 
357 err_t environment2_get_temp_hum ( environment2_t *ctx, float *humidity, float *temperature );
358 
375 err_t environment2_get_air_quality ( environment2_t *ctx, uint16_t *air_quality );
376 
395 
412 
430 
444 
458 
476 err_t environment2_voc_algorithm_process ( environment2_voc_algorithm_params *params, int32_t sraw, int32_t *voc_index );
477 
495 err_t environment2_measure_voc_index_with_rh_t ( environment2_t *ctx, int32_t *voc_index, int32_t *relative_humidity, int32_t *temperature );
496 
514 err_t environment2_get_voc_index ( environment2_t *ctx, int32_t *voc_index );
515 
516 #ifdef __cplusplus
517 }
518 #endif
519 #endif // ENVIRONMENT2_H
520  // environment2
522 
523 // ------------------------------------------------------------------------ END
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Uptime_Gamma
fix16_t m_Mean_Variance_Estimator___Uptime_Gamma
Definition: environment2.h:236
environment2_voc_algorithm_params::m_Mean_Variance_Estimator__Gamma_Variance
fix16_t m_Mean_Variance_Estimator__Gamma_Variance
Definition: environment2.h:235
environment2_return_value_t
environment2_return_value_t
Environment 2 Click return value data.
Definition: environment2.h:258
environment2_get_voc_index
err_t environment2_get_voc_index(environment2_t *ctx, int32_t *voc_index)
Environment 2 get VOC index function.
environment2_cfg_t::i2c_address
uint8_t i2c_address
Definition: environment2.h:207
environment2_voc_algorithm_params
Environment 2 Click VOC algorithm object.
Definition: environment2.h:218
environment2_cfg_setup
void environment2_cfg_setup(environment2_cfg_t *cfg)
Environment 2 configuration object setup function.
fix16_t
int32_t fix16_t
Definition: environment2.h:211
environment2_cfg_t::scl
pin_name_t scl
Definition: environment2.h:203
ENVIRONMENT2_OK
@ ENVIRONMENT2_OK
Definition: environment2.h:259
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Sigmoid__X0
fix16_t m_Mean_Variance_Estimator___Sigmoid__X0
Definition: environment2.h:241
environment2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: environment2.h:206
environment2_voc_algorithm_process
err_t environment2_voc_algorithm_process(environment2_voc_algorithm_params *params, int32_t sraw, int32_t *voc_index)
Environment 2 VOC algorithm process function.
environment2_voc_algorithm_params::m_Sigmoid_Scaled__Offset
fix16_t m_Sigmoid_Scaled__Offset
Definition: environment2.h:244
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Sraw_Offset
fix16_t m_Mean_Variance_Estimator___Sraw_Offset
Definition: environment2.h:229
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Gamma_Initial_Variance
fix16_t m_Mean_Variance_Estimator___Gamma_Initial_Variance
Definition: environment2.h:233
ENVIRONMENT2_ERROR
@ ENVIRONMENT2_ERROR
Definition: environment2.h:260
environment2_get_air_quality
err_t environment2_get_air_quality(environment2_t *ctx, uint16_t *air_quality)
Environment 2 get air quality data function.
environment2_measure_voc_index_with_rh_t
err_t environment2_measure_voc_index_with_rh_t(environment2_t *ctx, int32_t *voc_index, int32_t *relative_humidity, int32_t *temperature)
Environment 2 measure VOC index with relative humidity and temperature function.
environment2_voc_algorithm_params::m_Adaptive_Lowpass___X1
fix16_t m_Adaptive_Lowpass___X1
Definition: environment2.h:248
environment2_voc_algorithm_params::mVoc_Index_Offset
fix16_t mVoc_Index_Offset
Definition: environment2.h:219
environment2_voc_algorithm_params::m_Mean_Variance_Estimator__Gating_Max_Duration_Minutes
fix16_t m_Mean_Variance_Estimator__Gating_Max_Duration_Minutes
Definition: environment2.h:226
environment2_voc_algorithm_params::mVoc_Index
fix16_t mVoc_Index
Definition: environment2.h:225
environment2_voc_algorithm_params::m_Adaptive_Lowpass___X2
fix16_t m_Adaptive_Lowpass___X2
Definition: environment2.h:249
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Initialized
bool m_Mean_Variance_Estimator___Initialized
Definition: environment2.h:227
environment2_generic_read
err_t environment2_generic_read(environment2_t *ctx, uint8_t select_device, uint16_t cmd, uint8_t *rx_buf)
Environment 2 I2C reading function.
environment2_voc_algorithm_params::m_Adaptive_Lowpass__A1
fix16_t m_Adaptive_Lowpass__A1
Definition: environment2.h:245
environment2_voc_algorithm_params::m_Mox_Model__Sraw_Std
fix16_t m_Mox_Model__Sraw_Std
Definition: environment2.h:242
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Sigmoid__K
fix16_t m_Mean_Variance_Estimator___Sigmoid__K
Definition: environment2.h:240
environment2_voc_algorithm_params::mSraw
fix16_t mSraw
Definition: environment2.h:224
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Gamma_Initial_Mean
fix16_t m_Mean_Variance_Estimator___Gamma_Initial_Mean
Definition: environment2.h:232
environment2_voc_algorithm_params::m_Adaptive_Lowpass___X3
fix16_t m_Adaptive_Lowpass___X3
Definition: environment2.h:250
environment2_voc_algorithm_params::mTau_Mean_Variance_Hours
fix16_t mTau_Mean_Variance_Hours
Definition: environment2.h:220
environment2_sgp40_measure_test
uint16_t environment2_sgp40_measure_test(environment2_t *ctx)
Environment 2 SGP40 measurement test function.
environment2_t
Environment 2 Click context object.
Definition: environment2.h:186
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Gating_Duration_Minutes
fix16_t m_Mean_Variance_Estimator___Gating_Duration_Minutes
Definition: environment2.h:238
environment2_voc_algorithm_params::mSraw_Std_Initial
fix16_t mSraw_Std_Initial
Definition: environment2.h:222
environment2_voc_algorithm_params::mUptime
fix16_t mUptime
Definition: environment2.h:223
environment2_voc_algorithm_params::mGating_Max_Duration_Minutes
fix16_t mGating_Max_Duration_Minutes
Definition: environment2.h:221
environment2_voc_algorithm_params::m_Adaptive_Lowpass___Initialized
bool m_Adaptive_Lowpass___Initialized
Definition: environment2.h:247
environment2_sgp40_soft_reset
err_t environment2_sgp40_soft_reset(environment2_t *ctx)
Environment 2 soft reset function.
environment2_sgp40_heater_off
err_t environment2_sgp40_heater_off(environment2_t *ctx)
Environment 2 heater off function.
environment2_get_temp_hum
err_t environment2_get_temp_hum(environment2_t *ctx, float *humidity, float *temperature)
Environment 2 get temperature and relative humidity function.
environment2_generic_write
err_t environment2_generic_write(environment2_t *ctx, uint8_t select_device, uint16_t cmd, uint8_t *tx_buf)
Environment 2 I2C writing function.
environment2_t::slave_address
uint8_t slave_address
Definition: environment2.h:193
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Mean
fix16_t m_Mean_Variance_Estimator___Mean
Definition: environment2.h:228
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Uptime_Gating
fix16_t m_Mean_Variance_Estimator___Uptime_Gating
Definition: environment2.h:237
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Std
fix16_t m_Mean_Variance_Estimator___Std
Definition: environment2.h:230
environment2_cfg_t::sda
pin_name_t sda
Definition: environment2.h:204
environment2_voc_algorithm_params::m_Adaptive_Lowpass__A2
fix16_t m_Adaptive_Lowpass__A2
Definition: environment2.h:246
environment2_voc_algorithm_params::m_Mean_Variance_Estimator__Gamma_Mean
fix16_t m_Mean_Variance_Estimator__Gamma_Mean
Definition: environment2.h:234
environment2_t::i2c
i2c_master_t i2c
Definition: environment2.h:189
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Sigmoid__L
fix16_t m_Mean_Variance_Estimator___Sigmoid__L
Definition: environment2.h:239
environment2_voc_algorithm_configuration
err_t environment2_voc_algorithm_configuration(environment2_voc_algorithm_params *params)
Environment 2 VOC algorithm configuration function.
environment2_voc_algorithm_params::m_Mox_Model__Sraw_Mean
fix16_t m_Mox_Model__Sraw_Mean
Definition: environment2.h:243
environment2_init
err_t environment2_init(environment2_t *ctx, environment2_cfg_t *cfg)
Environment 2 initialization function.
environment2_cfg_t
Environment 2 Click configuration object.
Definition: environment2.h:202
environment2_config_sensors
err_t environment2_config_sensors(void)
Environment 2 sensors configuration function.
environment2_voc_algorithm_params::m_Mean_Variance_Estimator___Gamma
fix16_t m_Mean_Variance_Estimator___Gamma
Definition: environment2.h:231