thermostat2.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 THERMOSTAT2_H
#define THERMOSTAT2_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 THERMOSTAT2_CMD_WRITE_SCRATCHPAD          0x4E
#define THERMOSTAT2_CMD_READ_SCRATCHPAD           0xBE
#define THERMOSTAT2_CMD_COPY_SCRATCHPAD           0x48
#define THERMOSTAT2_CMD_CONVERT_TEMPERATURE       0x44
#define THERMOSTAT2_CMD_RECALL_SCRATCHPAD         0xB8
#define THERMOSTAT2_CMD_READ_POWER_SUPPLY         0xB4
 
 // thermostat2_cmd
 
#define THERMOSTAT2_CONFIG_RESOLUTION_9BIT        0x00
#define THERMOSTAT2_CONFIG_RESOLUTION_10BIT       0x20
#define THERMOSTAT2_CONFIG_RESOLUTION_11BIT       0x40
#define THERMOSTAT2_CONFIG_RESOLUTION_12BIT       0x60
#define THERMOSTAT2_CONFIG_RESOLUTION_BIT_MASK    0x60
#define THERMOSTAT2_CONFIG_RESERVED_BITS          0x1F
 
#define THERMOSTAT2_FAMILY_CODE                   0x10
 
#define THERMOSTAT2_RESOLUTION_9BIT               0.5
#define THERMOSTAT2_RESOLUTION_10BIT              0.25
#define THERMOSTAT2_RESOLUTION_11BIT              0.125
#define THERMOSTAT2_RESOLUTION_12BIT              0.0625
 
#define THERMOSTAT2_DEFAULT_RESOLUTION            THERMOSTAT2_CONFIG_RESOLUTION_9BIT
#define THERMOSTAT2_DEFAULT_TEMP_HIGH_ALARM       0xFF
#define THERMOSTAT2_DEFAULT_TEMP_LOW_ALARM        0x00
 
#define THERMOSTAT2_RELAY_ON                      0x01
#define THERMOSTAT2_RELAY_OFF                     0x00
#define THERMOSTAT2_TEMPERATURE_LIMIT             28.0
 
 // thermostat2_set
 
#define THERMOSTAT2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.gp0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); 
 
 // thermostat2_map
 // thermostat2
 
typedef struct
{
    digital_out_t cs;                   
    // Modules
    one_wire_t ow;                      
    one_wire_rom_address_t rom_addr;    
    uint8_t config;                     
} thermostat2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t gp0;                     
    pin_name_t cs;                      
} thermostat2_cfg_t;
 
typedef enum
{
    THERMOSTAT2_OK = 0,
    THERMOSTAT2_ERROR = -1
 
} thermostat2_return_value_t;
 
void thermostat2_cfg_setup ( thermostat2_cfg_t *cfg );
 
err_t thermostat2_init ( thermostat2_t *ctx, thermostat2_cfg_t *cfg );
 
err_t thermostat2_default_cfg ( thermostat2_t *ctx );
 
err_t thermostat2_check_communication ( thermostat2_t *ctx );
 
err_t thermostat2_read_scratchpad ( thermostat2_t *ctx, uint8_t *scratchpad ); 
 
err_t thermostat2_write_scratchpad ( thermostat2_t *ctx, uint8_t temp_high, uint8_t temp_low, uint8_t config ); 
 
err_t thermostat2_start_measurement ( thermostat2_t *ctx ); 
 
void thermostat2_relay_state ( thermostat2_t *ctx, uint8_t state );
 
err_t thermostat2_read_temperature ( thermostat2_t *ctx, float *temperature ); 
 
#ifdef __cplusplus
}
#endif
#endif // THERMOSTAT2_H
 
 // thermostat2
 
// ------------------------------------------------------------------------ END