nplc  2.1.0.0
Main Page

N-PLC click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

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

Software Support

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

Standard key functions :

  • nplc_cfg_setup Config Object Initialization function.
    void nplc_cfg_setup ( nplc_cfg_t *cfg );
  • nplc_init Initialization function.
    err_t nplc_init ( nplc_t *ctx, nplc_cfg_t *cfg );
  • nplc_default_cfg Click Default Configuration function.
    err_t nplc_default_cfg ( nplc_t *ctx );

Example key functions :

  • nplc_set_mode This function sets operation mode to command or data.
    void nplc_set_mode ( nplc_t *ctx, uint8_t mode );
  • nplc_generic_write This function writes a desired number of data bytes by using UART serial interface.
    err_t nplc_generic_write ( nplc_t *ctx, char *data_in, uint16_t len );
  • nplc_generic_read This function reads a desired number of data bytes by using UART serial interface.
    err_t nplc_generic_read ( nplc_t *ctx, char *data_out, uint16_t len );

Example Description

This example demonstrates the use of an N-PLC click boards by showing the communication between the two click boards configured as a receiver and transmitter.

The demo application is composed of two sections :

Application Init

Initializes the driver, resets the click board to default config, displays the firmware version and switches to data operation mode.

After that displays the selected application mode and sends an initial message in case of transmitter mode.

void application_init ( void )
{
log_cfg_t log_cfg;
nplc_cfg_t nplc_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
nplc_cfg_setup( &nplc_cfg );
NPLC_MAP_MIKROBUS( nplc_cfg, MIKROBUS_1 );
if ( UART_ERROR == nplc_init( &nplc, &nplc_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
nplc_process( );
nplc_clear_app_buf( );
log_printf( &logger, " - HW reset -\r\n" );
nplc_hw_reset ( &nplc );
nplc_display_rsp ( );
log_printf( &logger, " - Go to command mode -\r\n" );
nplc_display_rsp ( );
log_printf( &logger, " - Factory reset -\r\n" );
nplc_factory_reset ( &nplc );
nplc_display_rsp ( );
log_printf( &logger, " - Reboot -\r\n" );
nplc_sw_reset ( &nplc );
nplc_display_rsp ( );
log_printf( &logger, " - Go to command mode -\r\n" );
nplc_display_rsp ( );
log_printf( &logger, " - Show firmware version -\r\n" );
nplc_display_rsp ( );
log_printf( &logger, " - Go to data mode -\r\n" );
#ifdef DEMO_APP_TRANSMITTER
log_printf( &logger, " Application Mode: Transmitter\r\n" );
log_printf( &logger, " Sending initial message: %s", ( char * ) DEMO_TEXT_MESSAGE );
log_printf( &logger, "\r\n--------------------------------\r\n" );
Delay_ms( 1000 );
#else
log_printf( &logger, " Application Mode: Receiver\r\n" );
#endif
log_info( &logger, " Application Task " );
}

Application Task

Reads all the received data and echoes them back to the transmitter. The received and echoed messages will be displayed on the USB UART.

void application_task ( void )
{
nplc_process ( );
if ( app_buf_len > 0 )
{
Delay_ms( 500 );
nplc_process( );
log_printf( &logger, " Received message: %s", app_buf );
log_printf( &logger, "\r\n--------------------------------\r\n" );
Delay_ms( 500 );
log_printf( &logger, " Sending echo response: %s", app_buf );
nplc_generic_write( &nplc, app_buf, app_buf_len );
log_printf( &logger, "\r\n--------------------------------\r\n\n" );
nplc_clear_app_buf( );
Delay_ms( 1000 );
}
}

Note

Once both devices are programmed, one as a receiver and the other as a transmitter, you will need to reset the transmitter board in order

to start the communication by sending an initial message.

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

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.


nplc_sw_reset
void nplc_sw_reset(nplc_t *ctx)
N-PLC sw reset function.
nplc_cfg_t
N-PLC Click configuration object.
Definition: nplc.h:149
NPLC_MAP_MIKROBUS
#define NPLC_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: nplc.h:110
nplc_hw_reset
void nplc_hw_reset(nplc_t *ctx)
N-PLC hw reset function.
nplc_factory_reset
void nplc_factory_reset(nplc_t *ctx)
N-PLC factory reset function.
nplc_set_mode
void nplc_set_mode(nplc_t *ctx, uint8_t mode)
N-PLC set mode function.
nplc_t
N-PLC Click context object.
Definition: nplc.h:126
NPLC_MODE_COMMAND
#define NPLC_MODE_COMMAND
N-PLC mode selection.
Definition: nplc.h:84
application_task
void application_task(void)
Definition: main.c:142
nplc_init
err_t nplc_init(nplc_t *ctx, nplc_cfg_t *cfg)
N-PLC initialization function.
NPLC_MODE_DATA
#define NPLC_MODE_DATA
Definition: nplc.h:85
nplc_generic_read
err_t nplc_generic_read(nplc_t *ctx, char *data_out, uint16_t len)
N-PLC data reading function.
nplc_generic_write
err_t nplc_generic_write(nplc_t *ctx, char *data_in, uint16_t len)
N-PLC data writing function.
nplc_firmware_version
void nplc_firmware_version(nplc_t *ctx)
N-PLC firmware version function.
nplc_cfg_setup
void nplc_cfg_setup(nplc_cfg_t *cfg)
N-PLC configuration object setup function.
application_init
void application_init(void)
Definition: main.c:73
DEMO_TEXT_MESSAGE
#define DEMO_TEXT_MESSAGE
Definition: main.c:35