Skip to content

README.md

Latest commit

 

History

History
145 lines (110 loc) · 4.8 KB

README.md

File metadata and controls

145 lines (110 loc) · 4.8 KB

Expand 18 Click

Expand 18 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 Filipovic
  • Date : Apr 2024.
  • Type : SPI type

Software Support

Example Description

This example demonstrates the use of Expand 18 Click board by setting and reading the ports state.

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Expand18

Example Key Functions

  • expand18_cfg_setup Config Object Initialization function.
void expand18_cfg_setup ( expand18_cfg_t *cfg );
  • expand18_init Initialization function.
err_t expand18_init ( expand18_t *ctx, expand18_cfg_t *cfg );
  • expand18_default_cfg Click Default Configuration function.
err_t expand18_default_cfg ( expand18_t *ctx );
  • expand18_set_pin_direction This function sets the direction of the selected pins.
err_t expand18_set_pin_direction ( expand18_t *ctx, uint8_t direction, uint8_t port, uint8_t pin_mask );
  • expand18_set_all_pins_value This function sets the value of all output pins.
err_t expand18_set_all_pins_value ( expand18_t *ctx, uint8_t set_mask );
  • expand18_read_port_value This function reads the value of the selected port input pins.
err_t expand18_read_port_value ( expand18_t *ctx, uint8_t port, uint8_t *data_out );

Application Init

Initializes the driver and performs the Click default configuration which sets the port 0 as output and the port 1 as input with pull-down enabled.

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    expand18_cfg_t expand18_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.
    expand18_cfg_setup( &expand18_cfg );
    EXPAND18_MAP_MIKROBUS( expand18_cfg, MIKROBUS_POSITION_EXPAND18 );
    if ( SPI_MASTER_ERROR == expand18_init( &expand18, &expand18_cfg ) )
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    if ( EXPAND18_ERROR == expand18_default_cfg ( &expand18 ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }
    
    log_info( &logger, " Application Task " );
}

Application Task

Sets the pins of the port 0 and then reads the status of both ports and displays the results on the USB UART approximately once per second.

void application_task ( void )
{
    uint8_t port_value = 0;
    for ( uint16_t pin_num = EXPAND18_PIN_0_MASK; pin_num <= EXPAND18_PIN_7_MASK; pin_num <<= 1 )
    {
        expand18_set_all_pins_value( &expand18, pin_num );
        
        expand18_read_port_value( &expand18, EXPAND18_PORT_0, &port_value );
        log_printf( &logger, " Status port 0 (output): 0x%.2X\r\n", ( uint16_t ) port_value );
        
        expand18_read_port_value( &expand18, EXPAND18_PORT_1, &port_value );
        log_printf( &logger, " Status port 1 (input) : 0x%.2X\r\n\n", ( uint16_t ) port_value );
        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.