Skip to content

Latest commit

 

History

History
143 lines (97 loc) · 3.72 KB

README.md

File metadata and controls

143 lines (97 loc) · 3.72 KB
Raw

\mainpage Main Page

iqRF 2 Click

IQRF Click carries the DCTR-76DA RF transceiver, operating in the 868/916 MHz frequency.

Click Product page

Click library

  • Author : MikroE Team
  • Date : May 2020.
  • Type : UART type

Software Support

We provide a library for the iqrf2 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for iqrf2 Click driver.

Standard key functions :

  • Config Object Initialization function.

void iqrf2_cfg_setup ( iqrf2_cfg_t *cfg );

  • Initialization function.

IQRF2_RETVAL iqrf2_init ( iqrf2_t *ctx, iqrf2_cfg_t *cfg );

Example key functions :

  • Generic read function

int32_t iqrf2_generic_read ( iqrf2_t *ctx, char *data_buf, uint16_t max_len );

  • Generic write function

void iqrf2_generic_write ( iqrf2_t *ctx, char *data_buf, uint16_t len );

Examples Description

This example reads and processes data from iqRF 2 clicks.

The demo application is composed of two sections :

Application Init

Initializes the driver and makes an initial log.

void application_init ( void )
{
    log_cfg_t log_cfg;
    iqrf2_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.

    iqrf2_cfg_setup( &cfg );
    IQRF2_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    iqrf2_init( &iqrf2, &cfg );
    Delay_ms ( 100 );
    
#ifdef DEMO_APP_RECEIVER
    log_info( &logger, "---- Receiver mode ----" );
#endif    
#ifdef DEMO_APP_TRANSMITTER
    log_info( &logger, "---- Transmitter mode ----" );
#endif   
}

Application Task

Depending on the selected mode, it reads all the received data or sends the desired message every 2 seconds.

void application_task ( void )
{
#ifdef DEMO_APP_RECEIVER
    iqrf2_process( );
#endif    
    
#ifdef DEMO_APP_TRANSMITTER
    iqrf2_generic_write( &iqrf2, TEXT_TO_SEND, strlen( TEXT_TO_SEND ) );
    log_info( &logger, "---- Data sent ----" );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
#endif   
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.iqrf2

Additional notes and informations

Depending on the development board you are using, you may need USB UART Click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.