tempalarm.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 TEMPALARM_H
#define TEMPALARM_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 TEMPALARM_REG_TEMP_LOCAL                0x00
#define TEMPALARM_REG_TEMP_REMOTE_MSB           0x01
#define TEMPALARM_REG_ALERT_STATUS              0x02
#define TEMPALARM_REG_CONFIGURATION             0x03
#define TEMPALARM_REG_CONV_PERIOD               0x04
#define TEMPALARM_REG_THIGH_LIMIT_LOCAL         0x05
#define TEMPALARM_REG_THIGH_LIMIT_REMOTE_MSB    0x07
#define TEMPALARM_REG_TLOW_LIMIT_REMOTE_MSB     0x08
#define TEMPALARM_REG_ONE_SHOT                  0x0F
#define TEMPALARM_REG_TEMP_REMOTE_LSB           0x10
#define TEMPALARM_REG_REMOTE_OFFSET_MSB         0x11
#define TEMPALARM_REG_REMOTE_OFFSET_LSB         0x12
#define TEMPALARM_REG_THIGH_LIMIT_REMOTE_LSB    0x13
#define TEMPALARM_REG_TLOW_LIMIT_REMOTE_LSB     0x14
#define TEMPALARM_REG_ALERT_MASK                0x16
#define TEMPALARM_REG_THIGH_CRIT_REMOTE         0x19
#define TEMPALARM_REG_THIGH_CRIT_LOCAL          0x20
#define TEMPALARM_REG_CRIT_HYSTERESIS           0x21
#define TEMPALARM_REG_LOG1                      0x2D
#define TEMPALARM_REG_LOG2                      0x2E
#define TEMPALARM_REG_LOG3                      0x2F
#define TEMPALARM_REG_FILTER_ALERT_MODE         0xBF
#define TEMPALARM_REG_CHIP_ID                   0xFD
#define TEMPALARM_REG_VENDOR_ID                 0xFE
#define TEMPALARM_REG_DEVICE_REV_ID             0xFF
 
 // tempalarm_reg
 
#define TEMPALARM_THIGH_LA_ALERT_DIS_MASK       0x80
#define TEMPALARM_THIGH_LA_ALERT_ENABLE_MASK    0x80
#define TEMPALARM_THIGH_RA_ALERT_DIS_MASK       0x10
#define TEMPALARM_THIGH_RA_ALERT_ENABLE_MASK    0x00
#define TEMPALARM_TLOW_RA_ALERT_DIS_MASK        0x08
#define TEMPALARM_TLOW_RA_ALERT_ENABLE_MASK     0x00
#define TEMPALARM_TCRIT_R_ALERT_DIS_MASK        0x02
#define TEMPALARM_TCRIT_R_ALERT_ENABLE_MASK     0x00
#define TEMPALARM_TCRIT_L_ALERT_DIS_MASK        0x01
#define TEMPALARM_TCRIT_L_ALERT_ENABLE_MASK     0x00
 
#define TEMPALARM_ADC_BUSY_MASK                 0x80
#define TEMPALARM_THIGH_LA_MASK                 0x40
#define TEMPALARM_THIGH_RA_MASK                 0x10
#define TEMPALARM_TLOW_RA_MASK                  0x08
#define TEMPALARM_REMOTE_DC_MASK                0x04
#define TEMPALARM_TCRIT_R_MASK                  0x02
#define TEMPALARM_TCRIT_L_MASK                  0x01
 
#define TEMPALARM_FILTER_LEVEL_0_MASK           0x00
#define TEMPALARM_FILTER_LEVEL_4_MASK           0x02
#define TEMPALARM_FILTER_LEVEL_8_MASK           0x06
#define TEMPALARM_INTERRUPT_ALERT_MODE          0x00
#define TEMPALARM_COMPARATOR_MODE               0x01
 
#define TEMPALARM_ALERT_DISABLED                0x80
#define TEMPALARM_SHUTDOWN_MODE                 0x40
#define TEMPALARM_CONTINUOUS_MODE               0x00
#define TEMPALARM_REMOTE_EN                     0x04
#define TEMPALARM_REMOTE_DIS                    0x00
#define TEMPALARM_WTC_EN                        0x02
#define TEMPALARM_WTC_DIS                       0x00
#define TEMPALARM_FAULT_QUE_EN                  0x01
#define TEMPALARM_FAULT_QUE_DIS                 0x00
 
#define TEMPALARM_CONVERSION_PERIOD_16S         0x00
#define TEMPALARM_CONVERSION_PERIOD_8S          0x01
#define TEMPALARM_CONVERSION_PERIOD_4S          0x02
#define TEMPALARM_CONVERSION_PERIOD_2S          0x03
#define TEMPALARM_CONVERSION_PERIOD_1S          0x04
#define TEMPALARM_CONVERSION_PERIOD_500MS       0x05
#define TEMPALARM_CONVERSION_PERIOD_250MS       0x06
#define TEMPALARM_CONVERSION_PERIOD_125MS       0x07
#define TEMPALARM_CONVERSION_PERIOD_62MS5       0x08
 
#define TEMPALARM_PIN_STATE_HIGH                0x01
#define TEMPALARM_PIN_STATE_LOW                 0x00
 
#define TEMPALARM_CHIP_ID                       0x50
#define TEMPALARM_VENDOR_ID                     0x60
 
#define TEMPALARM_TEMP_CLC                      0.125f
 
#define TEMPALARM_DEVICE_ADDRESS                0x4C
 
 // tempalarm_set
 
#define TEMPALARM_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.tcr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.alr = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // tempalarm_map
 // tempalarm
 
typedef struct
{
    // Input pins
    digital_in_t tcr;           
    digital_in_t alr;           
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} tempalarm_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t tcr;             
    pin_name_t alr;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} tempalarm_cfg_t;
 
typedef enum
{
    TEMPALARM_OK = 0,
    TEMPALARM_ERROR = -1
 
} tempalarm_return_value_t;
 
void tempalarm_cfg_setup ( tempalarm_cfg_t *cfg );
 
err_t tempalarm_init ( tempalarm_t *ctx, tempalarm_cfg_t *cfg );
 
err_t tempalarm_default_cfg ( tempalarm_t *ctx );
 
err_t tempalarm_generic_write ( tempalarm_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t tempalarm_generic_read ( tempalarm_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
uint8_t tempalarm_get_alr_pin ( tempalarm_t *ctx );
 
uint8_t tempalarm_get_tcr_pin ( tempalarm_t *ctx );
 
err_t tempalarm_write_reg ( tempalarm_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t tempalarm_read_reg ( tempalarm_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t tempalarm_read_temperature ( tempalarm_t *ctx, int8_t *temperature );
 
err_t tempalarm_read_remote_temp ( tempalarm_t *ctx, float *temperature );
 
err_t tempalarm_set_crit_thigh ( tempalarm_t *ctx, int8_t max_temperature );
 
err_t tempalarm_set_limit_thigh ( tempalarm_t *ctx, int8_t max_temperature );
 
err_t tempalarm_set_alarm_low_limit ( tempalarm_t *ctx, float min_temperature );
 
err_t tempalarm_set_alarm_high_limit ( tempalarm_t *ctx, float max_temperature );
 
err_t tempalarm_get_alarms ( tempalarm_t *ctx, uint8_t *alarms );
 
#ifdef __cplusplus
}
#endif
#endif // TEMPALARM_H
 
 // tempalarm
 
// ------------------------------------------------------------------------ END