environment4.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef ENVIRONMENT4_H
#define ENVIRONMENT4_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define ENVIRONMENT4_SGP_CMD_EXE_CONDITIONING       0x2612u
#define ENVIRONMENT4_SGP_CMD_MEAS_RAW_SIGNALS       0x2619u
#define ENVIRONMENT4_SGP_CMD_EXE_SELF_TEST          0x280Eu
#define ENVIRONMENT4_SGP_TURN_HEATER_OFF            0x3615u
#define ENVIRONMENT4_SGP_GET_SERIAL_NUMBER          0x3682u
 
#define ENVIRONMENT4_SHT_CMD_MEAS_TH_HIGH_PREC      0xFD
#define ENVIRONMENT4_SHT_CMD_MEAS_TH_MED_PREC       0xF6
#define ENVIRONMENT4_SHT_CMD_MEAS_TH_LOW_PREC       0xE0
#define ENVIRONMENT4_SHT_CMD_READ_SERIAL_NUM        0x89
#define ENVIRONMENT4_SHT_CMD_SOFT_RESET             0x94
#define ENVIRONMENT4_SHT_CMD_ACT_HEATER_200mW_1S    0x39
#define ENVIRONMENT4_SHT_CMD_ACT_HEATER_200mW_0p1S  0x32
#define ENVIRONMENT4_SHT_CMD_ACT_HEATER_110mW_1S    0x2F
#define ENVIRONMENT4_SHT_CMD_ACT_HEATER_110mW_0p1S  0x24
#define ENVIRONMENT4_SHT_CMD_ACT_HEATER_20mW_1S     0x1E
#define ENVIRONMENT4_SHT_CMD_ACT_HEATER_20mW_0p1S   0x15
 
 // environment4_reg
 
#define ENVIRONMENT4_SGP_SELF_TEST_OK               0x00
#define ENVIRONMENT4_SGP_SELF_TEST_VOC_PIXEL        0x01
#define ENVIRONMENT4_SGP_SELF_TEST_NOX_PIXEL        0x02
#define ENVIRONMENT4_SGP_SELF_TEST_MASK             0x03
 
#define ENVIRONMENT4_SHT_MAX_RH                     100.0
#define ENVIRONMENT4_SHT_MIN_RH                     0.0
#define ENVIRONMENT4_SHT_DATA_RESOLUTION            65535.0
#define ENVIRONMENT4_SHT_ABS_MIN_TEMP               ( -45.0 )
#define ENVIRONMENT4_SHT_ABS_MAX_TEMP               ( 130.0 )
#define ENVIRONMENT4_SHT_ABS_MIN_HUM                ( -6.0 )
#define ENVIRONMENT4_SHT_ABS_MAX_HUM                ( 119.0 )
 
#define ENVIRONMENT4_SHT_DEVICE_ADDRESS             0x44
#define ENVIRONMENT4_SGP_DEVICE_ADDRESS             0x59
 
 // environment4_set
 
#define ENVIRONMENT4_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // environment4_map
 // environment4
 
typedef struct
{
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} environment4_t;
 
typedef struct
{
    pin_name_t scl;                 
    pin_name_t sda;                 
    uint32_t   i2c_speed;           
    uint8_t    i2c_address;         
} environment4_cfg_t;
 
typedef enum
{
    ENVIRONMENT4_OK = 0,
    ENVIRONMENT4_ERROR = -1
 
} environment4_return_value_t;
 
void environment4_cfg_setup ( environment4_cfg_t *cfg );
 
err_t environment4_init ( environment4_t *ctx, environment4_cfg_t *cfg );
 
err_t environment4_sgp_exe_conditioning ( environment4_t *ctx, uint16_t comp_rh, uint16_t comp_t, 
                                          uint16_t *sraw_voc );
 
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 );
 
err_t environment4_sgp_exe_self_test ( environment4_t *ctx, uint8_t *test_result );
 
err_t environment4_sgp_turn_heater_off ( environment4_t *ctx );
 
err_t environment4_sgp_get_serial_num ( environment4_t *ctx, uint16_t *serial_num );
 
err_t environment4_sht_send_cmd ( environment4_t *ctx, uint8_t cmd );
 
err_t environment4_sht_read_response ( environment4_t *ctx, uint8_t *data_out );
 
err_t environment4_sht_soft_reset ( environment4_t *ctx );
 
err_t environment4_sht_read_serial_num ( environment4_t *ctx, uint32_t *serial_num );
 
err_t environment4_sht_read_meas_hp ( environment4_t *ctx, float *temp, float *hum );
 
#ifdef __cplusplus
}
#endif
#endif // ENVIRONMENT4_H
 
 // environment4
 
// ------------------------------------------------------------------------ END