templog5.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 TEMPLOG5_H
#define TEMPLOG5_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 TEMPLOG5_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define TEMPLOG5_RETVAL  uint8_t
 
#define TEMPLOG5_OK           0x00
#define TEMPLOG5_INIT_ERROR   0xFF
#define TEMPLOG5_REG_CAPABILITY                      0x00
#define TEMPLOG5_REG_CONFIGURATION                   0x01
#define TEMPLOG5_REG_HIGH_LIMIT                      0x02
#define TEMPLOG5_REG_LOW_LIMIT                       0x03
#define TEMPLOG5_REG_CRITICAL_LIMIT                  0x04
#define TEMPLOG5_REG_TEMPERATURE                     0x05
#define TEMPLOG5_REG_MANUFACTURER_ID                 0x06
#define TEMPLOG5_REG_DEVICE_ID                       0x07
#define TEMPLOG5_CFG_DISABLE_HYSTERESIS              0x0000
#define TEMPLOG5_CFG_HYSTERESIS_TO_1p5C              0x0200
#define TEMPLOG5_CFG_HYSTERESIS_TO_3C                0x0400
#define TEMPLOG5_CFG_HYSTERESIS_TO_6C                0x0600
#define TEMPLOG5_CFG_TEMP_SENSOR_ENABLE              0x0000
#define TEMPLOG5_CFG_TEMP_SENSOR_DISABLE             0x0100
#define TEMPLOG5_CFG_CRITICAL_TRIP_ENABLE            0x0000
#define TEMPLOG5_CFG_CRITICAL_TRIP_DISABLE           0x0080
#define TEMPLOG5_CFG_ALARM_TRIP_ENABLE               0x0000
#define TEMPLOG5_CFG_ALARM_TRIP_DISABLE              0x0040
#define TEMPLOG5_CFG_EVENT_INT_PIN_ENABLE            0x0010
#define TEMPLOG5_CFG_EVENT_INT_PIN_DISABLE           0x0000
#define TEMPLOG5_CFG_EVENT_OUT_ENABLE                0x0008
#define TEMPLOG5_CFG_EVENT_OUT_DISABLE               0x0000
#define TEMPLOG5_CFG_EVENT_OUT_ACTIVE_LOW            0x0000
#define TEMPLOG5_CFG_EVENT_OUT_ACTIVE_HIGH           0x0002
#define TEMPLOG5_CFG_EVENT_MODE_COMPARATOR           0x0000
#define TEMPLOG5_CFG_EVENT_MODE_INTERRUPT            0x0001
#define TEMPLOG5_CAP_EVSD_FROZEN                     0x0000
#define TEMPLOG5_CAP_EVSD_CLEARD                     0x0080
#define TEMPLOG5_CAP_TMOUT_10ms_60ms                 0x0000
#define TEMPLOG5_CAP_TMOUT_25ms_35ms                 0x0040
#define TEMPLOG5_CAP_RSWP_NOT_EXPLICITLY_STATED      0x0000
#define TEMPLOG5_CAP_RSWP_EXPLICITLY_STATED          0x0020
#define TEMPLOG5_CAP_TEMP_RES_9bit                   0x0000
#define TEMPLOG5_CAP_TEMP_RES_10bit                  0x0008
#define TEMPLOG5_CAP_TEMP_RES_11bit                  0x0010
#define TEMPLOG5_CAP_TEMP_RES_12bit                  0x0018
#define TEMPLOG5_CAP_POS_TEMP_ONLY                   0x0000
#define TEMPLOG5_CAP_POS_AND_NEG_TEMP                0x0004
#define TEMPLOG5_CAP_ACC_CLASS_C                     0x0000
#define TEMPLOG5_CAP_ACC_CLASS_B                     0x0002
#define TEMPLOG5_CAP_EV_CRITICAL_TEMP_ONLY           0x0000
#define TEMPLOG5_CAP_EV_ALARM_AND_CRITICAL_TEMP      0x0001
#define TEMPLOG5_TS_SLAVE_ADDR_000                   0x18
#define TEMPLOG5_TS_SLAVE_ADDR_001                   0x19
#define TEMPLOG5_TS_SLAVE_ADDR_010                   0x1A
#define TEMPLOG5_TS_SLAVE_ADDR_011                   0x1B
#define TEMPLOG5_TS_SLAVE_ADDR_100                   0x1C
#define TEMPLOG5_TS_SLAVE_ADDR_101                   0x1D
#define TEMPLOG5_TS_SLAVE_ADDR_110                   0x1E
#define TEMPLOG5_TS_SLAVE_ADDR_111                   0x1F
#define TEMPLOG5_EEPROM_SLAVE_ADDR_000               0x50
#define TEMPLOG5_EEPROM_SLAVE_ADDR_001               0x51
#define TEMPLOG5_EEPROM_SLAVE_ADDR_010               0x52
#define TEMPLOG5_EEPROM_SLAVE_ADDR_011               0x53
#define TEMPLOG5_EEPROM_SLAVE_ADDR_100               0x54
#define TEMPLOG5_EEPROM_SLAVE_ADDR_101               0x55
#define TEMPLOG5_EEPROM_SLAVE_ADDR_110               0x56
#define TEMPLOG5_EEPROM_SLAVE_ADDR_111               0x57
#define TEMPLOG5_MANUFACTURER_ID                     0x1B09
#define TEMPLOG5_DEVICE_ID_REV_B                     0x0813
#define TEMPLOG5_DEVICE_ID_REV_C                     0x0A00
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t ts_slave;
    uint8_t eeprom_slave;
    uint8_t temp_status;
 
} templog5_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 ts_slave;
    uint8_t eeprom_slave;
 
 
} templog5_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void templog5_cfg_setup ( templog5_cfg_t *cfg );
 
TEMPLOG5_RETVAL templog5_init ( templog5_t *ctx, templog5_cfg_t *cfg );
 
void templog5_default_cfg ( templog5_t *ctx );
 
void templog5_write_data ( templog5_t *ctx, uint8_t reg, uint16_t data_in );
 
void templog5_write_eeprom ( templog5_t *ctx, uint8_t start_addr, uint8_t *data_in, uint8_t n_byte );
 
uint16_t templog5_read_data ( templog5_t *ctx, uint8_t reg );
 
void templog5_read_eeprom ( templog5_t *ctx, uint8_t start_addr, uint8_t *data_out, uint8_t n_byte );
 
float templog5_get_temperature ( templog5_t *ctx );
 
uint8_t templog5_get_temperature_status ( templog5_t *ctx );
 
uint8_t templog5_get_interrupt_status ( templog5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _TEMPLOG5_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END