ketCube_hdcX080.h

Go to the documentation of this file.

 
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __KETCUBE_HDCX080_H
#define __KETCUBE_HDCX080_H
 
#include "ketCube_cfg.h"
#include "ketCube_common.h"
 
typedef enum {
    KETCUBE_HDCX080_TYPE_AUTODETECT = 0, 
    KETCUBE_HDCX080_TYPE_HDC1080    = 1, 
    KETCUBE_HDCX080_TYPE_HDC2080    = 2, 
} ketCube_hdcX080_sensType_t;
 
typedef struct ketCube_hdcX080_moduleCfg_t {
    ketCube_cfg_ModuleCfgByte_t coreCfg;           
    ketCube_hdcX080_sensType_t sensType;           
    uint8_t RFU[6];                                
} ketCube_hdcX080_moduleCfg_t;
 
extern ketCube_hdcX080_moduleCfg_t ketCube_hdcX080_moduleCfg;
 
/* ============================================ */
 
#define KETCUBE_HDCX080_I2C_TIMEOUT 0x1000      
/* ============================================ */
 
typedef enum {
    KETCUBE_HDCX080_HTR_ON = (uint8_t) 0x01,    
    KETCUBE_HDCX080_HTR_OFF = (uint8_t) 0x00    
} ketCube_hdcX080_Htr_t;
 
typedef enum {
    KETCUBE_HDCX080_RST_RESET = (uint8_t) 0x01, 
    KETCUBE_HDCX080_RST_NONE = (uint8_t) 0x00   
} ketCube_hdcX080_Rst_t;
 
typedef enum {
    KETCUBE_HDCX080_HRES_8BIT = (uint8_t) 0x02,         
    KETCUBE_HDCX080_HRES_11BIT = (uint8_t) 0x01,        
    KETCUBE_HDCX080_HRES_14BIT = (uint8_t) 0x00         
} ketCube_hdcX080_HRes_t;
 
/* ============================================ */
 
 
#define KETCUBE_HDC1080_I2C_ADDRESS  (uint8_t) (0x40 << 1)
 
typedef enum {
    KETCUBE_HDC1080_TEMPERATURE_REG      = 0x00,
    KETCUBE_HDC1080_HUMIDITY_REG         = 0x01,
    KETCUBE_HDC1080_CONFIGURATION_REG    = 0x02,
    KETCUBE_HDC1080_MANUFACTURER_ID_REG  = 0xFE,
    KETCUBE_HDC1080_DEVICE_ID_REG        = 0xFF,
    KETCUBE_HDC1080_SERIAL_ID_FIRST_REG  = 0xFB,
    KETCUBE_HDC1080_SERIAL_ID_MID_REG    = 0xFC,
    KETCUBE_HDC1080_SERIAL_ID_LAST_REG   = 0xFD
} ketCube_hdc1080_RegMap_t;
    
typedef enum {
    KETCUBE_HDC1080_TRES_11BIT = (uint8_t) 0x01,      
    KETCUBE_HDC1080_TRES_14BIT = (uint8_t) 0x00       
} ketCube_hdc1080_TRes_t;
 
typedef enum {
    KETCUBE_HDC1080_AQ_SEPARATE = (uint8_t) 0x00,       
    KETCUBE_HDC1080_AQ_SEQ = (uint8_t) 0x01     
} ketCube_hdc1080_Aq_t;
 
typedef enum {
    KETCUBE_HDC1080_BAT_HIGH = (uint8_t) 0x00,  
    KETCUBE_HDC1080_BAT_LOW = (uint8_t) 0x01    
} ketCube_hdc1080_Bat_t;
 
typedef enum {
    KETCUBE_HDC1080_PUSHPULL = (uint8_t) 0x00,  
    KETCUBE_HDC1080_OPENDRAIN = (uint8_t) 0x40  
} ketCube_hdc1080_OutputType_t;
 
#define IS_KETCUBE_HDC1080_OutputType(MODE) ((MODE == KETCUBE_HDC1080_PUSHPULL) || (MODE == KETCUBE_HDC1080_OPENDRAIN))
 
typedef enum {
    KETCUBE_HDC1080_HIGH_LVL = (uint8_t) 0x00,  
    KETCUBE_HDC1080_LOW_LVL = (uint8_t) 0x80    
} ketCube_hdc1080_DrdyLevel_t;
 
#define IS_KETCUBE_HDC1080_DrdyLevelType(MODE) ((MODE == KETCUBE_HDC1080_HIGH_LVL) || (MODE == KETCUBE_HDC1080_LOW_LVL))
 
 
 
#ifdef __ARMCC_VERSION
#pragma anon_unions
#endif
typedef struct {
    uint8_t rawData;
    struct {
        ketCube_hdcX080_HRes_t HumidityMeasurementResolution:2;
        ketCube_hdc1080_TRes_t TemperatureMeasurementResolution:1;
        ketCube_hdc1080_Bat_t BatteryStatus:1;  //< read-only field
        ketCube_hdc1080_Aq_t ModeOfAcquisition:1;
        ketCube_hdcX080_Htr_t Heater:1;
        uint8_t RFU:1;
        ketCube_hdcX080_Rst_t SoftwareReset:1;
    };
} ketCube_hdc1080_Init_t;
 
