thermo22.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 THERMO22_H
#define THERMO22_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 THERMO22_REG_TEMPERATURE            0x00
#define THERMO22_REG_CONFIGURATION          0x01
#define THERMO22_REG_TEMPERATURE_LOW        0x02
#define THERMO22_REG_TEMPERATURE_HIGH       0x03
#define THERMO22_REG_ONE_SHOT               0x04
 
 // thermo22_reg
 
#define THERMO22_CONFIG_ONESHOT_DIS         0x00
#define THERMO22_CONFIG_ONESHOT_EN          0x20
#define THERMO22_CONFIG_FAULT_QUEUE_1       0x00
#define THERMO22_CONFIG_FAULT_QUEUE_2       0x08
#define THERMO22_CONFIG_FAULT_QUEUE_4       0x10
#define THERMO22_CONFIG_FAULT_QUEUE_6       0x18
#define THERMO22_CONFIG_ALERT_ACTIVE_LOW    0x00
#define THERMO22_CONFIG_ALERT_ACTIVE_HIGH   0x04
#define THERMO22_CONFIG_ALERT_COMPARATOR    0x00
#define THERMO22_CONFIG_ALERT_INTERRUPT     0x02
#define THERMO22_CONFIG_SHUTDOWN_DIS        0x00
#define THERMO22_CONFIG_SHUTDOWN_EN         0x01
 
#define THERMO22_TEMPERATURE_RESOLUTION     0.0625
#define THERMO22_TEMPERATURE_MAX            128.0
#define THERMO22_TEMPERATURE_MIN            -128.0
#define THERMO22_TEMPERATURE_ALERT_LIMIT    35.0
 
#define THERMO22_DEV_ADDR_A2A1A0_000        0x48
#define THERMO22_DEV_ADDR_A2A1A0_001        0x49
#define THERMO22_DEV_ADDR_A2A1A0_010        0x4A
#define THERMO22_DEV_ADDR_A2A1A0_011        0x4B
#define THERMO22_DEV_ADDR_A2A1A0_100        0x4C
#define THERMO22_DEV_ADDR_A2A1A0_101        0x4D
#define THERMO22_DEV_ADDR_A2A1A0_110        0x4E
#define THERMO22_DEV_ADDR_A2A1A0_111        0x4F
 
 // thermo22_set
 
#define THERMO22_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // thermo22_map
 // thermo22
 
typedef struct
{
    // Input pins
    digital_in_t  int_pin;      
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} thermo22_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  int_pin;        
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} thermo22_cfg_t;
 
typedef enum
{
    THERMO22_OK = 0,
    THERMO22_ERROR = -1
 
} thermo22_return_value_t;
 
void thermo22_cfg_setup ( thermo22_cfg_t *cfg );
 
err_t thermo22_init ( thermo22_t *ctx, thermo22_cfg_t *cfg );
 
err_t thermo22_default_cfg ( thermo22_t *ctx );
 
err_t thermo22_write_config ( thermo22_t *ctx, uint8_t config );
 
err_t thermo22_read_config ( thermo22_t *ctx, uint8_t *config );
 
err_t thermo22_read_temperature ( thermo22_t *ctx, float *temperature );
 
err_t thermo22_set_temperature_low_limit ( thermo22_t *ctx, float low_limit );
 
err_t thermo22_set_temperature_high_limit ( thermo22_t *ctx, float high_limit );
 
uint8_t thermo22_get_int_pin ( thermo22_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // THERMO22_H
 
 // thermo22
 
// ------------------------------------------------------------------------ END