temphum21.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 TEMPHUM21_H
#define TEMPHUM21_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 TEMPHUM21_REG_ALARM_HIGH_ON         0x18
#define TEMPHUM21_REG_ALARM_HIGH_OFF        0x19
#define TEMPHUM21_REG_ALARM_LOW_ON          0x1A
#define TEMPHUM21_REG_ALARM_LOW_OFF         0x1B
#define TEMPHUM21_REG_CUST_CONFIG           0x1C
#define TEMPHUM21_REG_CUST_ID2              0x1E
#define TEMPHUM21_REG_CUST_ID3              0x1F
#define TEMPHUM21_CMD_WRITE_EEPROM          0x40
#define TEMPHUM21_CMD_START_NOM             0x80
#define TEMPHUM21_CMD_START_CM              0xA0
 
 // temphum21_reg
 
#define TEMPHUM21_STATUS_NORMAL_OP          0x00
#define TEMPHUM21_STATUS_STALE_DATA         0x40
#define TEMPHUM21_STATUS_COMMAND_MODE       0x80
#define TEMPHUM21_STATUS_BIT_MASK           0xC0
#define TEMPHUM21_DIAGNOSTIC_CORR_EP_ERR    0x04
#define TEMPHUM21_DIAGNOSTIC_UNCORR_EP_ERR  0x08
#define TEMPHUM21_DIAGNOSTIC_RAM_PAR_ERR    0x10
#define TEMPHUM21_DIAGNOSTIC_CONFIG_ERR     0x20
#define TEMPHUM21_DIAGNOSTIC_BIT_MASK       0x3C
#define TEMPHUM21_RESPONSE_BUSY             0x00
#define TEMPHUM21_RESPONSE_ACK              0x01
#define TEMPHUM21_RESPONSE_NACK             0x02
#define TEMPHUM21_RESPONSE_BIT_MASK         0x03
 
#define TEMPHUM21_DATA_RES                  0x3FFF
#define TEMPHUM21_TEMP_RES                  165.0
#define TEMPHUM21_TEMP_OFFSET               40.0
#define TEMPHUM21_HUM_RES                   100.0
 
#define TEMPHUM21_ALARM_HIGH_ON_80PCT       0x3333
#define TEMPHUM21_ALARM_HIGH_OFF_75PCT      0x3000
#define TEMPHUM21_ALARM_LOW_ON_20PCT        0x0CCD
#define TEMPHUM21_ALARM_LOW_OFF_25PCT       0x1000
 
#define TEMPHUM21_SET_DEV_ADDR              0x27
 
 // temphum21_set
 
#define TEMPHUM21_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.all = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.alh = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // temphum21_map
 // temphum21
 
typedef struct
{
    // Output pins
    digital_out_t en;           
    // Input pins
    digital_in_t all;           
    digital_in_t alh;           
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} temphum21_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t en;              
    pin_name_t all;             
    pin_name_t alh;             
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} temphum21_cfg_t;
 
typedef enum
{
    TEMPHUM21_OK = 0,
    TEMPHUM21_ERROR = -1
 
} temphum21_return_value_t;
 
void temphum21_cfg_setup ( temphum21_cfg_t *cfg );
 
err_t temphum21_init ( temphum21_t *ctx, temphum21_cfg_t *cfg );
 
err_t temphum21_default_cfg ( temphum21_t *ctx );
 
err_t temphum21_request_measurement ( temphum21_t *ctx );
 
err_t temphum21_read_measurement ( temphum21_t *ctx, float *temperature, float *humidity );
 
uint8_t temphum21_get_all_pin ( temphum21_t *ctx );
 
uint8_t temphum21_get_alh_pin ( temphum21_t *ctx );
 
void temphum21_enable_device ( temphum21_t *ctx );
 
void temphum21_disable_device ( temphum21_t *ctx );
 
err_t temphum21_enter_command_mode ( temphum21_t *ctx );
 
err_t temphum21_exit_command_mode ( temphum21_t *ctx );
 
err_t temphum21_eeprom_read ( temphum21_t *ctx, uint8_t address, uint8_t *status, uint16_t *data_out );
 
err_t temphum21_eeprom_write ( temphum21_t *ctx, uint8_t address, uint16_t data_in );
 
#ifdef __cplusplus
}
#endif
#endif // TEMPHUM21_H
 
 // temphum21
 
// ------------------------------------------------------------------------ END