/* ============================================ */
 
#define KETCUBE_HDC2080_I2C_ADDRESS  (uint8_t) (0x40 << 1)
 
 
typedef enum {
    KETCUBE_HDC2080_TEMPERATURE_REG_L    = 0x00,
    KETCUBE_HDC2080_TEMPERATURE_REG_H    = 0x01,
    KETCUBE_HDC2080_HUMIDITY_REG_L       = 0x02,
    KETCUBE_HDC2080_HUMIDITY_REG_H       = 0x03,
    
    /* Registers UNUSED in this module */
    
    KETCUBE_HDC2080_CFG_REG              = 0x0E,
    KETCUBE_HDC2080_MEASCFG_REG          = 0x0F,
    
    /* Registers UNUSED in this module */
    
    KETCUBE_HDC2080_MANUFACTURER_ID_REG_L  = 0xFC,
    KETCUBE_HDC2080_MANUFACTURER_ID_REG_H  = 0xFD,
    KETCUBE_HDC2080_DEVICE_ID_REG_L        = 0xFE,
    KETCUBE_HDC2080_DEVICE_ID_REG_H        = 0xFF,
} ketCube_hdc2080_RegMap_t;
 
typedef enum {
    KETCUBE_HDC2080_TRES_9BIT = (uint8_t) 0x02,       
    KETCUBE_HDC2080_TRES_11BIT = (uint8_t) 0x01,      
    KETCUBE_HDC2080_TRES_14BIT = (uint8_t) 0x00       
} ketCube_hdc2080_TRes_t;
 
typedef enum {
    KETCUBE_HDC2080_AMM_DIS   = 0,    //< disabled
    KETCUBE_HDC2080_AMM_0_008 = 1,    //< 1/120 Hz
    KETCUBE_HDC2080_AMM_0_016 = 2,    //< 1/60 Hz
    KETCUBE_HDC2080_AMM_0_1   = 3,    //< 0.1 Hz
    KETCUBE_HDC2080_AMM_0_2   = 4,    //< 0.2 Hz
    KETCUBE_HDC2080_AMM_1_0   = 5,    //< 1 Hz
    KETCUBE_HDC2080_AMM_2_0   = 6,    //< 2 Hz
    KETCUBE_HDC2080_AMM_5_0   = 7,    //< 5 Hz
} ketCube_hdc2080_AMM_t;
 
typedef enum {
    KETCUBE_HDC2080_INTEN_HZ = (uint8_t) 0x0,    
    KETCUBE_HDC2080_INTEN_EN = (uint8_t) 0x1     
} ketCube_hdc2080_IntEn_t;
 
typedef enum {
    KETCUBE_HDC2080_INTPOL_LOW  = (uint8_t) 0x0,    
    KETCUBE_HDC2080_INTPOL_HIGH = (uint8_t) 0x1     
} ketCube_hdc2080_IntPol_t;
 
typedef enum {
    KETCUBE_HDC2080_INTPOL_LS  = (uint8_t) 0x0,    
    KETCUBE_HDC2080_INTPOL_CMP = (uint8_t) 0x1     
} ketCube_hdc2080_IntMode_t;
 
typedef enum {
    KETCUBE_HDC2080_MEASCFG_RHT  = (uint8_t) 0x0,    
    KETCUBE_HDC2080_MEASCFG_T    = (uint8_t) 0x1     
} ketCube_hdc2080_MeasCfg_t;
 
typedef enum {
    KETCUBE_HDC2080_MEASTRIG_NONE     = (uint8_t) 0x0,    
    KETCUBE_HDC2080_MEASTRIG_START    = (uint8_t) 0x1     
} ketCube_hdc2080_MeasTrig_t;
 
#ifdef __ARMCC_VERSION
#pragma anon_unions
#endif
typedef struct {
    struct {
        ketCube_hdc2080_IntMode_t IntMode:1;
        ketCube_hdc2080_IntPol_t IntPol:1;
        ketCube_hdc2080_IntEn_t IntEn:1;
        ketCube_hdcX080_Htr_t Heater:1;
        ketCube_hdc2080_AMM_t AutoMeasMode:3;
        ketCube_hdcX080_Rst_t SoftwareReset:1;
    };
    struct {
        ketCube_hdc2080_MeasTrig_t MeasTrig:1;
        ketCube_hdc2080_MeasCfg_t MeasCfg:2;
        uint8_t RFU:1;
        ketCube_hdcX080_HRes_t HumidityMeasurementResolution:2;
        ketCube_hdc2080_TRes_t TemperatureMeasurementResolution:2;
    };
} ketCube_hdc2080_Init_t;
 
extern ketCube_cfg_ModError_t ketCube_hdcX080_Init(ketCube_InterModMsg_t
                                                   *** msg);
extern ketCube_cfg_ModError_t ketCube_hdcX080_UnInit(void);
extern ketCube_cfg_ModError_t ketCube_hdcX080_ReadData(uint8_t * buffer,
                                                       uint8_t * len);
 
#endif                          /* __KETCUBE_HDCX080_H */