uarti2cspi 2.0.0.0
Main Page

UART I2C/SPI click

UART I2C/SPI Click is an all-in-one solution which allows ESD-protected RS-232 connectivity to any embedded application while bridging the UART and I2C/SPI interfaces at the same time. It is equipped with the DE-9 connector, so it can be easily connected.

click Product page


Click library

  • Author : MikroE Team
  • Date : Jun 2020.
  • Type : I2C/SPI type

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    ‍void uarti2cspi_cfg_setup ( uarti2cspi_cfg_t *cfg );

    - Initialization function.

    ‍UARTI2CSPI_RETVAL uarti2cspi_init ( uarti2cspi_t *ctx, uarti2cspi_cfg_t *cfg );

  • Set RST pin state function.

    ‍void uarti2cspi_set_reset ( uarti2cspi_t *ctx, uint8_t state );

Example key functions :

  • Advanced initialization function.

    ‍void uarti2cspi_advanced_init ( uarti2cspi_t *ctx, uint32_t baud_rate, uint8_t data_bits, uint8_t parity_mode, uint8_t stop_bits );

    - Uart write text function.

    ‍void uarti2cspi_uart_write_text ( uarti2cspi_t *ctx, uint8_t *w_text );

  • This function reads one byte from the click module.

    ‍uint8_t uarti2cspi_uart_read ( uarti2cspi_t *ctx );

    Examples Description

‍This example showcases how to initialize, configure and use the UART I2C/SPI click module. The click is a I2C/SPI to UART bridge interface. It requires a RS232/485 cable in order to be connected to other click module or an adapter.

The demo application is composed of two sections :

Application Init

‍Initializes the driver, configures UART, and enables UART interrupts.

void application_init ( void )
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
UARTI2CSPI_MAP_MIKROBUS( cfg, MIKROBUS_1 );
uarti2cspi_init( &uarti2cspi, &cfg );
Delay_ms ( 1000 );
Delay_ms ( 100 );
Delay_ms ( 100 );
#ifdef DEMO_APP_TRANSMITTER
log_info( &logger, "---- TRANSMITTER MODE ----" );
#endif
#ifdef DEMO_APP_RECEIVER
log_info( &logger, "---- RECEIVER MODE ----" );
#endif
Delay_ms ( 1000 );
}
#define UARTI2CSPI_UART_NOPARITY
Definition uarti2cspi.h:143
#define UARTI2CSPI_UART_8_BIT_DATA
Definition uarti2cspi.h:142
#define UARTI2CSPI_UART_ONE_STOPBIT
Definition uarti2cspi.h:148
#define UARTI2CSPI_THR_EMPTY_INT_EN
Definition uarti2cspi.h:162
#define UARTI2CSPI_RXD_INT_EN
Definition uarti2cspi.h:163
#define UARTI2CSPI_MAP_MIKROBUS(cfg, mikrobus)
Definition uarti2cspi.h:68
void uarti2cspi_cfg_setup(uarti2cspi_cfg_t *cfg)
Config Object Initialization function.
void uarti2cspi_advanced_init(uarti2cspi_t *ctx, uint32_t baud_rate, uint8_t data_bits, uint8_t parity_mode, uint8_t stop_bits)
Advanced initialization function.
UARTI2CSPI_RETVAL uarti2cspi_init(uarti2cspi_t *ctx, uarti2cspi_cfg_t *cfg)
Initialization function.
void uarti2cspi_interrupt_enable(uarti2cspi_t *ctx, uint8_t vector)
Interrupt enable function.
void application_init(void)
Definition main.c:40
Click configuration structure definition.
Definition uarti2cspi.h:225

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_TRANSMITTER
log_info( &logger, "---- The message has been sent ----" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
#endif
#ifdef DEMO_APP_RECEIVER
if ( uarti2cspi_uart_data_ready( &uarti2cspi ) )
{
uint8_t rx_data = uarti2cspi_uart_read( &uarti2cspi );
log_printf( &logger, "%c", rx_data );
}
#endif
}
void uarti2cspi_uart_write_text(uarti2cspi_t *ctx, uint8_t *w_text)
Uart write text function.
uint8_t uarti2cspi_uart_data_ready(uarti2cspi_t *ctx)
Uart data ready function.
uint8_t uarti2cspi_uart_read(uarti2cspi_t *ctx)
Uart read function.
void application_task(void)
Definition main.c:82
#define TEXT_TO_SEND
Definition main.c:33

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

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.