thermo2.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 THERMO2_H
#define THERMO2_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 THERMO2_CMD_CONVERT_TEMPERATURE     0x44
#define THERMO2_CMD_WRITE_SCRATCHPAD        0x4E
#define THERMO2_CMD_READ_SCRATCHPAD         0xBE
#define THERMO2_CMD_COPY_SCRATCHPAD         0x48
#define THERMO2_CMD_RECALL_SCRATCHPAD       0xB8
#define THERMO2_CMD_READ_POWER_SUPPLY       0xB4
 
 // thermo2_cmd
 
#define THERMO2_CONFIG_ADDRESS_0            0x00
#define THERMO2_CONFIG_ADDRESS_1            0x01
#define THERMO2_CONFIG_ADDRESS_2            0x02
#define THERMO2_CONFIG_ADDRESS_3            0x03
#define THERMO2_CONFIG_ADDRESS_4            0x04
#define THERMO2_CONFIG_ADDRESS_5            0x05
#define THERMO2_CONFIG_ADDRESS_6            0x06
#define THERMO2_CONFIG_ADDRESS_7            0x07
#define THERMO2_CONFIG_ADDRESS_8            0x08
#define THERMO2_CONFIG_ADDRESS_9            0x09
#define THERMO2_CONFIG_ADDRESS_10           0x0A
#define THERMO2_CONFIG_ADDRESS_11           0x0B
#define THERMO2_CONFIG_ADDRESS_12           0x0C
#define THERMO2_CONFIG_ADDRESS_13           0x0D
#define THERMO2_CONFIG_ADDRESS_14           0x0E
#define THERMO2_CONFIG_ADDRESS_15           0x0F
#define THERMO2_CONFIG_ADDRESS_ALL          0x10
#define THERMO2_CONFIG_ADDRESS_BIT_MASK     0x1F
#define THERMO2_CONFIG_RESOLUTION_9BIT      0x00
#define THERMO2_CONFIG_RESOLUTION_10BIT     0x20
#define THERMO2_CONFIG_RESOLUTION_11BIT     0x40
#define THERMO2_CONFIG_RESOLUTION_12BIT     0x60
#define THERMO2_CONFIG_RESOLUTION_BIT_MASK  0x60
#define THERMO2_CONFIG_RESERVED_BITS        0x10
 
#define THERMO2_DATA_RESOLUTION             0.0625
 
#define THERMO2_FAMILY_CODE                 0x3B
 
#define THERMO2_DEFAULT_ADDRESS             THERMO2_CONFIG_ADDRESS_ALL
#define THERMO2_DEFAULT_RESOLUTION          THERMO2_CONFIG_RESOLUTION_12BIT
#define THERMO2_DEFAULT_TEMP_HIGH_ALARM     0xFF
#define THERMO2_DEFAULT_TEMP_LOW_ALARM      0x00
 
 // thermo2_set
 
#define THERMO2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_AN );
 
 // thermo2_map
 // thermo2
 
typedef enum
{
    THERMO2_GPIO_0,      
    THERMO2_GPIO_1       
} thermo2_gpio_sel_t;
 
typedef struct
{
    // Modules
    one_wire_t ow;                      
    one_wire_rom_address_t rom_addr;    
    uint8_t config;                     
} thermo2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t gp0;                     
    pin_name_t gp1;                     
    thermo2_gpio_sel_t gpio_sel;        
} thermo2_cfg_t;
 
typedef enum
{
    THERMO2_OK = 0,
    THERMO2_ERROR = -1
 
} thermo2_return_value_t;
 
void thermo2_cfg_setup ( thermo2_cfg_t *cfg );
 
void thermo2_gpio_selection ( thermo2_cfg_t *cfg, thermo2_gpio_sel_t gpio_sel );
 
err_t thermo2_init ( thermo2_t *ctx, thermo2_cfg_t *cfg );
 
err_t thermo2_default_cfg ( thermo2_t *ctx );
 
err_t thermo2_check_communication ( thermo2_t *ctx );
 
err_t thermo2_select_device ( thermo2_t *ctx );
 
err_t thermo2_start_measurement ( thermo2_t *ctx );
 
err_t thermo2_read_scratchpad ( thermo2_t *ctx, uint8_t *scratchpad );
 
err_t thermo2_write_scratchpad ( thermo2_t *ctx, uint8_t temp_high, uint8_t temp_low, uint8_t config );
 
err_t thermo2_read_temperature ( thermo2_t *ctx, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // THERMO2_H
 
 // thermo2
 
// ------------------------------------------------------------------------ END