temphum6.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 TEMPHUM6_H
#define TEMPHUM6_H
 
#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"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define TEMPHUM6_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl= MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda= MIKROBUS( mikrobus, MIKROBUS_SDA )
#define TEMPHUM6_RETVAL  uint8_t
 
#define TEMPHUM6_OK           0x00
#define TEMPHUM6_INIT_ERROR   0xFF
#define TEMPHUM6_PART_ID                   0x0210
#define TEMPHUM6_DEVICE_SLAVE_ADDRESS      0x43
#define TEMPHUM6_REG_PART_ID               0x00
#define TEMPHUM6_REG_UNIQUE_IDENTIFIER     0x04
#define TEMPHUM6_REG_SYSTEM_CONTROL        0x10
#define TEMPHUM6_REG_SYSTEM_STATUS         0x11
#define TEMPHUM6_REG_SENS_RUN              0x21
#define TEMPHUM6_REG_SENS_START            0x22
#define TEMPHUM6_REG_SENS_STOP             0x23
#define TEMPHUM6_REG_SENS_STATUS           0x24
#define TEMPHUM6_REG_TEMPERATURE           0x30
#define TEMPHUM6_REG_RELATIVE_HUMIDITY     0x33
#define TEMPHUM6_STATUS_I2C_ERROR      4
#define TEMPHUM6_STATUS_CRC_ERROR      3
#define TEMPHUM6_STATUS_INVALID        2
#define TEMPHUM6_STATUS_OK             1
#define TEMPHUM6_TEMP_IN_FAHRENHEIT    2
#define TEMPHUM6_TEMP_IN_KELVIN        1
#define TEMPHUM6_TEMP_IN_CELSIUS       0
#define TEMPHUM6_LOW_POWER_DISABLE     0x00
#define TEMPHUM6_LOW_POWER_ENABLE      0x01
#define TEMPHUM6_SYSTEM_IS_IN_STANDBY_OR_BOOTING_STATE     0
#define TEMPHUM6_SYSTEM_IS_IN_ACTIVE_STATE                 1
#define TEMPHUM6_HUM_RUN_SINGLE_SHOT_MODE     0x00
#define TEMPHUM6_TEMP_RUN_SINGLE_SHOT_MODE    0x00
#define TEMPHUM6_HUM_RUN_CONTINUOUS_MODE      0x02
#define TEMPHUM6_TEMP_RUN_CONTINUOUS_MODE     0x01
#define TEMPHUM6_HUM_START_MEASUREMENT        0x02
#define TEMPHUM6_TEMP_START_MEASUREMENT       0x01
#define TEMPHUM6_DISABLE_MEASUREMENT          0x00
#define TEMPHUM6_HUM_STOP_CONTINUOUS_MEASUREMENT     0x02
#define TEMPHUM6_TEMP_STOP_CONTINUOUS_MEASUREMENT    0x01
#define TEMPHUM6_DISABLE_CONTINUOUS_MEASUREMENT      0x00
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{   
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} temphum6_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} temphum6_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void temphum6_cfg_setup ( temphum6_cfg_t *cfg );
 
TEMPHUM6_RETVAL temphum6_init ( temphum6_t *ctx, temphum6_cfg_t *cfg );
 
void temphum6_generic_write ( temphum6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void temphum6_generic_read ( temphum6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void temphum6_reset ( temphum6_t *ctx );
 
uint16_t temphum6_get_part_id ( temphum6_t *ctx );
 
void temphum6_run ( temphum6_t *ctx );
 
float temphum6_read_temperature ( temphum6_t *ctx, uint8_t temp_in );
 
float temphum6_read_relative_huminidy( temphum6_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _TEMPHUM6_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END