proteuse  2.1.0.0
Main Page

Proteus-e click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

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

Software Support

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

Standard key functions :

Example key functions :

  • proteuse_send_cmd This function sends a desired command packet from the click context object.
  • proteuse_read_event This function reads an event packet from the ring buffer and stores it in the click context object.
  • proteuse_get_user_setting This function reads data from the desired user settings index and stores it in the click context event packet object.
    err_t proteuse_get_user_setting ( proteuse_t *ctx, uint8_t set_idx );

Example Description

This example demonstrates the use of Proteus-e click board by processing data from a connected BT device.

The demo application is composed of two sections :

Application Init

Initializes the driver, resets and configures the click board, and reads the device info.

void application_init ( void )
{
log_cfg_t log_cfg;
proteuse_cfg_t proteuse_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
proteuse_cfg_setup( &proteuse_cfg );
PROTEUSE_MAP_MIKROBUS( proteuse_cfg, MIKROBUS_1 );
if ( UART_ERROR == proteuse_init( &proteuse, &proteuse_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( PROTEUSE_ERROR == proteuse_default_cfg ( &proteuse ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_printf( &logger, ">> Get device info.\r\n" );
{
log_printf( &logger, " < OS version: 0x%.2X%.2X\r\n",
( uint16_t ) proteuse.evt_pkt.payload[ 2 ],
( uint16_t ) proteuse.evt_pkt.payload[ 1 ] );
log_printf( &logger, " Build code: 0x%.2X%.2X%.2X%.2X\r\n",
( uint16_t ) proteuse.evt_pkt.payload[ 6 ],
( uint16_t ) proteuse.evt_pkt.payload[ 5 ],
( uint16_t ) proteuse.evt_pkt.payload[ 4 ],
( uint16_t ) proteuse.evt_pkt.payload[ 3 ] );
log_printf( &logger, " Package variant: 0x%.2X%.2X\r\n",
( uint16_t ) proteuse.evt_pkt.payload[ 8 ],
( uint16_t ) proteuse.evt_pkt.payload[ 7 ] );
log_printf( &logger, " Chip ID: 0x%.2X%.2X%.2X%.2X\r\n\n",
( uint16_t ) proteuse.evt_pkt.payload[ 12 ],
( uint16_t ) proteuse.evt_pkt.payload[ 11 ],
( uint16_t ) proteuse.evt_pkt.payload[ 10 ],
( uint16_t ) proteuse.evt_pkt.payload[ 9 ] );
}
log_printf( &logger, ">> Get FW version.\r\n" );
{
log_printf( &logger, " < FW version: %u.%u.%u\r\n\n",
( uint16_t ) proteuse.evt_pkt.payload[ 3 ],
( uint16_t ) proteuse.evt_pkt.payload[ 2 ],
( uint16_t ) proteuse.evt_pkt.payload[ 1 ] );
}
log_printf( &logger, ">> Get BT MAC.\r\n" );
{
log_printf( &logger, " < BT MAC: %.2X:%.2X:%.2X:%.2X:%.2X:%.2X\r\n\n",
( uint16_t ) proteuse.evt_pkt.payload[ 6 ],
( uint16_t ) proteuse.evt_pkt.payload[ 5 ],
( uint16_t ) proteuse.evt_pkt.payload[ 4 ],
( uint16_t ) proteuse.evt_pkt.payload[ 3 ],
( uint16_t ) proteuse.evt_pkt.payload[ 2 ],
( uint16_t ) proteuse.evt_pkt.payload[ 1 ] );
}
log_printf( &logger, ">> Set device name to \"%s\".\r\n", ( char * ) DEVICE_NAME );
DEVICE_NAME, strlen ( DEVICE_NAME ) ) )
{
log_printf( &logger, " < Request received, settings set successfully\r\n\n" );
}
log_printf( &logger, ">> Get device name.\r\n" );
{
log_printf( &logger, " < Device name: \"%s\"\r\n\n", &proteuse.evt_pkt.payload[ 1 ] );
}
log_info( &logger, " Application Task " );
}

Application Task

Reads and parses all the received event packets and displays them the USB UART. All incoming data messages received from the connected device will be echoed back.

void application_task ( void )
{
if ( PROTEUSE_OK == proteuse_read_event ( &proteuse ) )
{
proteuse_parse_event ( &proteuse );
}
}

Note

We recommend using the WE Bluetooth LE Terminal smartphone application for the test.

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

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.


proteuse_cfg_t
Proteus-e Click configuration object.
Definition: proteuse.h:313
proteuse_set_user_setting
err_t proteuse_set_user_setting(proteuse_t *ctx, uint8_t set_idx, uint8_t *data_in, uint8_t len)
Proteus-e set user settings function.
PROTEUSE_MAP_MIKROBUS
#define PROTEUSE_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: proteuse.h:265
proteuse_read_event
err_t proteuse_read_event(proteuse_t *ctx)
Proteus-e read event function.
DEVICE_NAME
#define DEVICE_NAME
Definition: main.c:36
PROTEUSE_SET_IDX_RF_DEVICE_NAME
#define PROTEUSE_SET_IDX_RF_DEVICE_NAME
Definition: proteuse.h:173
PROTEUSE_SET_IDX_FS_FW_VERSION
#define PROTEUSE_SET_IDX_FS_FW_VERSION
Proteus-e user settings index list.
Definition: proteuse.h:172
application_task
void application_task(void)
Definition: main.c:180
proteuse_get_user_setting
err_t proteuse_get_user_setting(proteuse_t *ctx, uint8_t set_idx)
Proteus-e get user settings function.
proteuse_send_cmd
void proteuse_send_cmd(proteuse_t *ctx)
Proteus-e send command function.
PROTEUSE_ERROR
@ PROTEUSE_ERROR
Definition: proteuse.h:338
application_init
void application_init(void)
Definition: main.c:89
PROTEUSE_SET_IDX_FS_BTMAC
#define PROTEUSE_SET_IDX_FS_BTMAC
Definition: proteuse.h:175
proteuse_init
err_t proteuse_init(proteuse_t *ctx, proteuse_cfg_t *cfg)
Proteus-e initialization function.
proteuse_t
Proteus-e Click context object.
Definition: proteuse.h:291
PROTEUSE_SET_IDX_FS_DEVICE_INFO
#define PROTEUSE_SET_IDX_FS_DEVICE_INFO
Definition: proteuse.h:185
proteuse_cfg_setup
void proteuse_cfg_setup(proteuse_cfg_t *cfg)
Proteus-e configuration object setup function.
proteuse_default_cfg
err_t proteuse_default_cfg(proteuse_t *ctx)
Proteus-e default configuration function.
PROTEUSE_OK
@ PROTEUSE_OK
Definition: proteuse.h:337