thermo19.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 THERMO19_H
#define THERMO19_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_one_wire.h"
 
#define THERMO19_CMD_CONVERT_TEMPERATURE            0x44
#define THERMO19_CMD_WRITE_SCRATCHPAD               0x4E
#define THERMO19_CMD_READ_SCRATCHPAD                0xBE
#define THERMO19_CMD_DETECT_ADDRESS                 0x88
#define THERMO19_CMD_SELECT_ADDRESS                 0x70
 
 // thermo19_cmd
 
#define THERMO19_CONFIG_FORMAT_NORMAL               0x00
#define THERMO19_CONFIG_FORMAT_EXTEND               0x80
#define THERMO19_CONFIG_FORMAT_BIT_MASK             0x80
#define THERMO19_CONFIG_RESOLUTION_8BIT             0x00
#define THERMO19_CONFIG_RESOLUTION_9BIT             0x20
#define THERMO19_CONFIG_RESOLUTION_10BIT            0x40
#define THERMO19_CONFIG_RESOLUTION_12BIT            0x60
#define THERMO19_CONFIG_RESOLUTION_BIT_MASK         0x60
#define THERMO19_CONFIG_COMP_INT_COMPARATOR         0x00
#define THERMO19_CONFIG_COMP_INT_INTERRUPT          0x10
#define THERMO19_CONFIG_COMP_INT_BIT_MASK           0x10
#define THERMO19_CONFIG_FAULT_QUEUE_SINGLE          0x00
#define THERMO19_CONFIG_FAULT_QUEUE_MULTIPLE        0x08
#define THERMO19_CONFIG_FAULT_QUEUE_BIT_MASK        0x08
#define THERMO19_CONFIG_CONVERSION_RATE_0           0x00
#define THERMO19_CONFIG_CONVERSION_RATE_1_64        0x01
#define THERMO19_CONFIG_CONVERSION_RATE_1_32        0x02
#define THERMO19_CONFIG_CONVERSION_RATE_1_16        0x03
#define THERMO19_CONFIG_CONVERSION_RATE_1_4         0x04
#define THERMO19_CONFIG_CONVERSION_RATE_1_1         0x05
#define THERMO19_CONFIG_CONVERSION_RATE_4_1         0x06
#define THERMO19_CONFIG_CONVERSION_RATE_8_1         0x07
#define THERMO19_CONFIG_CONVERSION_RATE_BIT_MASK    0x07
 
#define THERMO19_STATUS_TH_FAULT_OCCURED            0x80
#define THERMO19_STATUS_TH_FAULT_NOT_OCCURED        0x00
#define THERMO19_STATUS_TH_FAULT_BIT_MASK           0x80
#define THERMO19_STATUS_TL_FAULT_OCCURED            0x40
#define THERMO19_STATUS_TL_FAULT_NOT_OCCURED        0x00
#define THERMO19_STATUS_TL_FAULT_BIT_MASK           0x40
#define THERMO19_STATUS_ADDRRESS_0                  0x1A
#define THERMO19_STATUS_ADDRRESS_1                  0x3A
#define THERMO19_STATUS_ADDRRESS_BIT_MASK           0x3F
 
#define THERMO19_ADDRESS_0                          0x1A
#define THERMO19_ADDRESS_1                          0x3A
#define THERMO19_ADDRESS_ALL                        0xFF
#define THERMO19_ADDRESS_BIT_MASK                   0x3F
 
#define THERMO19_DATA_RESOLUTION                    0.0625
 
#define THERMO19_FAMILY_CODE                        0x3B
 
#define THERMO19_DEFAULT_CONFIG                     ( THERMO19_CONFIG_RESOLUTION_12BIT | THERMO19_CONFIG_COMP_INT_INTERRUPT )
#define THERMO19_DEFAULT_ADDRESS                    THERMO19_ADDRESS_ALL
#define THERMO19_DEFAULT_TEMP_HIGH_ALARM            0xFFFF
#define THERMO19_DEFAULT_TEMP_LOW_ALARM             0x0000
 
 // thermo19_set
 
#define THERMO19_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.alt = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // thermo19_map
 // thermo19
 
typedef enum
{
    THERMO19_GPIO_0,      
    THERMO19_GPIO_1       
} thermo19_gpio_sel_t;
 
typedef struct
{
    digital_in_t alt;                   
    // Modules
    one_wire_t ow;                      
    one_wire_rom_address_t rom_addr;    
    uint8_t config;                     
    uint8_t address;                    
} thermo19_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t gp0;                     
    pin_name_t gp1;                     
    pin_name_t alt;                     
    thermo19_gpio_sel_t gpio_sel;       
} thermo19_cfg_t;
 
typedef enum
{
    THERMO19_OK = 0,
    THERMO19_ERROR = -1
 
} thermo19_return_value_t;
 
void thermo19_cfg_setup ( thermo19_cfg_t *cfg );
 
void thermo19_gpio_selection ( thermo19_cfg_t *cfg, thermo19_gpio_sel_t gpio_sel );
 
err_t thermo19_init ( thermo19_t *ctx, thermo19_cfg_t *cfg );
 
err_t thermo19_default_cfg ( thermo19_t *ctx );
 
err_t thermo19_check_communication ( thermo19_t *ctx );
 
err_t thermo19_select_device ( thermo19_t *ctx );
 
err_t thermo19_start_measurement ( thermo19_t *ctx );
 
err_t thermo19_read_scratchpad ( thermo19_t *ctx, uint8_t *scratchpad );
 
err_t thermo19_write_scratchpad ( thermo19_t *ctx, uint16_t temp_high, uint16_t temp_low, uint8_t config );
 
err_t thermo19_read_temperature ( thermo19_t *ctx, float *temperature );
 
uint8_t thermo19_get_alert_pin ( thermo19_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // THERMO19_H
 
 // thermo19
 
// ------------------------------------------------------------------------ END