We strongly encourage users to use Package manager for sharing their code on Libstock website, because it boosts your efficiency and leaves the end user with no room for error. [more info]
Rating:
Author: MIKROE
Last Updated: 2024-10-31
Package Version: 2.1.0.15
mikroSDK Library: 2.0.0.0
Category: Sub-1 GHz Transceivers
Downloaded: 182 times
Not followed.
License: MIT license
M-BUS RF 4 Click is a mikroBUS™ add-on board with a MIPOT 32001324 RF wireless transceiver. This module operates in the 868 MHz SRD Band. Thanks to its small LCC form factor (15 x 25 mm only) and its low power consumption this module allows the implementation of highly integrated low power (battery operated) solutions for water, gas, heat or electricity metering applications, both on meter or concentrator devices.
Do you want to subscribe in order to receive notifications regarding "M-BUS RF 4 Click" changes.
Do you want to unsubscribe in order to stop receiving notifications regarding "M-BUS RF 4 Click" changes.
Do you want to report abuse regarding "M-BUS RF 4 Click".
DOWNLOAD LINK | RELATED COMPILER | CONTAINS |
---|---|---|
4047_m_bus_rf_4_click.zip [825.88KB] | mikroC AI for ARM GCC for ARM Clang for ARM mikroC AI for PIC mikroC AI for PIC32 XC32 GCC for RISC-V Clang for RISC-V mikroC AI for AVR mikroC AI for dsPIC XC16 |
|
M-BUS RF 4 Click is a mikroBUS™ add-on board with a MIPOT 32001324 RF wireless transceiver. This module operates in the 868 MHz SRD Band. Thanks to its small LCC form factor (15 x 25 mm only) and its low power consumption this module allows the implementation of highly integrated low power (battery operated) solutions for water, gas, heat or electricity metering applications, both on meter or concentrator devices.
We provide a library for the MBusRf4 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.
This library contains API for MBusRf4 Click driver.
Config Object Initialization function.
void mbusrf4_cfg_setup ( mbusrf4_cfg_t *cfg );
Initialization function.
MBUSRF4_RETVAL mbusrf4_init ( mbusrf4_t ctx, mbusrf4_cfg_t cfg );
Header and checksum are calculated and sent at the beginning (header) and finally (checksum)
void mbusrf4_send_command ( mbusrf4_t ctx, uint8_t command, uint8_t length, uint8_t payload_buff );
This function write specific number of data.
void mbusrf4_generic_write ( mbusrf4_t ctx, char data_buf, uint16_t len )
This function read data of maximum length.
uint16_t mbusrf4_generic_read ( mbusrf4_t ctx, char data_buf, uint16_t max_len );
This example reads and processes data from M-BUS RF 4 clicks.
The demo application is composed of two sections :
Initializes driver init, reads basic information and checks communication
void application_init ( void )
{
log_cfg_t log_cfg;
mbusrf4_cfg_t cfg;
uint8_t payload_buff[ 20 ] = { 0 };
/**
* 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.
mbusrf4_cfg_setup( &cfg );
MBUSRF4_MAP_MIKROBUS( cfg, MIKROBUS_1 );
mbusrf4_init( &mbusrf4, &cfg );
parser_cnt = 0;
parser_ptr = &parser_buf[ 0 ];
mbusrf4_process( );
mbrusrf4_clear_buff();
//Command SET mode
payload_buff[ 0 ] = MBUSRF4_SET_VALUE_IN_EEPROM_MEMORY;
payload_buff[ 1 ] = MBUSRF4_EEPARAM_WMBUS_MODE_S2_SHORT_PREAMBLE;
mbusrf4_send_command( &mbusrf4, MBUSRF4_CMD_SET_MODE, 2, &payload_buff[ 0 ] );
Delay_ms ( 500 );
mbusrf4_process( );
mbusrf4_parser_tx();
mbrusrf4_clear_buff();
// Reads FW version
mbusrf4_send_command( &mbusrf4, MBUSRF4_CMD_GET_FW_VERSION, 0, &payload_buff[ 0 ] );
Delay_ms ( 500 );
mbusrf4_process( );
log_info( &logger, "FW version:" );
mbusrf4_parser_rx( LOG_HEX );
log_printf( &logger, "-----------------------------------------------------------\r\n" );
mbusrf4_process( );
Delay_ms ( 1000 );
log_info( &logger, "Application Task" );
}
In the RX mode it is waiting to receive data from another module... In the TX mode sends the data packet....
void application_task ( void )
{
// RX App mode
#ifdef DEMO_APP_RECEIVER
if ( mbusrf4_get_state_ind( &mbusrf4 ) == 0 )
{
Delay_ms ( 100 );
mbusrf4_process( );
mbusrf4_parser_rx( LOG_STR );
}
#endif
// TX App Mode
#ifdef DEMO_APP_TRANSMITER
mbusrf4_transmit_data( &mbusrf4, msg, 17 );
Delay_ms ( 100 );
mbrusrf4_clear_buff();
mbusrf4_parser_tx();
Delay_ms ( 1000 );
Delay_ms ( 1000 );
#endif
}
Additional Function
mbusrf4_process ( ) - The general process of collecting data and adding it to application buffer;
mbrusrf4_clear_buff ( void ) - Clear application buffer data;
mbusrf4_parser_tx ( void ) - Transmit data status parser;
mbusrf4_parser_rx ( uint8_t logg_type ) - Receiver data parser;
mbusrf4_log_data ( uint8_t log_type, uint8_t *log_buf, int32_t log_len ) - Log application buffer;
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:
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.