relay6

---

Relay 6 Click

Relay 6 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

---

Click Library

• Author : Stefan Ilic
• Date : Nov 2023.
• Type : I2C type

Software Support

Example Description

This example demonstrates the use of Relay 6 Click board by toggling the relays state.

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.Relay6

Example Key Functions

• relay6_cfg_setup Config Object Initialization function.

void relay6_cfg_setup ( relay6_cfg_t *cfg );

• relay6_init Initialization function.

err_t relay6_init ( relay6_t *ctx, relay6_cfg_t *cfg );

• relay6_default_cfg Click Default Configuration function.

err_t relay6_default_cfg ( relay6_t *ctx );

• relay6_reset_port_expander Relay 6 reset port expander function.

void relay6_reset_port_expander ( relay6_t *ctx );

• relay6_port_expander_write Relay 6 port expander write register function.

err_t relay6_port_expander_write ( relay6_t *ctx, uint8_t reg, uint8_t data_in );

• relay6_set_relay Relay 6 set relay state function.

err_t relay6_set_relay ( relay6_t *ctx, uint8_t on_relay, uint8_t off_relay );

Application Init

Initializes the driver and logger.

void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    relay6_cfg_t relay6_cfg;  /**< Click config object. */

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, " Application Init " );

    // Click initialization.
    relay6_cfg_setup( &relay6_cfg );
    RELAY6_MAP_MIKROBUS( relay6_cfg, MIKROBUS_1 );
    if ( I2C_MASTER_ERROR == relay6_init( &relay6, &relay6_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    if ( RELAY6_ERROR == relay6_default_cfg ( &relay6 ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }
    
    log_info( &logger, " Application Task " );
}

Application Task

Switches all relays state every second and displays the state on the USB UART.

void application_task ( void ) 
{
    uint8_t relay_data;
    relay_data = RELAY6_RELAY1_PIN;

    log_printf( &logger, " Turning on only Relay 1 \r\n" );
    log_printf( &logger, " = = = = = = = = = = = = = \r\n" );
    relay6_set_relay( &relay6, relay_data, ~relay_data );
    relay_data <<= 1;
    Delay_ms ( 1000 );

    log_printf( &logger, " Turning on only Relay 2 \r\n" );
    log_printf( &logger, " = = = = = = = = = = = = = \r\n" );
    relay6_set_relay( &relay6, relay_data, ~relay_data );
    relay_data <<= 1;
    Delay_ms ( 1000 );

    log_printf( &logger, " Turning on only Relay 3 \r\n" );
    log_printf( &logger, " = = = = = = = = = = = = = \r\n" );
    relay6_set_relay( &relay6, relay_data, ~relay_data );
    relay_data <<= 1;
    Delay_ms ( 1000 );

    log_printf( &logger, " Turning on only Relay 4 \r\n" );
    log_printf( &logger, " = = = = = = = = = = = = = \r\n" );
    relay6_set_relay( &relay6, relay_data, ~relay_data );
    relay_data <<= 1;
    Delay_ms ( 1000 );

}

Application Output

This Click board can be interfaced and monitored in two ways:

• Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
• UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.

---