temphum2.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 TEMPHUM2_H
#define TEMPHUM2_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 TEMPHUM2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define TEMPHUM2_RETVAL  uint8_t
 
#define TEMPHUM2_OK           0x00
#define TEMPHUM2_INIT_ERROR   0xFF
#define TEMPHUM2_REG_FIRMWARE_REVISION        0x84F1
#define TEMPHUM2_REG_ELECTRONIC_ID_1          0xFA0F
#define TEMPHUM2_REG_ELECTRONIC_ID_2          0xFCC9
#define TEMPHUM2_REG_SOFT_RESET                 0xFE
#define TEMPHUM2_REG_TEMPHUM_HM_NORMAL_MODE   0x7CA2
#define TEMPHUM2_REG_TEMPHUM_NHM_NORMAL_MODE  0x7866
#define TEMPHUM2_REG_TEMPHUM_HM_FAST_MODE     0x6458
#define TEMPHUM2_REG_TEMPHUM_NHM_FAST_MODE    0x609C
#define TEMPHUM2_REG_QUERY_DEVICE_RESP        0xEFC8
#define TEMPHUM2_REG_QUERY_DEVICE_RESP1       0x805D
#define TEMPHUM2_REG_WRITE_HEATER_CONTROL       0xE6
#define TEMPHUM2_REG_READ_HEATER_CONTROL        0xE7
#define QUERY_DEVICE_ERROR  1
#define QUERY_DEVICE_OK     0
#define TEMPHUM2_HEATER_ENABLE           0x10
#define TEMPHUM2_HEATER_DISABLE          0x00
#define TEMPHUM2_HEATER_CURRENT_6_4mA    0x00
#define TEMPHUM2_HEATER_CURRENT_9_7mA    0x01
#define TEMPHUM2_HEATER_CURRENT_13_1mA   0x02
#define TEMPHUM2_HEATER_CURRENT_19_6mA   0x04
#define TEMPHUM2_HEATER_CURRENT_32_4mA   0x08
#define TEMPHUM2_HEATER_CURRENT_53_5mA   0x0F
#define TEMPHUM2_NO_HOLD_MODE  0x01
#define TEMPHUM2_HOLD_MODE     0x02
#define TEMPHUM2_NORMAL_MODE   0x01
#define TEMPHUM2_FAST_MODE     0x01
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} temphum2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} temphum2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void temphum2_cfg_setup ( temphum2_cfg_t *cfg );
 
TEMPHUM2_RETVAL temphum2_init ( temphum2_t *ctx, temphum2_cfg_t *cfg );
 
void temphum2_default_cfg ( temphum2_t *ctx );
 
void temphum2_generic_write ( temphum2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void temphum2_generic_read ( temphum2_t *ctx, uint8_t *tx_buf, uint8_t *data_buf, uint8_t len );
 
uint8_t temphum2_read_firmware_revision ( temphum2_t *ctx );
 
void temhum2_get_eletronic_id ( temphum2_t *ctx, uint8_t *electronic_id );
 
uint8_t temphum2_get_query_device ( temphum2_t *ctx );
 
void temphum2_set_mode ( uint8_t select_mode, uint8_t speed_mode );
 
void temphum2_get_measurement ( temphum2_t *ctx, float *data_buffer );
 
#ifdef __cplusplus
}
#endif
#endif  // _TEMPHUM2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END