bee 2.0.0.0
Main Page

BEE click

BEE click features MRF24J40MA 2.4 GHz IEEE 802.15.4 radio transceiver module from Microchip.

click Product page


Click library

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

Software Support

We provide a library for the Bee 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 Bee Click driver.

Standard key functions :

  • bee_cfg_setup Config Object Initialization function.
    void bee_cfg_setup ( bee_cfg_t *cfg );
    void bee_cfg_setup(bee_cfg_t *cfg)
    Config Object Initialization function.
    Click configuration structure definition.
    Definition bee.h:245
  • bee_cfg_setup Config Object Initialization function.
    err_t bee_init ( bee_t *ctx, bee_cfg_t *cfg );
    err_t bee_init(bee_t *ctx, bee_cfg_t *cfg)
    Initialization function.
    Click ctx object definition.
    Definition bee.h:227

Example key functions :

  • bee_read_rx_fifo Read RX FIFO function
    void bee_read_rx_fifo ( bee_t *ctx, uint8_t *rx_data );
    void bee_read_rx_fifo(bee_t *ctx, uint8_t *rx_data)
    Read RX FIFO function.
  • bee_write_tx_normal_fifo Write TX normal FIFO function
    void bee_write_tx_normal_fifo ( bee_t *ctx, uint16_t address_tx_normal_fifo, uint8_t *tx_data );
    void bee_write_tx_normal_fifo(bee_t *ctx, uint16_t address_tx_normal_fifo, uint8_t *tx_data)
    Write TX normal FIFO function.

Examples Description

‍This example demonstrates the use of an BEE click board by showing the communication between the two click boards.

The demo application is composed of two sections :

Application Init

‍Initializes the driver and configures the click board.

