Revolutionize your data communication projects with the USB to UART magic – a compact and efficient solution that connects your devices swiftly and flawlessly.
A
A
Hardware Overview
How does it work?
USB UART 5 Click is based on the CP2110, a single-chip HID USB to UART bridge controller from Silicon Labs. A USB function controller in the CP2110 is a USB 2.0-compliant, full-speed device with an integrated USB transceiver, one-time programmable ROM, and an asynchronous serial data bus (UART) in one compact package. The UART capabilities of the CP2110 include baud rate support from 300 to 1Mbps, hardware flow control, RS-485 support, and GPIO signals that are user-defined for status and control information. The USB function controller manages all data transfers between USB and UART, command requests generated by the USB host controller, and commands for controlling the function of the UARTs and GPIO pins. The CP2110 uses the standard USB HID device class, natively supported by most operating systems. A custom driver does
not need to be installed for this device. In addition, the CP2110 also supports USB Suspend and Resume modes for power management purposes. The CP2110 enters Suspend mode when Suspend signaling is detected on the bus using the SPD pin of the mikroBUS™ socket. Upon entering Suspend mode, the SPD signal is asserted, but it can also be asserted after a reset condition (RST pin) until device configuration during USB Enumeration is complete. SPD pin detects logic high level when the device is in the Suspend state and logic low when the device is in Normal mode, which is also visually indicated via red LED labeled as CONNECTED. This Click board™ also features 8 GPIO signals, located on unpopulated headers, that are user-defined for status and control information. Four GPIO signals support alternate features, including a configurable clock output
(CLK) from 24MHz to 47kHz, RS-485 transceiver control, and TX and RX LED toggle features. Also, the USB UART 5 Click can work in a USB-powered configuration thanks to the ability of the CP2110 to provide adequate power to all its parts with the help of an internal regulator using the USB bus voltage. To select this mode of operation, it is necessary to switch the jumper PWR SEL to the position marked with VBUS. This Click board™ can be operated only with a 3.3V logic voltage level. The board must perform appropriate logic voltage level conversion before using MCUs with different logic levels. Also, it comes equipped with a library containing functions and an example code that can be used as a reference for further development.
Features overview
Development board
SparkFun MicroMod mikroBUS Carrier board takes advantage of the MicroMod, Qwiic, and mikroBUS™ ecosystems making it easy to prototype with each combined rapidly. The MicroMod M.2 socket and mikroBUS™ 8-pin header allow users to experiment with any processor board in the MicroMod ecosystem and any Click board™ in the mikroBUS™ ecosystem,
respectively. This board also features two Qwiic connectors to seamlessly integrate hundreds of Qwiic sensors and accessories into your project. The mikroBUS™ socket comprises a pair of 8-pin female headers with a standardized pin configuration. The pins consist of three groups of communications pins (SPI, UART, and I2C), six additional pins (PWM, Interrupt, Analog input,
Reset, and Chip select), and two power groups (3.3V and 5V). While a modern USB-C connector makes programming easy, the Carrier Board is also equipped with an MCP73831 single-cell Lithium-Ion/Lithium-Polymer charge IC so you can charge an attached single-cell Li-Po battery. The charge IC receives power from the USB connection and can source up to 450mA to charge an attached battery.
Microcontroller Overview
MCU Card / MCU
Architecture
ARM Cortex-M4
MCU Memory (KB)
1024
Silicon Vendor
STMicroelectronics
Pin count
64
RAM (Bytes)
196608
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Schematic
Step by step
Project assembly
Track your results in real time
Application Output via Debug Mode
1. Once the code example is loaded, pressing the "DEBUG" button initiates the build process, programs it on the created setup, and enters Debug mode.
2. After the programming is completed, a header with buttons for various actions within the IDE becomes visible. Clicking the green "PLAY" button starts reading the results achieved with the Click board™. The achieved results are displayed in the Application Output tab.
Software Support
Library Description
This library contains API for USB UART 5 Click driver.
Key functions:
usbuart5_generic_write
- USB UART 5 data writing function.usbuart5_generic_read
- USB UART 5 data reading function.usbuart5_reset_device
- USB UART 5 reset the device function.
Open Source
Code example
This example can be found in NECTO Studio. Feel free to download the code, or you can copy the code below.
/*!
* @file main.c
* @brief USB UART 5 Click Example.
*
* # Description
* This example reads and processes data from USB UART 5 Click board™.
* The library initializes and defines the UART bus drivers
* to transmit or receive data.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes driver, wake-up module, and performs the default configuration.
*
* ## Application Task
* Any data which the host PC sends via HidUartExample
* will be sent over USB to the click board and then it will be read and
* echoed back by the MCU to the PC where the terminal program will display it.
* Results are being sent to the UART Terminal, where you can track their changes.
*
* @note
* Make sure to download and install
* CP2110/4 Software package for Windows/Mac/Linux on the host PC.
*
* @author Nenad Filipovic
*
*/
#include "board.h"
#include "log.h"
#include "usbuart5.h"
static usbuart5_t usbuart5;
static log_t logger;
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
usbuart5_cfg_t usbuart5_cfg; /**< Click config object. */
/**
* Logger initialization.
* Default baud rate: 115200
* Default log level: LOG_LEVEL_DEBUG
* @note If USB_UART_RX and USB_UART_TX
* are defined as HAL_PIN_NC, you will
* need to define them manually for log to work.
* See @b LOG_MAP_USB_UART macro definition for detailed explanation.
*/
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
usbuart5_cfg_setup( &usbuart5_cfg );
USBUART5_MAP_MIKROBUS( usbuart5_cfg, MIKROBUS_1 );
if ( UART_ERROR == usbuart5_init( &usbuart5, &usbuart5_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
usbuart5_default_cfg ( &usbuart5 );
log_info( &logger, " Application Task " );
}
void application_task ( void )
{
char rx_data = 0;
if ( usbuart5_generic_read ( &usbuart5, &rx_data, 1 ) )
{
if ( usbuart5_generic_write ( &usbuart5, &rx_data, 1 ) )
{
log_printf( &logger, "%c", rx_data );
}
}
}
void main ( void )
{
application_init( );
for ( ; ; )
{
application_task( );
}
}
// ------------------------------------------------------------------------ END
Additional Support
Resources
Category:USB