thermo29.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 THERMO29_H
#define THERMO29_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 THERMO29_REG_TEMP_RESULT                0x00
#define THERMO29_REG_SLEW_RESULT                0x01
#define THERMO29_REG_ALERT_STATUS               0x02
#define THERMO29_REG_CONFIGURATION              0x03
#define THERMO29_REG_ALERT_ENABLE               0x04
#define THERMO29_REG_TLOW_LIMIT                 0x05
#define THERMO29_REG_THIGH_LIMIT                0x06
#define THERMO29_REG_HYSTERESIS                 0x07
#define THERMO29_REG_SLEW_LIMIT                 0x08
#define THERMO29_REG_UNIQUE_ID1                 0x09
#define THERMO29_REG_UNIQUE_ID2                 0x0A
#define THERMO29_REG_UNIQUE_ID3                 0x0B
#define THERMO29_REG_DEVICE_ID                  0x0C
 
 // thermo29_reg
 
#define THERMO29_CONFIGURATION_RESETS           0x0100u
#define THERMO29_CONFIGURATION_AVG              0x0080u
#define THERMO29_CONFIGURATION_INT_COMP         0x0020u
#define THERMO29_CONFIGURATION_ONE_SHOT         0x0010u
#define THERMO29_CONFIGURATION_MODE_CONT        0x0000u
#define THERMO29_CONFIGURATION_MODE_SHDN        0x0008u
#define THERMO29_CONFIGURATION_MODE_MASK        0x0008u
#define THERMO29_CONFIGURATION_CONV_PER_6MS     0x0000u
#define THERMO29_CONFIGURATION_CONV_PER_31_25MS 0x0001u
#define THERMO29_CONFIGURATION_CONV_PER_62_5MS  0x0002u
#define THERMO29_CONFIGURATION_CONV_PER_125MS   0x0003u
#define THERMO29_CONFIGURATION_CONV_PER_250MS   0x0004u
#define THERMO29_CONFIGURATION_CONV_PER_500MS   0x0005u
#define THERMO29_CONFIGURATION_CONV_PER_1S      0x0006u
#define THERMO29_CONFIGURATION_CONV_PER_2S      0x0007u
#define THERMO29_CONFIGURATION_CONV_PER_MASK    0x0007u
 
#define THERMO29_ALERT_ENABLE_CRC               0x0010u
#define THERMO29_ALERT_ENABLE_SLEW              0x0008u
#define THERMO29_ALERT_ENABLE_THIG              0x0004u
#define THERMO29_ALERT_ENABLE_TLOW              0x0002u
#define THERMO29_ALERT_ENABLE_DATA_READY        0x0001u
 
#define THERMO29_CRC_ENABLE                     0x40
#define THERMO29_CRC_DATA_BLOCK_LEN_MASK        0x3C
#define THERMO29_AUTO_INCREMENT                 0x02
#define THERMO29_READ_BIT                       0x01
#define THERMO29_WRITE_BIT                      0x00
#define THERMO29_DATA_LEN_MAX                   10
 
#define THERMO29_TEMP_RESOLUTION                0.03125f
 
#define THERMO29_DEVICE_REV_MASK                0xF000u
#define THERMO29_DEVICE_ID_MASK                 0x0FFFu
#define THERMO29_DEVICE_ID                      0x0126u
 
#define THERMO29_SET_DATA_SAMPLE_EDGE           SET_SPI_DATA_SAMPLE_EDGE
#define THERMO29_SET_DATA_SAMPLE_MIDDLE         SET_SPI_DATA_SAMPLE_MIDDLE
 
 // thermo29_set
 
#define THERMO29_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 ); \
    cfg.alert = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // thermo29_map
 // thermo29
 
typedef struct
{
    // Input pins
    digital_in_t alert;             
    // Modules
    spi_master_t spi;               
    pin_name_t   chip_select;       
    bool         crc_enable;        
} thermo29_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    pin_name_t cs;                  
    // Additional gpio pins
    pin_name_t alert;               
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} thermo29_cfg_t;
 
typedef enum
{
    THERMO29_OK = 0,
    THERMO29_ERROR = -1
 
} thermo29_return_value_t;
 
void thermo29_cfg_setup ( thermo29_cfg_t *cfg );
 
err_t thermo29_init ( thermo29_t *ctx, thermo29_cfg_t *cfg );
 
err_t thermo29_default_cfg ( thermo29_t *ctx );
 
err_t thermo29_write_register ( thermo29_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t thermo29_read_register ( thermo29_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t thermo29_write_registers ( thermo29_t *ctx, uint8_t reg, uint16_t *data_in, uint8_t len );
 
err_t thermo29_read_registers ( thermo29_t *ctx, uint8_t reg, uint16_t *data_out, uint8_t len );
 
uint8_t thermo29_get_alert_pin ( thermo29_t *ctx );
 
void thermo29_enable_crc ( thermo29_t *ctx );
 
void thermo29_disable_crc ( thermo29_t *ctx );
 
err_t thermo29_check_communication ( thermo29_t *ctx );
 
err_t thermo29_read_unique_id ( thermo29_t *ctx, uint16_t *unique_id );
 
err_t thermo29_read_temperature ( thermo29_t *ctx, float *temperature );
 
err_t thermo29_clear_alert_status ( thermo29_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // THERMO29_H
 
 // thermo29
 
// ------------------------------------------------------------------------ END