timerrelay.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 TIMERRELAY_H
#define TIMERRELAY_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"
#include "spi_specifics.h"
 
#define TIMERRELAY_PIN_STATE_HIGH               0x01
#define TIMERRELAY_PIN_STATE_LOW                0x00
 
#define TIMERRELAY_5V_MAX_DELAY                 60
#define TIMERRELAY_3V3_MAX_DELAY                160
#define TIMERRELAY_5V_CALCULATION_MULTIPLIER    0.2353f
#define TIMERRELAY_3V3_CALCULATION_MULTIPLIER   0.6275f
 
#define TIMERRELAY_VCC_5V                       0x01
#define TIMERRELAY_VCC_3V3                      0x00
 
#define TIMERRELAY_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define TIMERRELAY_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // timerrelay_set
 
#define TIMERRELAY_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.rst  = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.trg  = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // timerrelay_map
 // timerrelay
 
typedef struct
{
    // Output pins
    digital_out_t rst;          
    digital_out_t trg;          
    // Modules
    spi_master_t spi;           
    pin_name_t   chip_select;   
    uint8_t vcc_sel;            
} timerrelay_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 rst;             
    pin_name_t trg;             
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} timerrelay_cfg_t;
 
typedef enum
{
    TIMERRELAY_OK = 0,
    TIMERRELAY_ERROR = -1
 
} timerrelay_return_value_t;
 
void timerrelay_cfg_setup ( timerrelay_cfg_t *cfg );
 
err_t timerrelay_init ( timerrelay_t *ctx, timerrelay_cfg_t *cfg );
 
err_t timerrelay_default_cfg ( timerrelay_t *ctx );
 
err_t timerrelay_generic_write ( timerrelay_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
void timerrelay_set_vcc_sel ( timerrelay_t *ctx, uint8_t vcc_sel );
 
err_t timerrelay_set_wiper_pos ( timerrelay_t *ctx, uint8_t wiper_pos );
 
err_t timerrelay_set_delay ( timerrelay_t *ctx, uint8_t delay );
 
void timerrelay_set_rst_pin ( timerrelay_t *ctx, uint8_t pin_state );
 
void timerrelay_set_trg_pin ( timerrelay_t *ctx, uint8_t pin_state );
 
void timerrelay_activate_reset ( timerrelay_t *ctx );
 
void timerrelay_activate_trigger ( timerrelay_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // TIMERRELAY_H
 
 // timerrelay
 
// ------------------------------------------------------------------------ END