usbcsink4  2.1.0.0
Main Page

USB-C Sink 4 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Nenad Filipovic
  • Date : Mar 2023.
  • Type : I2C type

Software Support

We provide a library for the USB-C Sink 4 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 USB-C Sink 4 Click driver.

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of a USB-C Sink 4 Click board by setting DC power requests and control for Type-C connector-equipped devices (TCD).

The demo application is composed of two sections :

Application Init

The initialization of the I2C module and log UART. After driver initialization, the app sets the default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
usbcsink4_cfg_t usbcsink4_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
usbcsink4_cfg_setup( &usbcsink4_cfg );
USBCSINK4_MAP_MIKROBUS( usbcsink4_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == usbcsink4_init( &usbcsink4, &usbcsink4_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( USBCSINK4_ERROR == usbcsink4_default_cfg ( &usbcsink4 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
log_printf( &logger, " ------------------------\r\n" );
Delay_ms( 100 );
}

Application Task

The demo app displays the reports of the Type-C port, active legacy charging mode status, and live voltage measurements on the VBUS supply for the specified port.

void application_task ( void )
{
usbcsink4_display_type_c_status( );
Delay_ms( 100 );
usbcsink4_display_chrg_mode( );
Delay_ms( 100 );
usbcsink4_display_bus_voltage( );
Delay_ms( 1000 );
}

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

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.


usbcsink4_cfg_t
USB-C Sink 4 Click configuration object.
Definition: usbcsink4.h:270
usbcsink4_get_bus_voltage
err_t usbcsink4_get_bus_voltage(usbcsink4_t *ctx, float *vbus_v)
USB-C Sink 4 get VBUS function.
usbcsink4_default_cfg
err_t usbcsink4_default_cfg(usbcsink4_t *ctx)
USB-C Sink 4 default configuration function.
application_task
void application_task(void)
Definition: main.c:96
USBCSINK4_ERROR
@ USBCSINK4_ERROR
Definition: usbcsink4.h:326
usbcsink4_event_status_t
USB-C Sink 4 Click status of the event.
Definition: usbcsink4.h:300
usbcsink4_init
err_t usbcsink4_init(usbcsink4_t *ctx, usbcsink4_cfg_t *cfg)
USB-C Sink 4 initialization function.
usbcsink4_type_c_status_t
USB-C Sink 4 Click status of the Type-C port.
Definition: usbcsink4.h:287
usbcsink4_get_event_status
err_t usbcsink4_get_event_status(usbcsink4_t *ctx, usbcsink4_event_status_t *event_status)
USB-C Sink 4 get event status function.
usbcsink4_cfg_setup
void usbcsink4_cfg_setup(usbcsink4_cfg_t *cfg)
USB-C Sink 4 configuration object setup function.
usbcsink4_t
USB-C Sink 4 Click context object.
Definition: usbcsink4.h:252
application_init
void application_init(void)
Definition: main.c:58
USBCSINK4_MAP_MIKROBUS
#define USBCSINK4_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: usbcsink4.h:238
usbcsink4_get_type_c_status
err_t usbcsink4_get_type_c_status(usbcsink4_t *ctx, usbcsink4_type_c_status_t *type_c_status)
USB-C Sink 4 get Type-C status function.