thermo28.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 THERMO28_H
#define THERMO28_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_in.h"
#include "drv_i2c_master.h"
 
#define THERMO28_REG_TVAL                  0x00
#define THERMO28_REG_CONFIG                0x01
#define THERMO28_REG_TLOW                  0x02
#define THERMO28_REG_THIGH                 0x03
 
 // thermo28_reg
 
#define THERMO28_CFG_DEFAULT_CONFIG        0x40A0
#define THERMO28_CFG_SINGLE_SHOT           0x8000
#define THERMO28_CONV_RATE_BIT_MASK        0x00C0
#define THERMO28_STATE_BIT_MASK            0x0100
#define THERMO28_CONSEC_FAULTS_BIT_MASK    0x3000
#define THERMO28_ALERT_BIT_MASK            0x0200
#define THERMO28_SINGLE_SHOT_BIT_MASK      0x8000
 
#define THERMO28_DEVICE_ADDRESS_VSS        0x48
#define THERMO28_DEVICE_ADDRESS_VDD        0x49
#define THERMO28_DEVICE_ADDRESS_SDA        0x4A
#define THERMO28_DEVICE_ADDRESS_SCL        0x4B
 
 // thermo28_set
 
#define THERMO28_MAP_MIKROBUS( cfg, mikrobus )    \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // thermo28_map
 // thermo28
 
typedef enum
{
    THERMO28_OK     = 0,
    THERMO28_ERROR = -1
 
} thermo28_return_value_t;
 
typedef enum
{
    THERMO28_CONV_RATE025 = 0x0000,
    THERMO28_CONV_RATE1   = 0x0040,
    THERMO28_CONV_RATE4   = 0x0080,
    THERMO28_CONV_RATE8   = 0x00C0
 
} thermo28_conv_rate_t;
 
typedef enum
{
    THERMO28_STATE_SLEEP  = 0x0100,
    THERMO28_STATE_ACTIVE = 0x0000
 
} thermo28_device_mode_t;
 
typedef enum
{
    THERMO28_ALERT_INTERRUPT  = 0x0200,
    THERMO28_ALERT_COMPARATOR = 0x0000
 
} thermo28_alert_mode_t;
 
 
typedef enum
{
    THERMO28_ALERT_ACTIVE_LOW  = 0x0000,
    THERMO28_ALERT_ACTIVE_HIGH = 0x0400
 
} thermo28_alert_polarity_t;
 
typedef enum
{
    THERMO28_CONSEC_FAULTS1 = 0x0000,
    THERMO28_CONSEC_FAULTS2 = 0x1000,
    THERMO28_CONSEC_FAULTS3 = 0x2000,
    THERMO28_CONSEC_FAULTS4 = 0x3000
 
} thermo28_consec_faults_t;
 
typedef enum
{
    THERMO28_SINGLE_SHOT_NO_CONVERSION    = 0x0000,
    THERMO28_SINGLE_SHOT_START_CONVERSION = 0x8000
 
} thermo28_single_shot_t;
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;    
    // Modules
    i2c_master_t i2c;        
    // I2C slave address
    uint8_t slave_address;   
} thermo28_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t int_pin;         
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} thermo28_cfg_t;
 
typedef struct
{
    thermo28_conv_rate_t conv_rate;
    thermo28_device_mode_t device_mode;
    thermo28_alert_mode_t alert_mode;
    thermo28_alert_polarity_t alert_polarity;
    thermo28_consec_faults_t consecutive_faults;
    thermo28_single_shot_t single_shot;
 
} thermo28_config_t;
 
void thermo28_cfg_setup ( thermo28_cfg_t *cfg );
 
err_t thermo28_init ( thermo28_t *ctx, thermo28_cfg_t *cfg );
 
err_t thermo28_default_cfg ( thermo28_t *ctx );
 
err_t thermo28_generic_write ( thermo28_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t thermo28_generic_read ( thermo28_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t thermo28_get_temperature ( thermo28_t *ctx, float *temperature );
 
err_t thermo28_set_alert_limits ( thermo28_t *ctx, float alert_min, float alert_max );
 
err_t thermo28_set_config ( thermo28_t *ctx, thermo28_config_t config );
 
err_t thermo28_set_continuous_conversion ( thermo28_t *ctx );
 
err_t thermo28_set_sleep_mode ( thermo28_t *ctx );
 
err_t thermo28_set_trigger_single_shot ( thermo28_t *ctx );
 
uint8_t thermo28_get_int_pin ( thermo28_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // THERMO28_H
 
 // thermo28
 
// ------------------------------------------------------------------------ END