temphum10.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 TEMPHUM10_H
#define TEMPHUM10_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_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define TEMPHUM10_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ) 
 
#define TEMPHUM10_RETVAL  uint8_t
 
#define TEMPHUM10_OK           0x00
#define TEMPHUM10_INIT_ERROR   0xFF
#define TEMPHUM10_REG_DEVICE_RESET        0x00
#define TEMPHUM10_REG_AVERAGE_MODE        0x01
#define TEMPHUM10_REG_ERROR_FLAG          0x03
#define TEMPHUM10_REG_HUMIDITY_LSB        0x04
#define TEMPHUM10_REG_HUMIDITY_MSB        0x05
#define TEMPHUM10_REG_TEMPERATURE_LSB     0x06
#define TEMPHUM10_REG_TEMPERATURE_MSB     0x07
#define TEMPHUM10_REG_CAPACITY_LSB        0x0A
#define TEMPHUM10_REG_CAPACITY_MSB        0x0B
#define TEMPHUM10_REG_CAPACITY_CTRL       0x2C
#define TEMPHUM10_MODE_SLEEP     0x00
#define TEMPHUM10_MODE_STANDBY   0x01
#define TEMPHUM10_RST_NORMAL_OPERATION  0x00
#define TEMPHUM10_RST_ACTIVE_RESET      0x01
#define TEMPHUM10_AM_NO_AVERAGING_PROCESS              0x00
#define TEMPHUM10_AM_TIMES_AVERAGE_MODE_2              0x08
#define TEMPHUM10_AM_TIMES_AVERAGE_MODE_4              0x10
#define TEMPHUM10_AM_TIMES_AVERAGE_MODE_8              0x20
#define TEMPHUM10_AM_TEMP_AVERAGE_MODE_TIMES_8         0x00
#define TEMPHUM10_AM_TEMP_AVERAGE_MODE_TIMES_16        0x04
#define TEMPHUM10_AM_MANUAL_MODE_DETECTION_OP_STOP     0x00
#define TEMPHUM10_AM_MANUAL_MODE_DETECTION_OP_START    0x01
#define TEMPHUM10_ERR_NO_ERROR             0x00
#define TEMPHUM10_ERR_ERROR_FLAG_RESET     0x01
#define TEMPHUM10_CAP_OUTSIDE_CAPACITY_CUTTING     0x00
#define TEMPHUM10_CAP_OUTSIDE_CAPACITY_CONNECTION  0x10
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t cs;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} temphum10_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t cs;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} temphum10_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void temphum10_cfg_setup ( temphum10_cfg_t *cfg );
 
TEMPHUM10_RETVAL temphum10_init ( temphum10_t *ctx, temphum10_cfg_t *cfg );
 
void temphum10_generic_write ( temphum10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void temphum10_generic_read ( temphum10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
float temphum10_get_humidity ( temphum10_t *ctx );
 
float temphum10_get_temperature ( temphum10_t *ctx );
 
void temphum10_set_device_mode ( temphum10_t *ctx, uint8_t mode );
 
void temphum10_repeat_measurement ( temphum10_t *ctx, uint8_t average );
 
#ifdef __cplusplus
}
#endif
#endif  // _TEMPHUM10_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END