thermo24.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 THERMO24_H
#define THERMO24_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 THERMO24_CMD_MEASURE_HIGH_PRECISION     0xFD
#define THERMO24_CMD_MEASURE_MEDIUM_PRECISION   0xF6
#define THERMO24_CMD_MEASURE_LOWEST_PRECISION   0xE0
#define THERMO24_CMD_READ_SERIAL                0x89
#define THERMO24_CMD_SOFT_RESET                 0x94
 
 // thermo24_cmd
 
#define THERMO24_MEASURE_PRECISION_LOW          0x00
#define THERMO24_MEASURE_PRECISION_MEDIUM       0x01
#define THERMO24_MEASURE_PRECISION_HIGH         0x02
 
#define THERMO24_TEMP_RESOLUTION                0xFFFF
#define THERMO24_TEMP_MULTIPLIER_CELSIUS        175.0
#define THERMO24_TEMP_OFFSET                    45.0
 
#define THERMO24_SET_DEVICE_ADDRESS             0x44
 
 // thermo24_set
 
#define THERMO24_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // thermo24_map
 // thermo24
 
typedef struct
{
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} thermo24_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
} thermo24_cfg_t;
 
typedef enum
{
    THERMO24_OK = 0,
    THERMO24_ERROR = -1
 
} thermo24_return_value_t;
 
void thermo24_cfg_setup ( thermo24_cfg_t *cfg );
 
err_t thermo24_init ( thermo24_t *ctx, thermo24_cfg_t *cfg );
 
err_t thermo24_soft_reset ( thermo24_t *ctx );
 
err_t thermo24_read_serial ( thermo24_t *ctx, uint32_t *serial_num );
 
err_t thermo24_read_temperature ( thermo24_t *ctx, uint8_t precision, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // THERMO24_H
 
 // thermo24
 
// ------------------------------------------------------------------------ END