thermo27.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 THERMO27_H
#define THERMO27_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 THERMO27_TEMP_RESULT_REG                    0x00
#define THERMO27_SLEW_RESULT_REG                    0x01
#define THERMO27_ALERT_STATUS_REG                   0x02
#define THERMO27_CONFIGURATION_REG                  0x03
#define THERMO27_TLOW_LIMIT_REG                     0x04
#define THERMO27_THIGH_LIMIT_REG                    0x05
#define THERMO27_HYSTERESIS_REG                     0x06
#define THERMO27_SLEW_LIMIT_REG                     0x07
#define THERMO27_UNIQUE_ID1_REG                     0x08
#define THERMO27_UNIQUE_ID2_REG                     0x09
#define THERMO27_UNIQUE_ID3_REG                     0x0A
#define THERMO27_DEVICE_ID_REG                      0x0B
 
 // thermo27_reg
 
#define THERMO27_CRC_MODE_ENABLED                   0x01
#define THERMO27_CRC_MODE_DISABLED                  0x00
#define THERMO27_POLYNOMIAL                         0x07
#define THERMO27_DEVICE_ID                          0x1114
#define THERMO27_TEMP_COEF                          0.0078125
#define THERMO27_LSB_VAL                            0.03125
#define THERMO27_LOW_TEMP_LIMIT_VAL                -25
#define THERMO27_HIGH_TEMP_LIMIT_VAL                80
#define THERMO27_SW_RESET                           0x06
 
#define THERMO27_ADC_TIME_6mS_MODE_CMD              0x0000
#define THERMO27_ADC_TIME_4mS_MODE_CMD              0x0200
#define THERMO27_ADC_TIME_2mS_MODE_CMD              0x0400
#define THERMO27_ADC_TIME_1mS_MODE_CMD              0x0600
#define THERMO27_SW_RESET_CMD                       0x0100
#define THERMO27_ENABLE_AVG_CMD                     0x0080
#define THERMO27_ENABLE_CRC_CMD                     0x0040
#define THERMO27_ONE_SHOT_CMD                       0x0010
#define THERMO27_CONTINUOUS_MODE_CMD                0x0000
#define THERMO27_SHOUTDOWN_MODE_CMD                 0x0008
#define THERMO27_CONVERSION_TIME_7mS_MODE_CMD       0x0000
#define THERMO27_CONVERSION_TIME_32mS_MODE_CMD      0x0001
#define THERMO27_CONVERSION_TIME_63mS_MODE_CMD      0x0002
#define THERMO27_CONVERSION_TIME_125mS_MODE_CMD     0x0003
#define THERMO27_CONVERSION_TIME_250mS_MODE_CMD     0x0004
#define THERMO27_CONVERSION_TIME_500mS_MODE_CMD     0x0005
#define THERMO27_CONVERSION_TIME_1S_MODE_CMD        0x0006
#define THERMO27_CONVERSION_TIME_2S_MODE_CMD        0x0007
 
#define THERMO27_CRC_FLAG                           0x80
#define THERMO27_SLEW_STATUS                        0x40
#define THERMO27_SLEW_FLAG                          0x20
#define THERMO27_THIGH_STATUS                       0x10
#define THERMO27_TLOW_STATUS                        0x08
#define THERMO27_THIGH_FLAG                         0x04
#define THERMO27_TLOW_FLAG                          0x02
#define THERMO27_DATA_READY_FLAG                    0x01
 
 
#define THERMO27_DEVICE_ADDRESS                     0x4D
#define THERMO27_RESET_DEVICE_ADDRESS               0x00
 
 // thermo27_set
 
#define THERMO27_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // thermo27_map
 // thermo27
 
typedef struct
{
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
    uint8_t    crc_mode;        
} thermo27_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} thermo27_cfg_t;
 
typedef enum
{
    THERMO27_OK = 0,
    THERMO27_ERROR = -1
 
} thermo27_return_value_t;
 
void thermo27_cfg_setup ( thermo27_cfg_t *cfg );
 
err_t thermo27_init ( thermo27_t *ctx, thermo27_cfg_t *cfg );
 
err_t thermo27_default_cfg ( thermo27_t *ctx );
 
err_t thermo27_generic_write ( thermo27_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t thermo27_generic_read ( thermo27_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t thermo27_write_register ( thermo27_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t thermo27_read_register ( thermo27_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t thermo27_get_device_id ( thermo27_t *ctx, uint16_t *device_id );
 
err_t thermo27_sw_reset ( thermo27_t *ctx );
 
err_t thermo27_read_temp ( thermo27_t *ctx, float *temp_out );
 
err_t thermo27_enable_crc ( thermo27_t *ctx );
 
err_t thermo27_set_low_temp_limit ( thermo27_t *ctx, float low_temp_limit );
 
err_t thermo27_set_high_temp_limit ( thermo27_t *ctx, float high_temp_limit );
 
err_t thermo27_set_hysteresis ( thermo27_t *ctx, uint8_t thigh_hyst, uint8_t tlow_hyst );
 
err_t thermo27_set_slew_limit ( thermo27_t *ctx, float slew_limit );
 
err_t thermo27_get_alert_reg ( thermo27_t *ctx, uint8_t *register_flags );
 
#ifdef __cplusplus
}
#endif
#endif // THERMO27_H
 
 // thermo27
 
// ------------------------------------------------------------------------ END