environment4  2.1.0.0
environment4.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 ENVIRONMENT4_H
29 #define ENVIRONMENT4_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
69 #define ENVIRONMENT4_SGP_CMD_EXE_CONDITIONING 0x2612u
70 #define ENVIRONMENT4_SGP_CMD_MEAS_RAW_SIGNALS 0x2619u
71 #define ENVIRONMENT4_SGP_CMD_EXE_SELF_TEST 0x280Eu
72 #define ENVIRONMENT4_SGP_TURN_HEATER_OFF 0x3615u
73 #define ENVIRONMENT4_SGP_GET_SERIAL_NUMBER 0x3682u
74 
79 #define ENVIRONMENT4_SHT_CMD_MEAS_TH_HIGH_PREC 0xFD
80 #define ENVIRONMENT4_SHT_CMD_MEAS_TH_MED_PREC 0xF6
81 #define ENVIRONMENT4_SHT_CMD_MEAS_TH_LOW_PREC 0xE0
82 #define ENVIRONMENT4_SHT_CMD_READ_SERIAL_NUM 0x89
83 #define ENVIRONMENT4_SHT_CMD_SOFT_RESET 0x94
84 #define ENVIRONMENT4_SHT_CMD_ACT_HEATER_200mW_1S 0x39
85 #define ENVIRONMENT4_SHT_CMD_ACT_HEATER_200mW_0p1S 0x32
86 #define ENVIRONMENT4_SHT_CMD_ACT_HEATER_110mW_1S 0x2F
87 #define ENVIRONMENT4_SHT_CMD_ACT_HEATER_110mW_0p1S 0x24
88 #define ENVIRONMENT4_SHT_CMD_ACT_HEATER_20mW_1S 0x1E
89 #define ENVIRONMENT4_SHT_CMD_ACT_HEATER_20mW_0p1S 0x15
90  // environment4_reg
92 
107 #define ENVIRONMENT4_SGP_SELF_TEST_OK 0x00
108 #define ENVIRONMENT4_SGP_SELF_TEST_VOC_PIXEL 0x01
109 #define ENVIRONMENT4_SGP_SELF_TEST_NOX_PIXEL 0x02
110 #define ENVIRONMENT4_SGP_SELF_TEST_MASK 0x03
111 
116 #define ENVIRONMENT4_SHT_MAX_RH 100.0
117 #define ENVIRONMENT4_SHT_MIN_RH 0.0
118 #define ENVIRONMENT4_SHT_DATA_RESOLUTION 65535.0
119 #define ENVIRONMENT4_SHT_ABS_MIN_TEMP ( -45.0 )
120 #define ENVIRONMENT4_SHT_ABS_MAX_TEMP ( 130.0 )
121 #define ENVIRONMENT4_SHT_ABS_MIN_HUM ( -6.0 )
122 #define ENVIRONMENT4_SHT_ABS_MAX_HUM ( 119.0 )
123 
129 #define ENVIRONMENT4_SHT_DEVICE_ADDRESS 0x44
130 #define ENVIRONMENT4_SGP_DEVICE_ADDRESS 0x59
131  // environment4_set
133 
148 #define ENVIRONMENT4_MAP_MIKROBUS( cfg, mikrobus ) \
149  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
150  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
151  // environment4_map // environment4
154 
159 typedef struct
160 {
161  // Modules
162  i2c_master_t i2c;
164  // I2C slave address
165  uint8_t slave_address;
168 
173 typedef struct
174 {
175  pin_name_t scl;
176  pin_name_t sda;
178  uint32_t i2c_speed;
179  uint8_t i2c_address;
182 
187 typedef enum
188 {
190  ENVIRONMENT4_ERROR = -1
191 
193 
210 
225 
246 err_t environment4_sgp_exe_conditioning ( environment4_t *ctx, uint16_t comp_rh, uint16_t comp_t,
247  uint16_t *sraw_voc );
248 
268 err_t environment4_sgp_meas_raw_signals ( environment4_t *ctx, uint16_t comp_rh, uint16_t comp_t,
269  uint16_t *sraw_voc, uint16_t *sraw_nox );
270 
286 err_t environment4_sgp_exe_self_test ( environment4_t *ctx, uint8_t *test_result );
287 
300 
312 err_t environment4_sgp_get_serial_num ( environment4_t *ctx, uint16_t *serial_num );
313 
325 err_t environment4_sht_send_cmd ( environment4_t *ctx, uint8_t cmd );
326 
339 err_t environment4_sht_read_response ( environment4_t *ctx, uint8_t *data_out );
340 
352 
364 err_t environment4_sht_read_serial_num ( environment4_t *ctx, uint32_t *serial_num );
365 
378 err_t environment4_sht_read_meas_hp ( environment4_t *ctx, float *temp, float *hum );
379 
380 #ifdef __cplusplus
381 }
382 #endif
383 #endif // ENVIRONMENT4_H
384  // environment4
386 
387 // ------------------------------------------------------------------------ END
ENVIRONMENT4_OK
@ ENVIRONMENT4_OK
Definition: environment4.h:189
environment4_sgp_turn_heater_off
err_t environment4_sgp_turn_heater_off(environment4_t *ctx)
Environment 4 sgp turn heater off function.
environment4_sht_read_serial_num
err_t environment4_sht_read_serial_num(environment4_t *ctx, uint32_t *serial_num)
Environment 4 sht read serial num function.
environment4_cfg_t
Environment 4 Click configuration object.
Definition: environment4.h:174
environment4_sht_read_meas_hp
err_t environment4_sht_read_meas_hp(environment4_t *ctx, float *temp, float *hum)
Environment 4 sht read meas hp function.
environment4_init
err_t environment4_init(environment4_t *ctx, environment4_cfg_t *cfg)
Environment 4 initialization function.
environment4_sgp_exe_conditioning
err_t environment4_sgp_exe_conditioning(environment4_t *ctx, uint16_t comp_rh, uint16_t comp_t, uint16_t *sraw_voc)
Environment 4 sgp exe conditioning function.
ENVIRONMENT4_ERROR
@ ENVIRONMENT4_ERROR
Definition: environment4.h:190
environment4_sht_send_cmd
err_t environment4_sht_send_cmd(environment4_t *ctx, uint8_t cmd)
Environment 4 sht send cmd function.
environment4_sgp_exe_self_test
err_t environment4_sgp_exe_self_test(environment4_t *ctx, uint8_t *test_result)
Environment 4 sgp exe self test function.
environment4_sgp_get_serial_num
err_t environment4_sgp_get_serial_num(environment4_t *ctx, uint16_t *serial_num)
Environment 4 sgp get serial num function.
environment4_cfg_t::sda
pin_name_t sda
Definition: environment4.h:176
environment4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: environment4.h:178
environment4_t::slave_address
uint8_t slave_address
Definition: environment4.h:165
environment4_cfg_setup
void environment4_cfg_setup(environment4_cfg_t *cfg)
Environment 4 configuration object setup function.
environment4_sgp_meas_raw_signals
err_t environment4_sgp_meas_raw_signals(environment4_t *ctx, uint16_t comp_rh, uint16_t comp_t, uint16_t *sraw_voc, uint16_t *sraw_nox)
Environment 4 sgp meas raw signals function.
environment4_sht_read_response
err_t environment4_sht_read_response(environment4_t *ctx, uint8_t *data_out)
Environment 4 sht read response function.
environment4_t
Environment 4 Click context object.
Definition: environment4.h:160
environment4_cfg_t::i2c_address
uint8_t i2c_address
Definition: environment4.h:179
environment4_sht_soft_reset
err_t environment4_sht_soft_reset(environment4_t *ctx)
Environment 4 sht soft reset function.
environment4_return_value_t
environment4_return_value_t
Environment 4 Click return value data.
Definition: environment4.h:188
environment4_t::i2c
i2c_master_t i2c
Definition: environment4.h:162
environment4_cfg_t::scl
pin_name_t scl
Definition: environment4.h:175