surfacetemp2.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 SURFACETEMP2_H
#define SURFACETEMP2_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 SURFACETEMP2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define SURFACETEMP2_RETVAL  uint8_t
 
#define SURFACETEMP2_OK           0x00
#define SURFACETEMP2_INIT_ERROR   0xFF
#define SURFACETEMP2_I2C_DEV_ADR_0_0      0x48
#define SURFACETEMP2_I2C_DEV_ADR_0_1      0x49
#define SURFACETEMP2_I2C_DEV_ADR_1_0      0x4A
#define SURFACETEMP2_I2C_DEV_ADR_1_1      0x4B
#define SURFACETEMP2_REG_TEMP_MSB         0x00
#define SURFACETEMP2_REG_TEMP_LSB         0x01
#define SURFACETEMP2_REG_STAT             0x02
#define SURFACETEMP2_REG_CFG              0x03
#define SURFACETEMP2_REG_T_HIGH_SETP_MSB  0x04
#define SURFACETEMP2_REG_T_HIGH_SETP_LSB  0x05
#define SURFACETEMP2_REG_T_LOW_SETP_MSB   0x06
#define SURFACETEMP2_REG_T_LOW_SETP_LSB   0x07
#define SURFACETEMP2_REG_T_CRIT_SETP_MSB  0x08
#define SURFACETEMP2_REG_T_CRIT_SETP_LSB  0x09
#define SURFACETEMP2_REG_T_HYST_SETP      0x0A
#define SURFACETEMP2_REG_ID               0x0B
#define SURFACETEMP2_REG_SOFT_RESET       0x2F
#define SURFACETEMP2_STAT_T_LOW_MSK       0x10
#define SURFACETEMP2_STAT_T_HIGH_MSK      0x20
#define SURFACETEMP2_STAT_T_CRIT_MSK      0x40
#define SURFACETEMP2_STAT_RDY_MSK         0x80
#define SURFACETEMP2_CFG_FLT_Q_1          0x00
#define SURFACETEMP2_CFG_FLT_Q_2          0x01
#define SURFACETEMP2_CFG_FLT_Q_3          0x02
#define SURFACETEMP2_CFG_FLT_Q_4          0x03
#define SURFACETEMP2_CFG_CT_POL_ACT_H     0x04
#define SURFACETEMP2_CFG_CT_POL_ACT_L     0x00
#define SURFACETEMP2_CFG_INT_POL_ACT_H    0x08
#define SURFACETEMP2_CFG_INT_POL_ACT_L    0x00
#define SURFACETEMP2_CFG_INT_MODE         0x00
#define SURFACETEMP2_CFG_CT_MODE          0x10
#define SURFACETEMP2_CFG_OP_MODE_CONT     0x00
#define SURFACETEMP2_CFG_OP_MODE_ONE_SHT  0x20
#define SURFACETEMP2_CFG_OP_MODE_SPS      0x40
#define SURFACETEMP2_CFG_OP_MODE_SHDN     0x60
#define SURFACETEMP2_CFG_RES_13           0x00
#define SURFACETEMP2_CFG_RES_16           0x80
#define SURFACETEMP2_RES_13_BIT             0.0625
#define SURFACETEMP2_RES_16_BIT             0.0078125
#define SURFACETEMP2_DEV_ID_VAL           0xCB
#define SURFACETEMP2_DEV_OK               0x00
#define SURFACETEMP2_DEV_NOK              0x01
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
 
    digital_in_t pwm;
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} surfacetemp2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t pwm;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} surfacetemp2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void surfacetemp2_cfg_setup ( surfacetemp2_cfg_t *cfg );
 
SURFACETEMP2_RETVAL surfacetemp2_init ( surfacetemp2_t *ctx, surfacetemp2_cfg_t *cfg );
 
void surfacetemp2_generic_write ( surfacetemp2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void surfacetemp2_generic_read ( surfacetemp2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void surfacetemp2_soft_reset ( surfacetemp2_t *ctx );
 
uint8_t surfacetemp2_setup ( surfacetemp2_t *ctx, uint8_t setup );
 
void surfacetemp2_set_hys_val ( surfacetemp2_t *ctx, uint8_t hys_val );
 
float surfacetemp2_get_temperature ( surfacetemp2_t *ctx );
 
void surfacetemp2_set_high_trsh ( surfacetemp2_t *ctx, float trsh );
 
void surfacetemp2_set_low_trsh ( surfacetemp2_t *ctx, float trsh );
 
void surfacetemp2_set_crit_trsh ( surfacetemp2_t *ctx, float trsh );
 
uint8_t surfacetemp2_get_int_pin ( surfacetemp2_t *ctx );
 
uint8_t surfacetemp2_get_ct_pin ( surfacetemp2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _SURFACETEMP2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END