relay5.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 RELAY5_H
#define RELAY5_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_i2c_master.h"
 
#define RELAY5_REG_INPUT                    0x00
#define RELAY5_REG_OUTPUT                   0x01
#define RELAY5_REG_POLARITY                 0x02
#define RELAY5_REG_CONFIG                   0x03
 
 // relay5_reg
 
#define RELAY5_DEFAULT_CONFIG               0xF8
 
#define RELAY5_PIN_RL3                      0x01
#define RELAY5_PIN_RL2                      0x02
#define RELAY5_PIN_RL1                      0x04
 
#define RELAY5_PIN_STATE_LOW                0
#define RELAY5_PIN_STATE_HIGH               1
 
#define RELAY5_DEVICE_ADDRESS_A1A0_00       0x70
#define RELAY5_DEVICE_ADDRESS_A1A0_01       0x71
#define RELAY5_DEVICE_ADDRESS_A1A0_10       0x72
#define RELAY5_DEVICE_ADDRESS_A1A0_11       0x73
 
 // relay5_set
 
#define RELAY5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
 
 // relay5_map
 // relay5
 
typedef struct
{
    // Output pins
    digital_out_t rst;          
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} relay5_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t rst;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} relay5_cfg_t;
 
typedef enum
{
    RELAY5_OK = 0,
    RELAY5_ERROR = -1
 
} relay5_return_value_t;
 
void relay5_cfg_setup ( relay5_cfg_t *cfg );
 
err_t relay5_init ( relay5_t *ctx, relay5_cfg_t *cfg );
 
err_t relay5_default_cfg ( relay5_t *ctx );
 
err_t relay5_write_register ( relay5_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t relay5_read_register ( relay5_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t relay5_set_relay1_open ( relay5_t *ctx );
 
err_t relay5_set_relay1_close ( relay5_t *ctx );
 
err_t relay5_switch_relay1 ( relay5_t *ctx );
 
err_t relay5_set_relay2_open ( relay5_t *ctx );
 
err_t relay5_set_relay2_close ( relay5_t *ctx );
 
err_t relay5_switch_relay2 ( relay5_t *ctx );
 
err_t relay5_set_relay3_open ( relay5_t *ctx );
 
err_t relay5_set_relay3_close ( relay5_t *ctx );
 
err_t relay5_switch_relay3 ( relay5_t *ctx );
 
void relay5_set_rst_pin ( relay5_t *ctx, uint8_t state );
 
void relay5_reset_device ( relay5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // RELAY5_H
 
 // relay5
 
// ------------------------------------------------------------------------ END