thermo30.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 THERMO30_H
#define THERMO30_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 THERMO30_CMD_SINGLE_SHOT_CLK_STR_EN_REP_HIGH        0x2C06
#define THERMO30_CMD_SINGLE_SHOT_CLK_STR_EN_REP_MID         0x2C0D
#define THERMO30_CMD_SINGLE_SHOT_CLK_STR_EN_REP_LOW         0x2C10
#define THERMO30_CMD_SINGLE_SHOT_CLK_STR_DIS_REP_HIGH       0x2400
#define THERMO30_CMD_SINGLE_SHOT_CLK_STR_DIS_REP_MID        0x240B
#define THERMO30_CMD_SINGLE_SHOT_CLK_STR_DIS_REP_LOW        0x2416
#define THERMO30_CMD_PERIODIC_0p5_MPS_REP_HIGH              0x2032
#define THERMO30_CMD_PERIODIC_0p5_MPS_REP_MID               0x2024
#define THERMO30_CMD_PERIODIC_0p5_MPS_REP_LOW               0x202F
#define THERMO30_CMD_PERIODIC_1_MPS_REP_HIGH                0x2130
#define THERMO30_CMD_PERIODIC_1_MPS_REP_MID                 0x2126
#define THERMO30_CMD_PERIODIC_1_MPS_REP_LOW                 0x212D
#define THERMO30_CMD_PERIODIC_2_MPS_REP_HIGH                0x2236
#define THERMO30_CMD_PERIODIC_2_MPS_REP_MID                 0x2220
#define THERMO30_CMD_PERIODIC_2_MPS_REP_LOW                 0x222B
#define THERMO30_CMD_PERIODIC_4_MPS_REP_HIGH                0x2334
#define THERMO30_CMD_PERIODIC_4_MPS_REP_MID                 0x2322
#define THERMO30_CMD_PERIODIC_4_MPS_REP_LOW                 0x2329
#define THERMO30_CMD_PERIODIC_10_MPS_REP_HIGH               0x2737
#define THERMO30_CMD_PERIODIC_10_MPS_REP_MID                0x2721
#define THERMO30_CMD_PERIODIC_10_MPS_REP_LOW                0x272A
#define THERMO30_CMD_FETCH_DATA                             0xE000
#define THERMO30_CMD_BREAK                                  0x3093
#define THERMO30_CMD_SOFT_RESET                             0x30A2
#define THERMO30_CMD_HEATER_ENABLE                          0x306D
#define THERMO30_CMD_HEATER_DISABLE                         0x3066
#define THERMO30_CMD_READ_STATUS                            0xF32D
#define THERMO30_CMD_CLEAR_STATUS                           0x3041
#define THERMO30_CMD_GET_SERIAL_NUM                         0x3780
 
#define THERMO30_PIN_STATE_HIGH                             0x01
#define THERMO30_PIN_STATE_LOW                              0x00
 
#define THERMO30_DATA_RESOLUTION                            65535.0f
#define THERMO30_ABS_MIN_TEMP                               -45.0f
#define THERMO30_ABS_MAX_TEMP                               175.0f
 
#define THERMO30_DEVICE_ADDRESS_GND                         0x4A
#define THERMO30_DEVICE_ADDRESS_VCC                         0x4B
 
 // thermo30_set
 
#define THERMO30_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.alr = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // thermo30_map
 // thermo30
 
typedef struct
{
    // Output pins
    digital_out_t rst;          
    // Input pins
    digital_in_t alr;           
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} thermo30_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t rst;             
    pin_name_t alr;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} thermo30_cfg_t;
 
typedef enum
{
    THERMO30_OK = 0,
    THERMO30_ERROR = -1
 
} thermo30_return_value_t;
 
void thermo30_cfg_setup ( thermo30_cfg_t *cfg );
 
err_t thermo30_init ( thermo30_t *ctx, thermo30_cfg_t *cfg );
 
err_t thermo30_default_cfg ( thermo30_t *ctx );
 
void thermo30_set_rst_pin ( thermo30_t *ctx, uint8_t pin_state );
 
void thermo30_hw_reset ( thermo30_t *ctx );
 
uint8_t thermo30_get_alert_pin ( thermo30_t *ctx );
 
err_t thermo30_write_command ( thermo30_t *ctx, uint16_t cmd );
 
err_t thermo30_read_command ( thermo30_t *ctx, uint16_t cmd, uint16_t *data_out );
 
err_t thermo30_start_measurement ( thermo30_t *ctx, uint16_t cmd );
 
err_t thermo30_stop_measurement ( thermo30_t *ctx );
 
err_t thermo30_read_status ( thermo30_t *ctx, uint16_t *status_val );
 
err_t thermo30_read_temperature ( thermo30_t *ctx, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // THERMO30_H
 
 // thermo30
 
// ------------------------------------------------------------------------ END