Go to the documentation of this file.
28 #ifndef ENVIRONMENT2_H
29 #define ENVIRONMENT2_H
35 #include "mikrosdk_version.h"
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
69 #define ENVIRONMENT2_SGP40_CMD_MEASURE_RAW 0x260F
70 #define ENVIRONMENT2_SGP40_CMD_MEASURE_TEST 0x280E
71 #define ENVIRONMENT2_SGP40_CMD_HEATER_OFF 0x3615
72 #define ENVIRONMENT2_SGP40_CMD_SOFT_RESET 0x0006
78 #define ENVIRONMENT2_SHT40_CMD_MEASURE_T_RH_HIGH_PRECISION 0xFD
79 #define ENVIRONMENT2_SHT40_CMD_MEASURE_T_RH_MEDIUM_PRECISION 0xF6
80 #define ENVIRONMENT2_SHT40_CMD_MEASURE_T_RH_LOWEST_PRECISION 0xE0
81 #define ENVIRONMENT2_SHT40_CMD_READ_SERIAL 0x89
82 #define ENVIRONMENT2_SHT40_CMD_SOFT_RESET 0x94
83 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_HIGHEST_HEATER_1SEC 0x39
84 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_HIGHEST_HEATER_0_1SEC 0x32
85 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_MEDIUM_HEATER_1SEC 0x2F
86 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_MEDIUM_HEATER_0_1SEC 0x24
87 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_LOWEST_HEATER_1SEC 0x1E
88 #define ENVIRONMENT2_SHT40_CMD_ACTIVATE_LOWEST_HEATER_0_1SEC 0x15
107 #define ENVIRONMENT2_SGP40_SET_DEV_ADDR 0x59
108 #define ENVIRONMENT2_SHT40_SET_DEV_ADDR 0x44
115 #define ENVIRONMENT2_SEL_SGP40 0x00
116 #define ENVIRONMENT2_SEL_SHT40 0x01
124 ((fix16_t)(((x) >= 0) ? ((x)*65536.0 + 0.5) : ((x)*65536.0 - 0.5)))
125 #define VocAlgorithm_SAMPLING_INTERVAL (1.)
126 #define VocAlgorithm_INITIAL_BLACKOUT (45.)
127 #define VocAlgorithm_VOC_INDEX_GAIN (230.)
128 #define VocAlgorithm_SRAW_STD_INITIAL (50.)
129 #define VocAlgorithm_SRAW_STD_BONUS (220.)
130 #define VocAlgorithm_TAU_MEAN_VARIANCE_HOURS (12.)
131 #define VocAlgorithm_TAU_INITIAL_MEAN (20.)
132 #define VocAlgorithm_INIT_DURATION_MEAN ((3600. * 0.75))
133 #define VocAlgorithm_INIT_TRANSITION_MEAN (0.01)
134 #define VocAlgorithm_TAU_INITIAL_VARIANCE (2500.)
135 #define VocAlgorithm_INIT_DURATION_VARIANCE ((3600. * 1.45))
136 #define VocAlgorithm_INIT_TRANSITION_VARIANCE (0.01)
137 #define VocAlgorithm_GATING_THRESHOLD (340.)
138 #define VocAlgorithm_GATING_THRESHOLD_INITIAL (510.)
139 #define VocAlgorithm_GATING_THRESHOLD_TRANSITION (0.09)
140 #define VocAlgorithm_GATING_MAX_DURATION_MINUTES ((60. * 3.))
141 #define VocAlgorithm_GATING_MAX_RATIO (0.3)
142 #define VocAlgorithm_SIGMOID_L (500.)
143 #define VocAlgorithm_SIGMOID_K (-0.0065)
144 #define VocAlgorithm_SIGMOID_X0 (213.)
145 #define VocAlgorithm_VOC_INDEX_OFFSET_DEFAULT (100.)
146 #define VocAlgorithm_LP_TAU_FAST (20.0)
147 #define VocAlgorithm_LP_TAU_SLOW (500.0)
148 #define VocAlgorithm_LP_ALPHA (-0.2)
149 #define VocAlgorithm_PERSISTENCE_UPTIME_GAMMA ((3. * 3600.))
150 #define VocAlgorithm_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING (64.)
151 #define VocAlgorithm_MEAN_VARIANCE_ESTIMATOR__FIX16_MAX (32767.)
164 #define ENVIRONMENT2_SGP40_TEST_PASSED 0xD400
165 #define ENVIRONMENT2_SGP40_TEST_FAILED 0x4B00
184 #define ENVIRONMENT2_MAP_MIKROBUS( cfg, mikrobus ) \
185 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
186 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
528 #endif // ENVIRONMENT2_H
fix16_t m_Mean_Variance_Estimator___Uptime_Gamma
Definition: environment2.h:246
fix16_t m_Mean_Variance_Estimator__Gamma_Variance
Definition: environment2.h:245
environment2_return_value_t
Environment 2 Click return value data.
Definition: environment2.h:268
err_t environment2_get_voc_index(environment2_t *ctx, int32_t *voc_index)
Environment 2 get VOC index function.
uint8_t i2c_address
Definition: environment2.h:217
err_t environment2_generic_write(environment2_t *ctx, uint8_t select_device, uint16_t cmd)
Environment 2 I2C writing function.
Environment 2 Click VOC algorithm object.
Definition: environment2.h:228
void environment2_cfg_setup(environment2_cfg_t *cfg)
Environment 2 configuration object setup function.
int32_t fix16_t
Definition: environment2.h:221
pin_name_t scl
Definition: environment2.h:213
@ ENVIRONMENT2_OK
Definition: environment2.h:269
fix16_t m_Mean_Variance_Estimator___Sigmoid__X0
Definition: environment2.h:251
uint32_t i2c_speed
Definition: environment2.h:216
err_t environment2_voc_algorithm_process(environment2_voc_algorithm_params *params, int32_t sraw, int32_t *voc_index)
Environment 2 VOC algorithm process function.
fix16_t m_Sigmoid_Scaled__Offset
Definition: environment2.h:254
fix16_t m_Mean_Variance_Estimator___Sraw_Offset
Definition: environment2.h:239
fix16_t m_Mean_Variance_Estimator___Gamma_Initial_Variance
Definition: environment2.h:243
@ ENVIRONMENT2_ERROR
Definition: environment2.h:270
err_t environment2_get_air_quality(environment2_t *ctx, uint16_t *air_quality)
Environment 2 get air quality data function.
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.
fix16_t m_Adaptive_Lowpass___X1
Definition: environment2.h:258
fix16_t mVoc_Index_Offset
Definition: environment2.h:229
fix16_t m_Mean_Variance_Estimator__Gating_Max_Duration_Minutes
Definition: environment2.h:236
fix16_t mVoc_Index
Definition: environment2.h:235
fix16_t m_Adaptive_Lowpass___X2
Definition: environment2.h:259
bool m_Mean_Variance_Estimator___Initialized
Definition: environment2.h:237
err_t environment2_generic_read(environment2_t *ctx, uint8_t select_device, uint16_t cmd, uint8_t *rx_buf)
Environment 2 I2C reading function.
fix16_t m_Adaptive_Lowpass__A1
Definition: environment2.h:255
fix16_t m_Mox_Model__Sraw_Std
Definition: environment2.h:252
fix16_t m_Mean_Variance_Estimator___Sigmoid__K
Definition: environment2.h:250
fix16_t mSraw
Definition: environment2.h:234
fix16_t m_Mean_Variance_Estimator___Gamma_Initial_Mean
Definition: environment2.h:242
fix16_t m_Adaptive_Lowpass___X3
Definition: environment2.h:260
fix16_t mTau_Mean_Variance_Hours
Definition: environment2.h:230
uint16_t environment2_sgp40_measure_test(environment2_t *ctx)
Environment 2 SGP40 measurement test function.
Environment 2 Click context object.
Definition: environment2.h:196
fix16_t m_Mean_Variance_Estimator___Gating_Duration_Minutes
Definition: environment2.h:248
fix16_t mSraw_Std_Initial
Definition: environment2.h:232
fix16_t mUptime
Definition: environment2.h:233
fix16_t mGating_Max_Duration_Minutes
Definition: environment2.h:231
bool m_Adaptive_Lowpass___Initialized
Definition: environment2.h:257
err_t environment2_sgp40_soft_reset(environment2_t *ctx)
Environment 2 soft reset function.
err_t environment2_sgp40_heater_off(environment2_t *ctx)
Environment 2 heater off function.
err_t environment2_get_temp_hum(environment2_t *ctx, float *humidity, float *temperature)
Environment 2 get temperature and relative humidity function.
uint8_t slave_address
Definition: environment2.h:203
fix16_t m_Mean_Variance_Estimator___Mean
Definition: environment2.h:238
fix16_t m_Mean_Variance_Estimator___Uptime_Gating
Definition: environment2.h:247
fix16_t m_Mean_Variance_Estimator___Std
Definition: environment2.h:240
pin_name_t sda
Definition: environment2.h:214
fix16_t m_Adaptive_Lowpass__A2
Definition: environment2.h:256
fix16_t m_Mean_Variance_Estimator__Gamma_Mean
Definition: environment2.h:244
i2c_master_t i2c
Definition: environment2.h:199
fix16_t m_Mean_Variance_Estimator___Sigmoid__L
Definition: environment2.h:249
err_t environment2_voc_algorithm_configuration(environment2_voc_algorithm_params *params)
Environment 2 VOC algorithm configuration function.
fix16_t m_Mox_Model__Sraw_Mean
Definition: environment2.h:253
err_t environment2_init(environment2_t *ctx, environment2_cfg_t *cfg)
Environment 2 initialization function.
Environment 2 Click configuration object.
Definition: environment2.h:212
err_t environment2_config_sensors(void)
Environment 2 sensors configuration function.
fix16_t m_Mean_Variance_Estimator___Gamma
Definition: environment2.h:241