thermo11.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 THERMO11_H
#define THERMO11_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 THERMO11_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT ); 
#define THERMO11_RETVAL  uint8_t
 
#define THERMO11_OK           0x00
#define THERMO11_INIT_ERROR   0xFF
#define THERMO11_DEV_ADDR                                 0x48
#define THERMO11_TEMPERATURE_REG                          0x00
#define THERMO11_CONFIG_REG                               0x01
#define THERMO11_HIGH_LIMIT_REG                           0x02
#define THERMO11_LOW_LIMIT_REG                            0x03
#define THERMO11_EEPROM_UNLOCK_REG                        0x04
#define THERMO11_EEPROM1_REG                              0x05
#define THERMO11_EEPROM2_REG                              0x06
#define THERMO11_TEMP_OFFSET_REG                          0x07
#define THERMO11_EEPROM3_REG                              0x08
#define THERMO11_DEV_ID_REG                               0x0F
#define  THERMO11_CONTINUOUS_CONV_MODE                    0x0000
#define  THERMO11_SHUTDOWN_MODE                           0x0400
#define  THERMO11_ONESHOT_CONV_MODE                       0x0C00
#define  THERMO11_CONV_TIME_0                             0x0000
#define  THERMO11_CONV_TIME_1                             0x0080
#define  THERMO11_CONV_TIME_2                             0x0100
#define  THERMO11_CONV_TIME_3                             0x0180
#define  THERMO11_CONV_TIME_4                             0x0200
#define  THERMO11_CONV_TIME_5                             0x0280
#define  THERMO11_CONV_TIME_6                             0x0300
#define  THERMO11_CONV_TIME_7                             0x0380
#define  THERMO11_NO_AVRG                                 0x0000
#define  THERMO11_8_AVRG_CONV                             0x0020
#define  THERMO11_32_AVRG_CONV                            0x0040
#define  THERMO11_64_AVRG_CONV                            0x0060
#define  THERMO11_THERM_MODE                              0x0010
#define  THERMO11_ALERT_MODE                              0x0000
#define  THERMO11_INT_PIN_ACT_HIGH                        0x0008
#define  THERMO11_INT_PIN_ACT_LOW                         0x0000
#define  THERMO11_INT_PIN_DRDY_FLAG                       0x0004
#define  THERMO11_INT_PIN_ALERT_FLAGS                     0x0000
#define  THERMO11_SW_RESET_CMD                            0x0002
#define  THERMO11_EEPROM_LOCK                             0x0000
#define  THERMO11_EEPROM_UNLOCK                           0x8000
#define  THERMO11_EEPROM_BUSY_FLAG                        0x4000
#define  THERMO11_DEV_ID_MASK                             0x0FFF
#define  THERMO11_REVISION_MASK                           0xF000
#define  THERMO11_DRDY_FLAG                               0x01
#define  THERMO11_LOW_ALERT_FLAG                          0x02
#define  THERMO11_HIGH_ALERT_FLAG                         0x04
#define  THERMO11_FLAG_IS_CLEARED                         0x00
#define  THERMO11_INVALID_TEMP_RANGE                      0x02
#define  THERMO11_INVALID_ADDR                            0x01
#define  THERMO11_OK                                      0x00
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
 
    // Input pins 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} thermo11_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} thermo11_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void thermo11_cfg_setup ( thermo11_cfg_t *cfg );
 
THERMO11_RETVAL thermo11_init ( thermo11_t *ctx, thermo11_cfg_t *cfg );
 
void thermo11_default_cfg ( thermo11_t *ctx );
 
void thermo11_generic_write ( thermo11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void thermo11_generic_read ( thermo11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
THERMO11_RETVAL thermo11_write_reg ( thermo11_t *ctx, uint8_t reg_addr, uint16_t data_in );
 
THERMO11_RETVAL thermo11_read_reg ( thermo11_t *ctx, uint8_t reg_addr, uint16_t *data_out );
 
float thermo11_get_temp ( thermo11_t *ctx, uint8_t temp_addr );
 
THERMO11_RETVAL thermo11_get_int ( thermo11_t *ctx );
 
uint8_t thermo11_sm_bus_alert_cmd ( thermo11_t *ctx );
 
void thermo11_general_call_reset_cmd ( thermo11_t *ctx );
 
void thermo11_sw_reset ( thermo11_t *ctx );
 
THERMO11_RETVAL thermo11_check_status ( thermo11_t *ctx );
 
THERMO11_RETVAL thermo11_program_eeprom ( thermo11_t *ctx, uint8_t eeprom_addr, uint16_t eeprom_data );
 
THERMO11_RETVAL thermo11_set_temp ( thermo11_t *ctx, uint8_t temp_addr, float temp_value );
 
#ifdef __cplusplus
}
#endif
#endif  // _THERMO11_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END