enocan3 2.0.0.0
Main Page

EnOcean 3 click

EnOcean 3 Click carries an ultra-low power TCM515 transceiver gateway module which operates at 868MHz radio band, perfectly suited for the realization of transceiver gateways, actuators and controllers for systems communicating based on the EnOcean radio standard.

click Product page

Click library

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

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    ‍void enocan3_cfg_setup ( enocan3_cfg_t *cfg );

    - Initialization function.

    ‍ENOCEAN3_RETVAL enocan3_init ( enocan3_t *ctx, enocan3_cfg_t *cfg );

    Example key functions :

  • UART Interrupt Routine function

    ‍void enocean3_uart_isr( enocean3_t *ctx );

    - Handler Set function.

    ‍void enocean3_response_handler_set ( enocan3_t *ctx, enocean3_hdl_t handler );

  • Packet Send function.

    ‍uint8_t enocean3_send_packet( enocan3_t *ctx, enocean3_packet_t *packet );

    Examples Description

‍This example reads and processes data from EnOcean 3 clicks.

The demo application is composed of two sections :

Application Init

‍Initializes the driver and sets the driver handler.

void application_init ( void )
{
log_cfg_t log_cfg;
enocean3_cfg_t cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
enocean3_cfg_setup( &cfg );
ENOCEAN3_MAP_MIKROBUS( cfg, MIKROBUS_1 );
enocean3_init( &enocean3, &cfg );
Delay_ms ( 500 );
enocean3_response_handler_set( &enocean3, &make_response );
rsp_check = 1;
}
ENOCEAN3_MAP_MIKROBUS
#define ENOCEAN3_MAP_MIKROBUS(cfg, mikrobus)
Definition enocean3.h:67
enocean3_init
ENOCEAN3_RETVAL enocean3_init(enocean3_t *ctx, enocean3_cfg_t *cfg)
Initialization function.
enocean3_cfg_setup
void enocean3_cfg_setup(enocean3_cfg_t *cfg)
Config Object Initialization function.
enocean3_response_handler_set
void enocean3_response_handler_set(enocean3_t *ctx, enocean3_hdl_t handler)
Handler Set function.
application_init
void application_init(void)
Definition main.c:151
make_response
void make_response(enocean3_packet_t *rsp, uint16_t *rsp_length_size)
Definition main.c:44
rsp_check
uint8_t rsp_check
Definition main.c:40
enocean3_cfg_t
Click configuration structure definition.
Definition enocean3.h:190

Application Task

‍Reads the received data and parses it on the USB UART if the response buffer is ready.

void application_task ( void )
{
enocean3_uart_isr ( &enocean3 );
check_response ( );
Delay_1ms( );
}
enocean3_uart_isr
void enocean3_uart_isr(enocean3_t *ctx)
UART Interrupt Routine function.
application_task
void application_task(void)
Definition main.c:181
check_response
void check_response()
Definition main.c:137

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

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.