canfd5 2.0.0.0
Main Page

CAN FD 5 click

CAN FD 5 Click is a compact add-on board that contains CAN transceiver that supports both CAN and CAN FD protocols.

click Product page

Click library

  • Author : MikroE Team
  • Date : Sep 2020.
  • Type : UART type

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    ‍void canfd5_cfg_setup ( canfd5_cfg_t *cfg );

    - Initialization function.

    ‍CANFD5_RETVAL canfd5_init ( canfd5_t *ctx, canfd5_cfg_t *cfg );

    Example key functions :

  • Generic write function.

    ‍void canfd5_generic_write ( canfd5_t *ctx, char *data_buf, uint16_t len );

    - Generic read function.

    ‍int32_t canfd5_generic_read ( canfd5_t *ctx, char *data_buf, uint16_t max_len );

  • Set normal operating mode function.

    ‍void canfd5_set_normal_operating_mode ( canfd5_t *ctx );

    Examples Description

‍This is an example that demonstrates the use of the CAN FD 5 click board.

The demo application is composed of two sections :

Application Init

‍Initializes the driver and enables the click board.

void application_init ( void )
{
log_cfg_t log_cfg;
canfd5_cfg_t cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
canfd5_cfg_setup( &cfg );
CANFD5_MAP_MIKROBUS( cfg, MIKROBUS_1 );
canfd5_init( &canfd5, &cfg );
canfd5_set_normal_operating_mode( &canfd5 );
Delay_ms ( 100 );
}
CANFD5_MAP_MIKROBUS
#define CANFD5_MAP_MIKROBUS(cfg, mikrobus)
Definition canfd5.h:67
canfd5_cfg_setup
void canfd5_cfg_setup(canfd5_cfg_t *cfg)
Config Object Initialization function.
canfd5_set_normal_operating_mode
void canfd5_set_normal_operating_mode(canfd5_t *ctx)
Set normal operating mode function.
canfd5_init
CANFD5_RETVAL canfd5_init(canfd5_t *ctx, canfd5_cfg_t *cfg)
Initialization function.
application_init
void application_init(void)
Definition main.c:67
canfd5_cfg_t
Click configuration structure definition.
Definition canfd5.h:143

Application Task

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

void application_task ( void )
{
#ifdef DEMO_APP_RECEIVER
canfd5_process( );
#endif
#ifdef DEMO_APP_TRANSMITTER
canfd5_generic_write( &canfd5, TEXT_TO_SEND, 8 );
log_info( &logger, "--- The message is sent ---" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
#endif
}
canfd5_generic_write
void canfd5_generic_write(canfd5_t *ctx, char *data_buf, uint16_t len)
Generic write function.
application_task
void application_task(void)
Definition main.c:95
TEXT_TO_SEND
#define TEXT_TO_SEND
Definition main.c:32

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

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.