thermok3.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 THERMOK3_H
#define THERMOK3_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_spi_master.h"
#include "spi_specifics.h"
 
#define THERMOK3_DUMMY_SIGN_BIT             0x80
#define THERMOK3_OPEN_THERMOCOUPLE_BIT      0x04
#define THERMOK3_DEVICE_ID_BIT              0x02
 
#define THERMOK3_DATA_RESOLUTION            0x0FFFu
#define THERMOK3_TEMP_RESOLUTION            0.25f
 
#define THERMOK3_SET_DATA_SAMPLE_EDGE       SET_SPI_DATA_SAMPLE_EDGE
#define THERMOK3_SET_DATA_SAMPLE_MIDDLE     SET_SPI_DATA_SAMPLE_MIDDLE
 
 // thermok3_set
 
#define THERMOK3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );
 
 // thermok3_map
 // thermok3
 
typedef struct
{
    // Modules
    spi_master_t spi;               
    pin_name_t   chip_select;       
} thermok3_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    pin_name_t cs;                  
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} thermok3_cfg_t;
 
typedef enum
{
    THERMOK3_OK = 0,
    THERMOK3_ERROR = -1,
    THERMOK3_OPEN_THERMOCOUPLE = -2
 
} thermok3_return_value_t;
 
void thermok3_cfg_setup ( thermok3_cfg_t *cfg );
 
err_t thermok3_init ( thermok3_t *ctx, thermok3_cfg_t *cfg );
 
err_t thermok3_read_data ( thermok3_t *ctx, uint16_t *data_out );
 
err_t thermok3_read_temperature ( thermok3_t *ctx, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // THERMOK3_H
 
 // thermok3
 
// ------------------------------------------------------------------------ END