temphum7.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 TEMPHUM7_H
#define TEMPHUM7_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 TEMPHUM7_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS ( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS ( mikrobus, MIKROBUS_SDA ) 
#define TEMPHUM7_RETVAL  uint8_t
 
#define TEMPHUM7_OK           0x00
#define TEMPHUM7_INIT_ERROR   0xFF
#define TEMPHUM7_DEVICE_ADDRESS                     0x40
#define TEMPHUM7_HOLD_MASTER_MODE                   0x00
#define TEMPHUM7_NOHOLD_MASTER_MODE                 0x01
#define TEMPHUM7_DATA_FROM_PREVIOUS_RH_MEASUREMENT  0x02
#define TEMPHUM7_RESET                              0xFE
#define TEMPHUM7_WRITE_RHT_USER_REGISTER_1          0xE6
#define TEMPHUM7_READ_RHT_USER_REGISTER_1           0xE7
#define TEMPHUM7_WRITE_HEATER_CONTROL_REGISTER      0x51
#define TEMPHUM7_READ_HEATER_CONTROL_REGISTER       0x11
#define TEMPHUM7_RESOLUTION_12_BIT                  0x00
#define TEMPHUM7_RESOLUTION_8_BIT                   0x01
#define TEMPHUM7_RESOLUTION_10_BIT                  0x80
#define TEMPHUM7_RESOLUTION_11_BIT                  0x81
#define TEMPHUM7_HEATER_ENABLE                      0x04
#define TEMPHUM7_HEATER_DISABLE                     0x00
#define TEMPHUM7_HEATER_CURRENT_3p09               0x00
#define TEMPHUM7_HEATER_CURRENT_9p17               0x01
#define TEMPHUM7_HEATER_CURRENT_15p24              0x02
#define TEMPHUM7_HEATER_CURRENT_21p31              0x03
#define TEMPHUM7_HEATER_CURRENT_27p39              0x04
#define TEMPHUM7_HEATER_CURRENT_33p46              0x05
#define TEMPHUM7_HEATER_CURRENT_39p53              0x06
#define TEMPHUM7_HEATER_CURRENT_45p61              0x07
#define TEMPHUM7_HEATER_CURRENT_51p68              0x08
#define TEMPHUM7_HEATER_CURRENT_57p76              0x09
#define TEMPHUM7_HEATER_CURRENT_63p83              0x0A
#define TEMPHUM7_HEATER_CURRENT_69p90              0x0B
#define TEMPHUM7_HEATER_CURRENT_75p98              0x0C
#define TEMPHUM7_HEATER_CURRENT_82p05              0x0D
#define TEMPHUM7_HEATER_CURRENT_88p13              0x0E
#define TEMPHUM7_HEATER_CURRENT_94p20              0x0F
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{  
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} temphum7_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} temphum7_cfg_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void temphum7_cfg_setup ( temphum7_cfg_t *cfg );
 
TEMPHUM7_RETVAL temphum7_init ( temphum7_t *ctx, temphum7_cfg_t *cfg );
 
void temphum7_default_cfg ( temphum7_t *ctx );
 
void temphum7_generic_write ( temphum7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void temphum7_generic_read ( temphum7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
float temphum7_get_relative_humidity ( temphum7_t *ctx, uint8_t mode_data );
 
float temphum7_get_temperature ( temphum7_t *ctx, uint8_t mode_data );
 
void temphum7_get_electronic_serial_number ( temphum7_t *ctx, uint8_t *esn_buffer );
 
uint8_t temphum7_get_firmware_revision ( temphum7_t *ctx );
 
float temphum7_get_heater_current ( temphum7_t *ctx );
 
void temphum7_reset ( temphum7_t *ctx );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _TEMPHUM7_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END