void application_init ( void )
{
log_cfg_t log_cfg;
bee_cfg_t cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
bee_cfg_setup( &cfg );
BEE_MAP_MIKROBUS( cfg, MIKROBUS_1 );
bee_init( &bee, &cfg );
for ( uint8_t cnt = 0; cnt < 2; cnt++ )
{
short_address1[ cnt ] = 1;
short_address2[ cnt ] = 2;
pan_id1[ cnt ] = 3;
pan_id2[ cnt ] = 3;
}
for ( uint8_t cnt = 0; cnt < 8; cnt++ )
{
long_address1[ cnt ] = 1;
long_address2[ cnt ] = 2;
}
log_printf( &logger, " Reset and WakeUp \r\n" );
bee_hw_reset( &bee );
bee_soft_reset( &bee );
bee_rf_reset( &bee );
#ifdef DEMO_APP_TRANSMITTER
// Transmitter mode
log_printf( &logger, " Application Mode: Transmitter\r\n" );
tx_data_fifo[0] = BEE_HEADER_LENGHT;
tx_data_fifo[1] = BEE_HEADER_LENGHT + BEE_DATA_LENGHT;
tx_data_fifo[2] = 0x01; // control frame
tx_data_fifo[3] = 0x88;
tx_data_fifo[4] = 0x23; // sequence number
tx_data_fifo[5] = pan_id2[1]; // destinatoin pan
tx_data_fifo[6] = pan_id2[0];
tx_data_fifo[7] = short_address2[0]; // destination address
tx_data_fifo[8] = short_address2[1];
tx_data_fifo[9] = pan_id1[0]; // source pan
tx_data_fifo[10] = pan_id1[1];
tx_data_fifo[11] = short_address1[0]; // source address
tx_data_fifo[12] = short_address1[1];
memcpy( &tx_data_fifo[ 13 ], &data_tx1[ 0 ], BEE_DATA_LENGHT );
log_printf( &logger, " Set address and PAN ID \r\n" );
bee_set_long_address( &bee, &long_address1 );
bee_set_short_address( &bee, &short_address1 );
bee_set_pan_id( &bee, &pan_id1 );
#else
log_printf( &logger, " Application Mode: Receiver\r\n" );
log_printf( &logger, " Set address and PAN ID \r\n" );
bee_set_long_address( &bee, &long_address2 );
bee_set_short_address( &bee, &short_address2 );
bee_set_pan_id( &bee, &pan_id2 );
#endif
log_printf( &logger, " Init ZigBee module: \r\n" );
log_printf( &logger, " - Set nonbeacon-enabled \r\n" );
log_printf( &logger, " - Set as PAN coordinator\r\n" );
log_printf( &logger, " - Set max TX power\r\n" );
bee_set_tx_power( &bee, 31 );
log_printf( &logger, " - All frames 3, data frame\r\n" );
log_printf( &logger, " - Set normal mode\r\n" );
log_printf( &logger, " - Device Wake Up\r\n" );
bee_hw_wake_up( &bee );
bee_read_byte_short( &bee, BEE_INTSTAT ); // clears status register
Delay_1sec( );
}
#define BEE_DATA_LENGHT
Definition bee.h:201
#define BEE_HEADER_LENGHT
Definition bee.h:202
#define BEE_MAP_MIKROBUS(cfg, mikrobus)
Definition bee.h:68
void bee_soft_reset(bee_t *ctx)
Soft reset function.
void bee_set_reception_mode(bee_t *ctx, uint8_t r_mode)
Set reception mode function.
void bee_set_short_address(bee_t *ctx, uint8_t *short_address)
Set short address function.
void bee_set_pan_id(bee_t *ctx, uint8_t *pan_id)
Set PAN ID function.
void bee_hw_wake_up(bee_t *ctx)
Hardware Wake Up function.
void bee_rf_reset(bee_t *ctx)
RF state machine reset function.
uint8_t bee_read_byte_short(bee_t *ctx, uint8_t reg_address)
Read the byte of data from the short register address function.
void bee_set_tx_power(bee_t *ctx, uint8_t tx_power)
Set scale control for Tx power function.
void bee_hw_reset(bee_t *ctx)
Hardware reset function.
void bee_set_long_address(bee_t *ctx, uint8_t *long_address)
Set long address function.
void bee_nonbeacon_init(bee_t *ctx)
Initialization nonbeacon module function.
void bee_enable_immediate_wake_up(bee_t *ctx)
Enable Immediate Wake-up mode function.
void bee_set_frame_format_filter(bee_t *ctx, uint8_t fff_mode)
Set frame format filter function.
void bee_nonbeacon_pan_coordinator_device(bee_t *ctx)
Set device as PAN coordinator function.
#define BEE_INTSTAT
Definition bee.h:134
void application_init(void)
Definition main.c:49

Application Task

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

void application_task ( void )
{
#ifdef DEMO_APP_TRANSMITTER
// Transmitter mode
memcpy( &tx_data_fifo[ 13 ], &data_tx1[ 0 ], BEE_DATA_LENGHT);
bee_write_tx_normal_fifo( &bee, 0, &tx_data_fifo[ 0 ] );
log_printf( &logger, " - Sent data : " );
log_printf( &logger, "%.6s \r\n", data_tx1 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
memcpy( &tx_data_fifo[ 13 ], &data_tx2[ 0 ], BEE_DATA_LENGHT );
bee_write_tx_normal_fifo( &bee, 0, &tx_data_fifo[ 0 ] );
log_printf( &logger, " - Sent data : " );
log_printf( &logger, "%.6s \r\n", data_tx2 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
#else
// Receiver mode
bee_read_rx_fifo( &bee, &rx_data_fifo[ 0 ] );
if ( memcmp( &rx_data_fifo_old[ 0 ], &rx_data_fifo[ 0 ], BEE_DATA_LENGHT ) )
{
memcpy( &rx_data_fifo_old [ 0 ], &rx_data_fifo[ 0 ], BEE_DATA_LENGHT );
log_printf( &logger, " - Received data : " );
log_printf( &logger, "%.6s \r\n", rx_data_fifo );
Delay_ms ( 1000 );
Delay_ms ( 500 );
}
Delay_ms ( 500 );
#endif
}
void application_task(void)
Definition main.c:144

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.Bee

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.