temphum24.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 TEMPHUM24_H
#define TEMPHUM24_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 TEMPHUM24_CMD_TRG_OD_LP0                    0x2400u
#define TEMPHUM24_CMD_TRG_OD_LP1                    0x240Bu
#define TEMPHUM24_CMD_TRG_OD_LP2                    0x2416u
#define TEMPHUM24_CMD_TRG_OD_LP3                    0x24FFu
#define TEMPHUM24_CMD_AUTO_MEAS_HALF_HZ_LP0         0x2032u
#define TEMPHUM24_CMD_AUTO_MEAS_HALF_HZ_LP1         0x2024u
#define TEMPHUM24_CMD_AUTO_MEAS_HALF_HZ_LP2         0x202Fu
#define TEMPHUM24_CMD_AUTO_MEAS_HALF_HZ_LP3         0x20FFu
#define TEMPHUM24_CMD_AUTO_MEAS_1_HZ_LP0            0x2130u
#define TEMPHUM24_CMD_AUTO_MEAS_1_HZ_LP1            0x2126u
#define TEMPHUM24_CMD_AUTO_MEAS_1_HZ_LP2            0x212Du
#define TEMPHUM24_CMD_AUTO_MEAS_1_HZ_LP3            0x21FFu
#define TEMPHUM24_CMD_AUTO_MEAS_2_HZ_LP0            0x2236u
#define TEMPHUM24_CMD_AUTO_MEAS_2_HZ_LP1            0x2220u
#define TEMPHUM24_CMD_AUTO_MEAS_2_HZ_LP2            0x222Bu
#define TEMPHUM24_CMD_AUTO_MEAS_2_HZ_LP3            0x22FFu
#define TEMPHUM24_CMD_AUTO_MEAS_4_HZ_LP0            0x2334u
#define TEMPHUM24_CMD_AUTO_MEAS_4_HZ_LP1            0x2322u
#define TEMPHUM24_CMD_AUTO_MEAS_4_HZ_LP2            0x2329u
#define TEMPHUM24_CMD_AUTO_MEAS_4_HZ_LP3            0x23FFu
#define TEMPHUM24_CMD_AUTO_MEAS_10_HZ_LP0           0x2737u
#define TEMPHUM24_CMD_AUTO_MEAS_10_HZ_LP1           0x2721u
#define TEMPHUM24_CMD_AUTO_MEAS_10_HZ_LP2           0x272Au
#define TEMPHUM24_CMD_AUTO_MEAS_10_HZ_LP3           0x27FFu
#define TEMPHUM24_CMD_AUTO_MEAS_EXIT                0x3093u
#define TEMPHUM24_CMD_AUTO_MEAS_ROUT_T_RH           0xE000u
#define TEMPHUM24_CMD_AUTO_MEAS_MIN_T               0xE002u
#define TEMPHUM24_CMD_AUTO_MEAS_MAX_T               0xE003u
#define TEMPHUM24_CMD_AUTO_MEAS_MIN_RH              0xE004u
#define TEMPHUM24_CMD_AUTO_MEAS_MAX_RH              0xE005u
#define TEMPHUM24_CMD_PROGRAM_SET_LOW_ALERT         0x6100u
#define TEMPHUM24_CMD_PROGRAM_SET_HIGH_ALERT        0x611Du
#define TEMPHUM24_CMD_PROGRAM_CLEAR_LOW_ALERT       0x610Bu
#define TEMPHUM24_CMD_PROGRAM_CLEAR_HIGH_ALERT      0x6116u
#define TEMPHUM24_CMD_TRANSFER_ALERT_THOLDS_TO_NVM  0x6155u
#define TEMPHUM24_CMD_READ_SET_LOW_ALERT            0xE102u
#define TEMPHUM24_CMD_READ_SET_HIGH_ALERT           0xE11Fu
#define TEMPHUM24_CMD_READ_CLEAR_LOW_ALERT          0xE109u
#define TEMPHUM24_CMD_READ_CLEAR_HIGH_ALERT         0xE114u
#define TEMPHUM24_CMD_INT_HEATER_ENABLE             0x306Du
#define TEMPHUM24_CMD_INT_HEATER_DISABLE            0x3066u
#define TEMPHUM24_CMD_INT_HEATER_CONFIGURE          0x306Eu
#define TEMPHUM24_CMD_STATUS_READ                   0xF32Du
#define TEMPHUM24_CMD_STATUS_CLEAR                  0x3041u
#define TEMPHUM24_CMD_NVM_T_RH_OFFSET               0xA004u
#define TEMPHUM24_CMD_SOFT_RESET                    0x30A2u
#define TEMPHUM24_CMD_READ_NIST_ID_BYTES_5_4        0x3683u
#define TEMPHUM24_CMD_READ_NIST_ID_BYTES_3_2        0x3684u
#define TEMPHUM24_CMD_READ_NIST_ID_BYTES_1_0        0x3685u
#define TEMPHUM24_CMD_READ_MANUFACTURER_ID          0x3781u
#define TEMPHUM24_CMD_OVERRIDE_DEFAULT              0x61BBu
 
 // temphum24_cmd
 
