surfacetemp.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 SURFACETEMP_H
#define SURFACETEMP_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 SURFACETEMP_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
#define SURFACETEMP_RETVAL  uint8_t
 
#define SURFACETEMP_OK           0x00
#define SURFACETEMP_INIT_ERROR   0xFF
#define DEVICE_OK    0
#define DEVICE_ERROR 1
#define SURFACETEMP_SLAVE_DEVICE_ADDR_0_0   0x48
#define SURFACETEMP_SLAVE_DEVICE_ADDR_0_1   0x49
#define SURFACETEMP_SLAVE_DEVICE_ADDR_1_0   0x4A
#define SURFACETEMP_SLAVE_DEVICE_ADDR_1_1   0x4B
#define SURFACETEMP_REG_TEMP_MSB         0x00
#define SURFACETEMP_REG_TEMP_LSB         0x01
#define SURFACETEMP_REG_STATUS           0x02
#define SURFACETEMP_REG_CONFIG           0x03
#define SURFACETEMP_REG_T_HIGH_SETP_MSB  0x04
#define SURFACETEMP_REG_T_HIGH_SETP_LSB  0x05
#define SURFACETEMP_REG_T_LOW_SETP_MSB   0x06
#define SURFACETEMP_REG_T_LOW_SETP_LSB   0x07
#define SURFACETEMP_REG_T_CRIT_SETP_MSB  0x08
#define SURFACETEMP_REG_T_CRIT_SETP_LSB  0x09
#define SURFACETEMP_REG_T_HYST_SETP      0x0A
#define SURFACETEMP_REG_ID               0x0B
#define SURFACETEMP_REG_SOFT_RESET       0x2F
#define SURFACETEMP_T_LOW_MASK           0x10
#define SURFACETEMP_T_HIGH_MASK          0x20
#define SURFACETEMP_T_CRIT_MASK          0x40
#define SURFACETEMP_RDY_MASK             0x80
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    digital_out_t pwm;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} surfacetemp_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t pwm;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} surfacetemp_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void surfacetemp_cfg_setup ( surfacetemp_cfg_t *cfg );
 
SURFACETEMP_RETVAL surfacetemp_init ( surfacetemp_t *ctx, surfacetemp_cfg_t *cfg );
 
void surfacetemp_default_cfg ( surfacetemp_t *ctx );
 
void surfacetemp_generic_write ( surfacetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void surfacetemp_generic_read ( surfacetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t surfacetemp_get_pwm_pin ( surfacetemp_t *ctx );
 
void surfacetemp_soft_reset ( surfacetemp_t *ctx );
 
float surfacetemp_get_temperature ( surfacetemp_t *ctx );
 
uint8_t surfacetemp_get_status ( surfacetemp_t *ctx );
 
uint8_t surfacetemp_set_high_threshold ( surfacetemp_t *ctx, float high_threshold );
 
uint8_t surfacetemp_set_low_threshold ( surfacetemp_t *ctx, float high_threshold );
 
uint8_t surfacetemp_set_critical_threshold ( surfacetemp_t *ctx, float high_threshold );
 
uint8_t surfacetemp_set_hysteresis ( surfacetemp_t *ctx, uint8_t hysteresis );
 
uint8_t surfacetemp_setup ( surfacetemp_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _SURFACETEMP_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END