Skip to content

Latest commit

 

History

History

irbeacon

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

IR Beacon Click

IR Beacon 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 : Nikola Peric
  • Date : Feb 2022.
  • Type : PWM type

Software Support

Example Description

This library contains an API for the IrBeacon Click driver. This application is suitable for high pulse current operation.

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.IrBeacon

Example Key Functions

  • irbeacon_cfg_setup Config Object Initialization function.
void irbeacon_cfg_setup ( irbeacon_cfg_t *cfg );
  • irbeacon_init Initialization function.
err_t irbeacon_init ( irbeacon_t *ctx, irbeacon_cfg_t *cfg );
  • irbeacon_enable_mod Enable MOD function.
void irbeacon_enable_mod ( irbeacon_t *ctx );
  • irbeacon_disable_mod Disable MOD function.
void irbeacon_disable_mod ( irbeacon_t *ctx );
  • irbeacon_reset_mod Reset MOD function.
void irbeacon_reset_mod ( irbeacon_t *ctx );

Application Init

Enables GPIO and PWM, sets the frequency and duty cycle and enables PWM.

void application_init ( void )
{
    log_cfg_t log_cfg;
    irbeacon_cfg_t cfg;

    /** 
     * 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.

    irbeacon_cfg_setup( &cfg );
    IRBEACON_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    irbeacon_init( &irbeacon, &cfg );
    irbeacon_pwm_start( &irbeacon );
    
    log_info( &logger, "---- Application Task ----" );
    Delay_ms ( 1000 );
}

Application Task

This is a example which demonstrates the use of IR Beacon Click board. It shows how to enable the device and gradualy increase the duty cycle. Results are being sent to the Usart Terminal where you can track their changes.

void application_task ( void )
{
    static int8_t duty_cnt = 1;
    static int8_t duty_inc = 1;
    float duty = duty_cnt / 10.0;

    irbeacon_set_duty_cycle ( &irbeacon, duty );
    irbeacon_enable_mod( &irbeacon );
    log_printf( &logger, "Duty: %d%%\r\n", ( uint16_t )( duty_cnt * 10 ) );
    Delay_ms ( 500 );
    
    if ( 10 == duty_cnt ) 
    {
        duty_inc = -1;
    }
    else if ( 0 == duty_cnt ) 
    {
        irbeacon_disable_mod( &irbeacon );
        duty_inc = 1;
    }
    duty_cnt += duty_inc;
}

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.