thermo20.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 THERMO20_H
#define THERMO20_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 THERMO20_CMD_RESET                  0x1E
#define THERMO20_CMD_READ_SERIAL_NUMBER     0x0A
#define THERMO20_CMD_CONVERSION             0x46
#define THERMO20_CMD_READ_ADC               0x00
 
 // thermo20_reg
 
#define THERMO20_SET_DEV_ADDR               0x40
 
 // thermo20_set
 
#define THERMO20_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); 
 
 // thermo20_map
 // thermo20
 
typedef struct
{
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
} thermo20_t;
 
typedef struct
{
    pin_name_t  scl;    
    pin_name_t  sda;    
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} thermo20_cfg_t;
 
typedef enum
{
   THERMO20_OK = 0,
   THERMO20_ERROR = -1
 
} thermo20_return_value_t;
 
void thermo20_cfg_setup ( thermo20_cfg_t *cfg );
 
err_t thermo20_init ( thermo20_t *ctx, thermo20_cfg_t *cfg );
 
err_t thermo20_default_cfg ( thermo20_t *ctx );
 
err_t thermo20_generic_write ( thermo20_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t thermo20_generic_read ( thermo20_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t thermo20_set_cmd ( thermo20_t *ctx, uint8_t cmd );
 
void thermo20_soft_reset ( thermo20_t *ctx );
 
void thermo20_start_conversion ( thermo20_t *ctx );
 
uint16_t thermo20_read_adc ( thermo20_t *ctx );
 
float thermo20_get_temperature ( thermo20_t *ctx );
 
uint32_t thermo20_get_serial_number ( thermo20_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // THERMO20_H
 
 // thermo20
 
// ------------------------------------------------------------------------ END