templog2.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 _TEMPLOG2_H_
#define _TEMPLOG2_H_
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS
#define TEMPLOG2_TEMP_REG                  0x00
#define TEMPLOG2_CONFIG_REG                0x01
#define TEMPLOG2_HIGH_LIMIT_REG            0x02
#define TEMPLOG2_LOW_LIMIT_REG             0x03
#define TEMPLOG2_EEPROM_UNLOCK_REG         0x04
#define TEMPLOG2_EEPROM1_REG               0x05
#define TEMPLOG2_EEPROM2_REG               0x06
#define TEMPLOG2_EEPROM3_REG               0x07
#define TEMPLOG2_EEPROM4_REG               0x08
#define TEMPLOG2_ID_REG                    0x0F
#define TEMPLOG2_15_MILISEC_0_AVG          0x00
#define TEMPLOG2_125_MILISEC_0_AVG         0x0080
#define TEMPLOG2_250_MILISEC_0_AVG         0x0100
#define TEMPLOG2_500_MILISEC_0_AVG         0x0180
#define TEMPLOG2_1_SEC_0_AVG               0x0200
#define TEMPLOG2_4_SEC_0_AVG               0x0280
#define TEMPLOG2_8_SEC_0_AVG               0x0300
#define TEMPLOG2_16_SEC_0_AVG              0x0380
#define TEMPLOG2_125_MILISEC_8_AVG         0x0020
#define TEMPLOG2_250_MILISEC_8_AVG         0x0120
#define TEMPLOG2_500_MILISEC_8_AVG         0x01A0
#define TEMPLOG2_1_SEC_8_AVG               0x0220
#define TEMPLOG2_4_SEC_8_AVG               0x02A0
#define TEMPLOG2_8_SEC_8_AVG               0x0320
#define TEMPLOG2_16_SEC_8_AVG              0x03A0
#define TEMPLOG2_500_MILISEC_32_AVG        0x0040
#define TEMPLOG2_1_SEC_32_AVG              0x0240
#define TEMPLOG2_4_SEC_32_AVG              0x02C0
#define TEMPLOG2_8_SEC_32_AVG              0x0340
#define TEMPLOG2_16_SEC_32_AVG             0x03C0
#define TEMPLOG2_1_SEC_64_AVG              0x0060
#define TEMPLOG2_4_SEC_64_AVG              0x02E0
#define TEMPLOG2_8_SEC_64_AVG              0x0360
#define TEMPLOG2_16_SEC_64_AVG             0x03E0
#define TEMPLOG2_POL_ACTIVE_LOW            0x00
#define TEMPLOG2_POL_ACTIVE_HIGH           0x0008
#define TEMPLOG2_PIN_ALERT_FLAGS           0x00
#define TEMPLOG2_PIN_DATAREADY_FLAG        0x0004
 
#define TEMPLOG2_LOCK_EEPROM               0x00
#define TEMPLOG2_UNLOCK_EEPROM             0x8000
#define TEMPLOG2_0_CELSIUS                 0x00
#define TEMPLOG2_1_CELSIUS_POS             0x0080
#define TEMPLOG2_25_CELSIUS_POS            0x0C80
#define TEMPLOG2_25_CELSIUS_NEG            0xF380
#define TEMPLOG2_100_CELSIUS_POS           0x3200
#define TEMPLOG2_256_CELSIUS_POS           0x7FFF
#define TEMPLOG2_256_CELSIUS_NEG           0x8000
#define TEMPLOG2_CONT_CONV_OP_MODE         0x00
#define TEMPLOG2_SHUTDOWN_OP_MODE          0x01
#define TEMPLOG2_ONE_SHOT_OP_MODE          0x02
#define TEMPLOG2_ALERT_MODE                0x00
#define TEMPLOG2_THERM_MODE                0x01
 //  End settings group
 
#define TEMPLOG2_DATA_READY_MASK           0x01
#define TEMPLOG2_LOW_LIMIT_MASK            0x02
#define TEMPLOG2_HIGH_LIMIT_MASK           0x04
#define TEMPLOG2_BUSY_MASK                 0x4000
 //  End registers group
 
#define TEMPLOG2_OK                        0x00
#define TEMPLOG2_INVALID_ADDR              0xFF
#define TEMPLOG2_INVALID_PARAM             0xFE
#define TEMPLOG2_INIT_DRV_ERROR            0xFD
#define TEMPLOG2_RETVAL  uint8_t
 //  End error group
 
#define TEMPLOG2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.alt = MIKROBUS( mikrobus, MIKROBUS_INT ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 //  End macros group
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    //  Click mikrobus DRV objects.
    digital_in_t  alt;
    i2c_master_t  i2c;
 
    //  Used I2C slave address.
    uint8_t  slave_addr;
 
} templog2_t;
 
typedef struct
{
    //  Used mikrobus pins.
    pin_name_t  alt;
    pin_name_t  scl;
    pin_name_t  sda;
 
    bool  addr_sel;
    uint32_t i2c_speed;
 
} templog2_cfg_t;
 
 //  End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void
templog2_cfg_setup( templog2_cfg_t *cfg );
 
TEMPLOG2_RETVAL
templog2_init( templog2_t *ctx, templog2_cfg_t *cfg );
 
void
templog2_default_config( templog2_t *ctx );
 
TEMPLOG2_RETVAL
templog2_write_reg( templog2_t *ctx, uint8_t reg_addr, uint16_t transfer_data );
 
TEMPLOG2_RETVAL
templog2_read_reg( templog2_t *ctx, uint8_t reg_addr, uint16_t *data_out );
 
uint8_t
templog2_data_ready( templog2_t *ctx );
 
uint8_t
templog2_check_alert( templog2_t *ctx );
 
float
templog2_read_temp( templog2_t *ctx );
 
TEMPLOG2_RETVAL
templog2_set_mode( templog2_t *ctx, uint8_t op_mode, uint8_t alert_mode );
 
TEMPLOG2_RETVAL
templog2_write_eeprom( templog2_t *ctx, uint8_t eeprom_addr, uint16_t data_in );
 
void
templog2_reset( templog2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  //  _TEMPLOG2_H_
 
 //  End public_function group
 
// ------------------------------------------------------------------------ END