mbusrf3 2.1.0.0
Main Page

M-BUS RF 3 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Stefan Ilic
  • Date : Jan 2024.
  • Type : UART type

Software Support

We provide a library for the M-BUS RF 3 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 from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for M-BUS RF 3 Click driver.

Standard key functions :

  • mbusrf3_cfg_setup Config Object Initialization function.
    void mbusrf3_cfg_setup(mbusrf3_cfg_t *cfg)
    M-BUS RF 3 configuration object setup function.
    M-BUS RF 3 Click configuration object.
    Definition: mbusrf3.h:145
  • mbusrf3_init Initialization function.
    err_t mbusrf3_init ( mbusrf3_t *ctx, mbusrf3_cfg_t *cfg );
    err_t mbusrf3_init(mbusrf3_t *ctx, mbusrf3_cfg_t *cfg)
    M-BUS RF 3 initialization function.
    M-BUS RF 3 Click context object.
    Definition: mbusrf3.h:124
  • mbusrf3_default_cfg Click Default Configuration function.
    err_t mbusrf3_default_cfg ( mbusrf3_t *ctx );

Example key functions :

  • mbusrf3_set_rst_pin This function is used to set reset pin state.
    void mbusrf3_set_rst_pin ( mbusrf3_t *ctx, uint8_t pin_state );
    void mbusrf3_set_rst_pin(mbusrf3_t *ctx, uint8_t pin_state)
    M-BUS RF 3 set reset pin function.
  • mbusrf3_send_command This function is used to send a desired command.
    err_t mbusrf3_send_command ( mbusrf3_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len );
    err_t mbusrf3_send_command(mbusrf3_t *ctx, uint8_t cmd, uint8_t *data_in, uint8_t len)
    M-BUS RF 3 send command function.
  • mbusrf3_send_data This function is used to data in transmitter mode.
    err_t mbusrf3_send_data ( mbusrf3_t *ctx, uint8_t *data_in, uint8_t len );
    err_t mbusrf3_send_data(mbusrf3_t *ctx, uint8_t *data_in, uint8_t len)
    M-BUS RF 3 send data function.

Example Description

This example demonstrates the use of M-BUS RF 3 click board by processing

the incoming data and displaying them on the USB UART.

The demo application is composed of two sections :

Application Init

Initializes the driver and performs the click configuration depending on selected DEMO_EXAMPLE macro.

void application_init ( void )
{
log_cfg_t log_cfg;
mbusrf3_cfg_t mbusrf3_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
mbusrf3_cfg_setup( &mbusrf3_cfg );
MBUSRF3_MAP_MIKROBUS( mbusrf3_cfg, MIKROBUS_1 );
if ( UART_ERROR == mbusrf3_init( &mbusrf3, &mbusrf3_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
mbusrf3_process( );
mbusrf3_clear_app_buf( );
Delay_ms( 500 );
mbusrf3_configure_for_example( );
log_info( &logger, " Application Task " );
}
#define MBUSRF3_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: mbusrf3.h:110
void application_init(void)
Definition: main.c:118

Application Task

This example contains two examples depending on selected DEMO_EXAMPLE macro: EXAMPLE_TRANSMIT - Device is sending MESSAGE data to be read by receiver. EXAMPLE_RECEIVER - Device is reading transmitted message, and display it on USB UART terminal.

void application_task ( void )
{
mbusrf3_example( );
}
void application_task(void)
Definition: main.c:154

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.MBUSRF3

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. UART terminal is available in all MikroElektronika compilers.