#define TEMPHUM24_MANUFACTURER_ID                   0x3000u
 
#define TEMPHUM24_TEMP_MIN                          ( -45.0f )
#define TEMPHUM24_TEMP_MAX                          ( 130.0f )
#define TEMPHUM24_HUM_MIN                           ( 0.0f )
#define TEMPHUM24_HUM_MAX                           ( 100.0f )
#define TEMPHUM24_DATA_RESOLUTION                   0xFFFFu
 
#define TEMPHUM24_DEVICE_ADDRESS_A1A0_00            0x44
#define TEMPHUM24_DEVICE_ADDRESS_A1A0_01            0x45
#define TEMPHUM24_DEVICE_ADDRESS_A1A0_10            0x46
#define TEMPHUM24_DEVICE_ADDRESS_A1A0_11            0x47
 
 // temphum24_set
 
#define TEMPHUM24_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.alert = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // temphum24_map
 // temphum24
 
typedef struct
{
    // Output pins
    digital_out_t rst;          
    // Input pins
    digital_in_t alert;         
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} temphum24_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t rst;             
    pin_name_t alert;           
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} temphum24_cfg_t;
 
typedef enum
{
    TEMPHUM24_OK = 0,
    TEMPHUM24_ERROR = -1
 
} temphum24_return_value_t;
 
void temphum24_cfg_setup ( temphum24_cfg_t *cfg );
 
err_t temphum24_init ( temphum24_t *ctx, temphum24_cfg_t *cfg );
 
err_t temphum24_default_cfg ( temphum24_t *ctx );
 
err_t temphum24_write_cmd ( temphum24_t *ctx, uint16_t cmd );
 
err_t temphum24_write_cmd_config ( temphum24_t *ctx, uint16_t cmd, uint16_t config );
 
err_t temphum24_read_single ( temphum24_t *ctx, uint16_t *data_out );
 
err_t temphum24_read_multi ( temphum24_t *ctx, uint16_t *data1_out, uint16_t *data2_out );
 
err_t temphum24_write_then_read_single ( temphum24_t *ctx, uint16_t cmd, uint16_t *data_out );
 
err_t temphum24_write_then_read_multi ( temphum24_t *ctx, uint16_t cmd, uint16_t *data1_out, uint16_t *data2_out );
 
void temphum24_enable_device ( temphum24_t *ctx );
 
void temphum24_disable_device ( temphum24_t *ctx );
 
void temphum24_reset_device ( temphum24_t *ctx );
 
uint8_t temphum24_get_alert_pin ( temphum24_t *ctx );
 
err_t temphum24_check_communication ( temphum24_t *ctx );
 
err_t temphum24_read_temp_and_rh ( temphum24_t *ctx, float *temp, float *hum );
 
err_t temphum24_read_temp_history ( temphum24_t *ctx, float *temp_min, float *temp_max );
 
err_t temphum24_read_rh_history ( temphum24_t *ctx, float *hum_min, float *hum_max );
 
err_t temphum24_start_measurement ( temphum24_t *ctx );
 
err_t temphum24_stop_measurement ( temphum24_t *ctx );
 
err_t temphum24_get_serial_number ( temphum24_t *ctx, uint16_t *serial_number );
 
#ifdef __cplusplus
}
#endif
#endif // TEMPHUM24_H
 
 // temphum24
 
// ------------------------------------------------------------------------ END