temphum4.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 TEMPHUM4_H
#define TEMPHUM4_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 TEMPHUM4_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.ad0 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.ad1 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define TEMPHUM4_RETVAL  uint8_t
 
#define TEMPHUM4_OK           0x00
#define TEMPHUM4_INIT_ERROR   0xFF
#define TEMPHUM4_MODE_ACTIVE    0x01 
#define TEMPHUM4_MODE_SLEEP     0x00 
#define TEMPHUM4_REG_TEMPERATURE       0x00 
#define TEMPHUM4_REG_HUMINIDY          0x01 
#define TEMPHUM4_REG_CONFIGURATION     0x02 
#define TEMPHUM4_REG_MANUFACTURER_ID   0xFE 
#define TEMPHUM4_REG_DEVICE_ID         0xFF 
#define TEMPHUM4_REG_SERIAL_ID         0xFB 
#define TEMPHUM4_CONF_NORMAL_OPERATION         ( 0x00 << 14 )
#define TEMPHUM4_CONF_SOFT_RESET               ( 0x01 << 14 )
#define TEMPHUM4_CONF_HEATER_DISABLED          ( 0x00 << 12 )
#define TEMPHUM4_CONF_HEATER_ENABLED           ( 0x01 << 12 )
#define TEMPHUM4_CONF_MODE_TEMP_OR_HUM         ( 0x00 << 11 )
#define TEMPHUM4_CONF_MODE_TEMP_AND_HUM        ( 0x01 << 11 )
#define TEMPHUM4_CONF_BATTERY_VOLTAGE_2_8_V    ( 0x00 << 10 )
#define TEMPHUM4_CONF_TEMPERATURE_14bit        ( 0x00 << 9  )
#define TEMPHUM4_CONF_TEMPERATURE_11bit        ( 0x01 << 9  )
#define TEMPHUM4_CONF_HUMINIDY_14bit           ( 0x00 << 7  )
#define TEMPHUM4_CONF_HUMINIDY_11bit           ( 0x01 << 7  )
#define TEMPHUM4_CONF_HUMINIDY_9bit            ( 0x02 << 7  )
#define TEMPHUM4_MANUFACTURER_ID                0x5449
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t ad0;
    digital_out_t ad1;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} temphum4_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t ad0;
    pin_name_t ad1;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} temphum4_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void temphum4_cfg_setup ( temphum4_cfg_t *cfg );
 
TEMPHUM4_RETVAL temphum4_init ( temphum4_t *ctx, temphum4_cfg_t *cfg );
 
void temphum4_default_cfg ( temphum4_t *ctx );
 
void temphum4_generic_write ( temphum4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void temphum4_generic_read ( temphum4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void temphum4_set_mode ( temphum4_t *ctx, uint8_t value );
 
uint16_t temphum4_get_manifacturer_id ( temphum4_t *ctx );
 
uint16_t temphum4_get_device_id ( temphum4_t *ctx );
 
void temphum4_configuration( temphum4_t *ctx, uint16_t conf_data);
   
float temphum4_get_temperature ( temphum4_t *ctx );
 
float temphum4_get_humidity ( temphum4_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _TEMPHUM4_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END