thermostat4.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 THERMOSTAT4_H
#define THERMOSTAT4_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"
 
#define THERMOSTAT4_RELAY_ON                0x01
#define THERMOSTAT4_RELAY_OFF               0x00
 
#define THERMOSTAT4_RESET_ON                0x01
#define THERMOSTAT4_RESET_OFF               0x00
 
#define THERMOSTAT4_WARM_ALERT              0x00
#define THERMOSTAT4_HOT_ALERT               0x00
 
#define THERMOSTAT4_SET_DATA_SAMPLE_EDGE    SET_SPI_DATA_SAMPLE_EDGE
#define THERMOSTAT4_SET_DATA_SAMPLE_MIDDLE  SET_SPI_DATA_SAMPLE_MIDDLE
 
 // thermostat4_set
 
#define THERMOSTAT4_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.oa  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
   cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.rly = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
   cfg.ob  = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // thermostat4_map
 // thermostat4
 
typedef struct
{
    // Output pins
   digital_out_t rst;       
   digital_out_t rly;       
   digital_out_t cs;        
    // Input pins
   digital_in_t oa;         
   digital_in_t ob;         
    // Modules
    spi_master_t  spi;      
    pin_name_t  chip_select;    
} thermostat4_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   oa;          
    pin_name_t   rst;         
    pin_name_t rly;           
    pin_name_t ob;            
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} thermostat4_cfg_t;
 
typedef enum
{
    THERMOSTAT4_OK = 0,
    THERMOSTAT4_ERROR = -1
 
} thermostat4_return_value_t;
 
void thermostat4_cfg_setup ( thermostat4_cfg_t *cfg );
 
err_t thermostat4_init ( thermostat4_t *ctx, thermostat4_cfg_t *cfg );
 
void thermostat4_relay_ctrl ( thermostat4_t *ctx, uint8_t state );
 
void thermostat4_rst_pin_ctrl ( thermostat4_t *ctx, uint8_t state );
 
uint8_t thermostat4_hot_alert_state ( thermostat4_t *ctx );
 
uint8_t thermostat4_warm_alert_state ( thermostat4_t *ctx );
 
void thermostat4_set_warm_hysteresis ( thermostat4_t *ctx, uint8_t hyst_data );
 
void thermostat4_new_cfg_upload ( thermostat4_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _THERMOSTAT4_H_
 
 // thermostat 4
// ------------------------------------------------------------------------- END