thermo23.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 THERMO23_H
#define THERMO23_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_uart.h"
 
#define THERMO23_CMD_SOFT_RESET             0xB4
#define THERMO23_CMD_GLOBAL_INIT            0x8C
#define THERMO23_CMD_GLOBAL_ADDRESS_ASSIGN  0x90
#define THERMO23_CMD_GLOBAL_CLEAR_INT       0xA9
#define THERMO23_CMD_GLOBAL_WRITE_TEMP      0xF0
#define THERMO23_CMD_GLOBAL_WRITE_CONFIG    0xF2
#define THERMO23_CMD_GLOBAL_WRITE_TLOW      0xF4
#define THERMO23_CMD_GLOBAL_WRITE_THIGH     0xF6
#define THERMO23_CMD_GLOBAL_READ_TEMP       0xF1
#define THERMO23_CMD_GLOBAL_READ_CONFIG     0xF3
#define THERMO23_CMD_GLOBAL_READ_TLOW       0xF5
#define THERMO23_CMD_GLOBAL_READ_THIGH      0xF7
#define THERMO23_CMD_INDIVIDUAL_WRITE_BIT   0x00
#define THERMO23_CMD_INDIVIDUAL_READ_BIT    0x01
 
#define THERMO23_CALIBRATION_BYTE           0x55
 
#define THERMO23_TIMEOUT                    5000
 
#define THERMO23_CONFIG_INT_EN              0x8000
#define THERMO23_CONFIG_CR_0p25HZ           0x0000
#define THERMO23_CONFIG_CR_1HZ              0x2000
#define THERMO23_CONFIG_CR_4HZ              0x4000
#define THERMO23_CONFIG_CR_8HZ              0x6000
#define THERMO23_CONFIG_FH                  0x1000
#define THERMO23_CONFIG_FL                  0x0800
#define THERMO23_CONFIG_LC                  0x0400
#define THERMO23_CONFIG_MODE_SHUTDOWN       0x0000
#define THERMO23_CONFIG_MODE_ONE_SHOT       0x0100
#define THERMO23_CONFIG_MODE_CONTINUOUS     0x0200
#define THERMO23_CONFIG_ETM                 0x0080
#define THERMO23_CONFIG_RESERVED_BITS       0x007F
 
#define THERMO23_TEMP_RESOLUTION            0.0625
 
#define DRV_BUFFER_SIZE                     200
 
 // thermo23_cmd
 
#define THERMO23_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX );
 
 // thermo23_map
 // thermo23
 
typedef struct
{
    // Modules
    uart_t uart;                                
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];     
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];     
    uint16_t config;                            
} thermo23_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                          
    pin_name_t tx_pin;                          
    // Static variable
    uint32_t          baud_rate;                
    bool              uart_blocking;            
    uart_data_bits_t  data_bit;                 
    uart_parity_t     parity_bit;               
    uart_stop_bits_t  stop_bit;                 
} thermo23_cfg_t;
 
typedef enum
{
    THERMO23_OK = 0,
    THERMO23_ERROR = -1
 
} thermo23_return_value_t;
 
void thermo23_cfg_setup ( thermo23_cfg_t *cfg );
 
err_t thermo23_init ( thermo23_t *ctx, thermo23_cfg_t *cfg );
 
err_t thermo23_default_cfg ( thermo23_t *ctx );
 
err_t thermo23_write_command ( thermo23_t *ctx, uint8_t cmd, uint16_t data_in );
 
err_t thermo23_read_command ( thermo23_t *ctx, uint8_t cmd, uint16_t *data_out );
 
err_t thermo23_set_config ( thermo23_t *ctx, uint16_t config );
 
err_t thermo23_read_temperature ( thermo23_t *ctx, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // THERMO23_H
 
 // thermo23
 
// ------------------------------------------------------------------------ END