thermo18.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 THERMO18_H
#define THERMO18_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#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"
 
#define THERMO18_REG_DEVICE_ID                  0x1
#define THERMO18_REG_T_H_LIMIT                  0x2
#define THERMO18_REG_T_L_LIMIT                  0x3
#define THERMO18_REG_CTRL                       0x4
#define THERMO18_REG_STATUS                     0x5
#define THERMO18_REG_DATA_T_L                   0x6
#define THERMO18_REG_DATA_T_H                   0x7
#define THERMO18_REG_SOFT_RESET                 0xC
 
 // thermo18_reg
 
#define THERMO18_CONTROL_ONESHOT_ENABLED        0x01
#define THERMO18_CONTROL_CONTINOUS_ENABLED      0x04
 
#define THERMO18_STATUS_DATA_READY              0x00
#define THERMO18_STATUS_DATA_BUSY               0x01
#define THERMO18_STATUS_OVERTEMPERATURE         0x02
#define THERMO18_STATUS_UNDERTEMPERATURE        0x04
 
#define THERMO18_DEVICE_ID                      0xA0
 
#define THERMO18_SET_DEV_ADDR                   0x3F
 
 // thermo18_set
 
#define THERMO18_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // thermo18_map
 // thermo18
 
typedef struct
{
    // Input pins
    digital_in_t  int_pin;  
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
} thermo18_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  int_pin;    
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} thermo18_cfg_t;
 
typedef enum
{
   THERMO18_OK = 0,
   THERMO18_ERROR = -1
 
} thermo18_return_value_t;
 
void thermo18_cfg_setup ( thermo18_cfg_t *cfg );
 
err_t thermo18_init ( thermo18_t *ctx, thermo18_cfg_t *cfg );
 
err_t thermo18_default_cfg ( thermo18_t *ctx );
 
err_t thermo18_generic_write ( thermo18_t *ctx, uint8_t reg, uint8_t tx_data ) ;
 
err_t thermo18_generic_read ( thermo18_t *ctx, uint8_t reg, uint8_t *rx_data );
 
err_t thermo18_read_temperature ( thermo18_t *ctx, float *temperature );
 
err_t thermo18_reset ( thermo18_t *ctx );
 
uint8_t thermo18_get_interrupt ( thermo18_t *ctx );
 
err_t thermo18_set_temperature_threshold ( thermo18_t *ctx, uint8_t threshold_reg, float threshold_limit );
 
#ifdef __cplusplus
}
#endif
#endif // THERMO18_H
 
 // thermo18
 
// ------------------------------------------------------------------------ END