neomesh2  2.1.0.0
Main Page

NeoMesh 2 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Stefan Filipovic
  • Date : Sep 2023.
  • Type : UART type

Software Support

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

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of NeoMesh 2 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 for the selected application mode.

void application_init ( void )
{
log_cfg_t log_cfg;
neomesh2_cfg_t neomesh2_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
neomesh2_cfg_setup( &neomesh2_cfg );
NEOMESH2_MAP_MIKROBUS( neomesh2_cfg, MIKROBUS_1 );
if ( UART_ERROR == neomesh2_init( &neomesh2, &neomesh2_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
log_printf( &logger, "\r\n Enable SAPI over AAPI\r\n" );
aapi_frame.cmd = NEOMESH2_CMD_SAPI_TO_AAPI;
aapi_frame.len = 0;
neomesh2_send_aapi_frame ( &neomesh2, &aapi_frame );
neomesh2_parse_sapi_rsp ( NEOMESH2_SAPI_RSP_BOOTLOADER_START );
log_printf( &logger, "\r\n Login with password\r\n" );
sapi_frame.cmd = NEOMESH2_SAPI_CMD_LOGIN;
sapi_frame.len = 5;
sapi_frame.payload[ 0 ] = NEOMESH2_SAPI_LOGIN_PASSWORD_0;
sapi_frame.payload[ 1 ] = NEOMESH2_SAPI_LOGIN_PASSWORD_1;
sapi_frame.payload[ 2 ] = NEOMESH2_SAPI_LOGIN_PASSWORD_2;
sapi_frame.payload[ 3 ] = NEOMESH2_SAPI_LOGIN_PASSWORD_3;
sapi_frame.payload[ 4 ] = NEOMESH2_SAPI_LOGIN_PASSWORD_4;
neomesh2_send_sapi_frame ( &neomesh2, &sapi_frame );
neomesh2_parse_sapi_rsp ( NEOMESH2_SAPI_RSP_OK );
log_printf( &logger, "\r\n Set NODE ID to: " );
sapi_frame.len = 3;
sapi_frame.payload[ 0 ] = NEOMESH2_SAPI_SETTINGS_ID_NODE_ID;
#if ( DEMO_APP == APP_RECEIVER_1 )
log_printf( &logger, "%.4X\r\n", ( uint16_t ) NODE_ID_RECEIVER_1 );
sapi_frame.payload[ 1 ] = ( uint8_t ) ( ( NODE_ID_RECEIVER_1 >> 8 ) & 0xFF );
sapi_frame.payload[ 2 ] = ( uint8_t ) ( NODE_ID_RECEIVER_1 & 0xFF );
#elif ( DEMO_APP == APP_RECEIVER_2 )
log_printf( &logger, "%.4X\r\n", ( uint16_t ) NODE_ID_RECEIVER_2 );
sapi_frame.payload[ 1 ] = ( uint8_t ) ( ( NODE_ID_RECEIVER_2 >> 8 ) & 0xFF );
sapi_frame.payload[ 2 ] = ( uint8_t ) ( NODE_ID_RECEIVER_2 & 0xFF );
#elif ( DEMO_APP == APP_ORIGINATOR )
log_printf( &logger, "%.4X\r\n", ( uint16_t ) NODE_ID_ORIGINATOR );
sapi_frame.payload[ 1 ] = ( uint8_t ) ( ( NODE_ID_ORIGINATOR >> 8 ) & 0xFF );
sapi_frame.payload[ 2 ] = ( uint8_t ) ( NODE_ID_ORIGINATOR & 0xFF );
#endif
neomesh2_send_sapi_frame ( &neomesh2, &sapi_frame );
neomesh2_parse_sapi_rsp ( NEOMESH2_SAPI_RSP_OK );
log_printf( &logger, "\r\n Commit settings\r\n" );
sapi_frame.len = 0;
neomesh2_send_sapi_frame ( &neomesh2, &sapi_frame );
neomesh2_parse_sapi_rsp ( NEOMESH2_SAPI_RSP_OK );
log_printf( &logger, "\r\n Start protocol stack\r\n" );
sapi_frame.len = 0;
neomesh2_send_sapi_frame ( &neomesh2, &sapi_frame );
neomesh2_parse_sapi_rsp ( NEOMESH2_SAPI_RSP_PROTOCOL_STACK_START );
// Wait for the device to actually switch back to application layer
while ( !neomesh2_get_cts_pin ( &neomesh2 ) );
log_printf( &logger, "\r\n Get NODE info\r\n" );
aapi_frame.cmd = NEOMESH2_CMD_NODE_INFO;
aapi_frame.len = 0;
neomesh2_send_aapi_frame ( &neomesh2, &aapi_frame );
neomesh2_parse_aapi_rsp ( NEOMESH2_RSP_NODE_INFO );
log_printf( &logger, "\r\n Get neighbour list\r\n" );
aapi_frame.cmd = NEOMESH2_CMD_NEIGHBOUR_LIST;
aapi_frame.len = 0;
neomesh2_send_aapi_frame ( &neomesh2, &aapi_frame );
neomesh2_parse_aapi_rsp ( NEOMESH2_RSP_NEIGHBOUR_LIST );
#if ( DEMO_APP == APP_RECEIVER_1 )
log_printf( &logger, "\r\n Application Mode: Receiver 1\r\n" );
#elif ( DEMO_APP == APP_RECEIVER_2 )
log_printf( &logger, "\r\n Application Mode: Receiver 2\r\n" );
#elif ( DEMO_APP == APP_ORIGINATOR )
log_printf( &logger, "\r\n Application Mode: Originator\r\n" );
#else
#error "Selected application mode is not supported!"
#endif
log_info( &logger, " Application Task " );
}

Application Task

One click board should be set to originator mode and the others to receiver 1 or 2.

If the SINGLE_RECEIVER_MODE is enabled, the originator device sends a desired message to RECEIVER_1 node and waits for an acknowledge response, otherwise it sends the same message to both RECEIVER_1 and RECEIVER_2 nodes. The receiver devices reads and parses all incoming AAPI frames and displays them on the USB UART.

void application_task ( void )
{
#if ( DEMO_APP == APP_ORIGINATOR )
log_printf( &logger, "\r\n Send message to node: %.4X\r\n", ( uint16_t ) NODE_ID_RECEIVER_1 );
aapi_frame.cmd = NEOMESH2_CMD_ACK_SEND;
aapi_frame.len = 3 + strlen ( DEMO_TEXT_MESSAGE );
aapi_frame.payload[ 0 ] = ( uint8_t ) ( ( NODE_ID_RECEIVER_1 >> 8 ) & 0xFF );
aapi_frame.payload[ 1 ] = ( uint8_t ) ( NODE_ID_RECEIVER_1 & 0xFF );
aapi_frame.payload[ 2 ] = DEFAULT_PORT;
strcpy ( &aapi_frame.payload[ 3 ], DEMO_TEXT_MESSAGE );
if ( NEOMESH2_OK == neomesh2_send_aapi_frame ( &neomesh2, &aapi_frame ) )
{
neomesh2_parse_aapi_rsp ( NEOMESH2_RSP_ACK );
}
#ifndef SINGLE_RECEIVER_MODE
log_printf( &logger, "\r\n Send message to node: %.4X\r\n", ( uint16_t ) NODE_ID_RECEIVER_2 );
aapi_frame.cmd = NEOMESH2_CMD_ACK_SEND;
aapi_frame.len = 3 + strlen ( DEMO_TEXT_MESSAGE );
aapi_frame.payload[ 0 ] = ( uint8_t ) ( ( NODE_ID_RECEIVER_2 >> 8 ) & 0xFF );
aapi_frame.payload[ 1 ] = ( uint8_t ) ( NODE_ID_RECEIVER_2 & 0xFF );
aapi_frame.payload[ 2 ] = DEFAULT_PORT;
strcpy ( &aapi_frame.payload[ 3 ], DEMO_TEXT_MESSAGE );
if ( NEOMESH2_OK == neomesh2_send_aapi_frame ( &neomesh2, &aapi_frame ) )
{
neomesh2_parse_aapi_rsp ( NEOMESH2_RSP_ACK );
}
#endif
#else
neomesh2_parse_aapi_rsp ( NULL );
#endif
}

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

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.


NEOMESH2_SAPI_CMD_START_PROTOCOL_STACK
#define NEOMESH2_SAPI_CMD_START_PROTOCOL_STACK
Definition: neomesh2.h:105
DEFAULT_PORT
#define DEFAULT_PORT
Definition: main.c:41
neomesh2_sapi_frame_t
NeoMesh 2 Click data frame object.
Definition: neomesh2.h:254
neomesh2_cfg_setup
void neomesh2_cfg_setup(neomesh2_cfg_t *cfg)
NeoMesh 2 configuration object setup function.
neomesh2_get_cts_pin
uint8_t neomesh2_get_cts_pin(neomesh2_t *ctx)
NeoMesh 2 get cts pin function.
NEOMESH2_SAPI_CMD_COMMIT_SETTINGS
#define NEOMESH2_SAPI_CMD_COMMIT_SETTINGS
Definition: neomesh2.h:102
NEOMESH2_SAPI_RSP_OK
#define NEOMESH2_SAPI_RSP_OK
NeoMesh 2 system data response.
Definition: neomesh2.h:114
NEOMESH2_SAPI_LOGIN_PASSWORD_1
#define NEOMESH2_SAPI_LOGIN_PASSWORD_1
Definition: neomesh2.h:128
NEOMESH2_RSP_ACK
#define NEOMESH2_RSP_ACK
NeoMesh 2 application data response.
Definition: neomesh2.h:76
NEOMESH2_SAPI_CMD_SET_SETTING
#define NEOMESH2_SAPI_CMD_SET_SETTING
Definition: neomesh2.h:104
neomesh2_read_aapi_frame
err_t neomesh2_read_aapi_frame(neomesh2_t *ctx, neomesh2_aapi_frame_t *frame)
NeoMesh 2 read aapi frame function.
neomesh2_t
NeoMesh 2 Click context object.
Definition: neomesh2.h:192
NEOMESH2_MAP_MIKROBUS
#define NEOMESH2_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: neomesh2.h:175
NEOMESH2_CMD_NODE_INFO
#define NEOMESH2_CMD_NODE_INFO
Definition: neomesh2.h:62
NEOMESH2_SAPI_LOGIN_PASSWORD_4
#define NEOMESH2_SAPI_LOGIN_PASSWORD_4
Definition: neomesh2.h:131
application_task
void application_task(void)
Definition: main.c:178
NEOMESH2_SAPI_LOGIN_PASSWORD_3
#define NEOMESH2_SAPI_LOGIN_PASSWORD_3
Definition: neomesh2.h:130
NEOMESH2_RSP_NODE_INFO
#define NEOMESH2_RSP_NODE_INFO
Definition: neomesh2.h:84
NEOMESH2_CMD_SAPI_TO_AAPI
#define NEOMESH2_CMD_SAPI_TO_AAPI
Definition: neomesh2.h:65
NEOMESH2_SAPI_SETTINGS_ID_NODE_ID
#define NEOMESH2_SAPI_SETTINGS_ID_NODE_ID
NeoMesh 2 SAPI settings ID.
Definition: neomesh2.h:137
NEOMESH2_SAPI_RSP_BOOTLOADER_START
#define NEOMESH2_SAPI_RSP_BOOTLOADER_START
Definition: neomesh2.h:116
NEOMESH2_SAPI_RSP_PROTOCOL_STACK_START
#define NEOMESH2_SAPI_RSP_PROTOCOL_STACK_START
Definition: neomesh2.h:117
neomesh2_send_sapi_frame
err_t neomesh2_send_sapi_frame(neomesh2_t *ctx, neomesh2_sapi_frame_t *frame)
NeoMesh 2 send sapi frame function.
NEOMESH2_OK
@ NEOMESH2_OK
Definition: neomesh2.h:267
neomesh2_aapi_frame_t
NeoMesh 2 Click data frame object.
Definition: neomesh2.h:242
NEOMESH2_CMD_ACK_SEND
#define NEOMESH2_CMD_ACK_SEND
Definition: neomesh2.h:60
NEOMESH2_SAPI_LOGIN_PASSWORD_0
#define NEOMESH2_SAPI_LOGIN_PASSWORD_0
NeoMesh 2 login password settings.
Definition: neomesh2.h:127
NEOMESH2_CMD_NEIGHBOUR_LIST
#define NEOMESH2_CMD_NEIGHBOUR_LIST
Definition: neomesh2.h:63
NODE_ID_ORIGINATOR
#define NODE_ID_ORIGINATOR
Definition: main.c:44
NEOMESH2_SAPI_LOGIN_PASSWORD_2
#define NEOMESH2_SAPI_LOGIN_PASSWORD_2
Definition: neomesh2.h:129
application_init
void application_init(void)
Definition: main.c:75
neomesh2_cfg_t
NeoMesh 2 Click configuration object.
Definition: neomesh2.h:216
NODE_ID_RECEIVER_1
#define NODE_ID_RECEIVER_1
Definition: main.c:45
NODE_ID_RECEIVER_2
#define NODE_ID_RECEIVER_2
Definition: main.c:46
neomesh2_send_aapi_frame
err_t neomesh2_send_aapi_frame(neomesh2_t *ctx, neomesh2_aapi_frame_t *frame)
NeoMesh 2 send aapi frame function.
DEMO_TEXT_MESSAGE
#define DEMO_TEXT_MESSAGE
Definition: main.c:40
neomesh2_init
err_t neomesh2_init(neomesh2_t *ctx, neomesh2_cfg_t *cfg)
NeoMesh 2 initialization function.
NEOMESH2_RSP_NEIGHBOUR_LIST
#define NEOMESH2_RSP_NEIGHBOUR_LIST
Definition: neomesh2.h:85
NEOMESH2_SAPI_CMD_LOGIN
#define NEOMESH2_SAPI_CMD_LOGIN
NeoMesh 2 SAPI control commands.
Definition: neomesh2.h:97