Intermediate
20 min
0

Transform yourself into the ultimate tech provider using STUSB4700 and PIC18F86J55

One charger to rule them all

USB-C Source Click with UNI-DS v8

Published Nov 11, 2023

Click board™

USB-C Source Click

Development board

UNI-DS v8

Compiler

NECTO Studio

MCU

PIC18F86J55

Simplify your life with a single USB-C Source charger that can power up all your devices with ease.

A

A

Hardware Overview

How does it work?

USB-C Source Click is based on the STUSB4700, a standalone autonomous USB power delivery controller optimized as a provider to negotiate a given amount of power to be sourced to an inquiring consumer device from STMicroelectronics. Combining high-voltage capability with low power consumption, the STUSB4700 can be safely used in systems that handle high voltage on the VBUS power path. The device integrates internal circuitry on the CC pins that tolerate high voltage and ensures protection up to 22 V in case of an unexpected short circuit with VBUS or in case of connection to a device supplying high voltage on VBUS. This Click board™ is powered from an external power supply voltage terminal to which a fixed voltage value of 24V is applied. After that, an input supply voltage goes through the ST1S14, a step-down monolithic power switching regulator able to deliver up to 3A DC current to the load depending on the application conditions also from

STMicroelectronics. This buck regulator establishes communication with another Sink device via a USB connector representing a Power Delivery Output Connector. In the source power role, the STUSB4700's VBUS_EN_SRC pin enables the outgoing VBUS power when the connection to a sink is established and VBUS is in the valid operating range. The open-drain output allows a PMOS transistor to be driven directly. It also has the VBUS_SENSE pin used to sense VBUS presence, monitor VBUS voltage, and discharge VBUS on the USB Type-C receptacle side. The STUSB4700 communicates with MCU using the standard I2C 2-wire interface that supports transfers up to 400kbit/s (Fast Mode) to configure, control, and read the device's status. It also has the possibility of the USB Power Delivery communication over CC1 and CC2 configuration channel pins used for connection and attachment detection, plug orientation determination, and system configuration management across USB

Type-C cables. Two addresses are available by default (0x28 and 0x29) depending on the setting of the address pin ADDR0 of the STUSB4700 programmed by the user, which determines the LSB of the slave address, and it can be selected by the onboard SMD jumper labeled as ADDR SEL allowing selection of the slave address LSB. Additional functionality, such as Reset and 'Alert' interrupt, is provided and routed at RST and INT pins of the mikroBUS™ socket. The RST pin resets all analog signals, states machine, and reloads configuration, while an interrupt output labeled INT represents alarm output. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the VCC SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. Also, this Click board™ comes equipped with a library containing easy-to-use functions and an example code that can be used for further development.

USB-C Source Click hardware overview image

Features overview

Development board

UNI-DS v8 is a development board specially designed for the needs of rapid development of embedded applications. It supports a wide range of microcontrollers, such as different STM32, Kinetis, TIVA, CEC, MSP, PIC, dsPIC, PIC32, and AVR MCUs regardless of their number of pins, and a broad set of unique functions, such as the first-ever embedded debugger/programmer over WiFi. The development board is well organized and designed so that the end-user has all the necessary elements, such as switches, buttons, indicators, connectors, and others, in one place. Thanks to innovative manufacturing technology, UNI-DS v8 provides a fluid and immersive working experience, allowing access anywhere and under any

circumstances at any time. Each part of the UNI-DS v8 development board contains the components necessary for the most efficient operation of the same board. An advanced integrated CODEGRIP programmer/debugger module offers many valuable programming/debugging options, including support for JTAG, SWD, and SWO Trace (Single Wire Output)), and seamless integration with the Mikroe software environment. Besides, it also includes a clean and regulated power supply module for the development board. It can use a wide range of external power sources, including a battery, an external 12V power supply, and a power source via the USB Type-C (USB-C) connector. Communication options such as USB-UART, USB

HOST/DEVICE, CAN (on the MCU card, if supported), and Ethernet is also included. In addition, it also has the well-established mikroBUS™ standard, a standardized socket for the MCU card (SiBRAIN standard), and two display options for the TFT board line of products and character-based LCD. UNI-DS v8 is an integral part of the Mikroe ecosystem for rapid development. Natively supported by Mikroe software tools, it covers many aspects of prototyping and development thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

UNI-DS v8 horizontal image

Microcontroller Overview

MCU Card / MCU

default

Type

8th Generation

Architecture

PIC

MCU Memory (KB)

96

Silicon Vendor

Microchip

Pin count

80

RAM (Bytes)

3904

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
Reset
PJ4
RST
NC
NC
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
NC
NC
PWM
Interrupt
PB0
INT
NC
NC
TX
NC
NC
RX
I2C Clock
PC3
SCL
I2C Data
PC4
SDA
Power Supply
5V
5V
Ground
GND
GND
1

Take a closer look

Schematic

USB-C Source Click Schematic schematic

Step by step

Project assembly

Fusion for PIC v8 front image hardware assembly

Start by selecting your development board and Click board™. Begin with the UNI-DS v8 as your development board.

Fusion for PIC v8 front image hardware assembly
GNSS2 Click front image hardware assembly
SiBRAIN for PIC32MZ1024EFK144 front image hardware assembly
GNSS2 Click complete accessories setup image hardware assembly
v8 SiBRAIN Access MB 1 - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
NECTO Compiler Selection Step Image hardware assembly
NECTO Output Selection Step Image hardware assembly
Necto image step 6 hardware assembly
Necto image step 7 hardware assembly
Necto image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Necto PreFlash Image hardware assembly

Track your results in real time

Application Output

After pressing the "FLASH" button on the left-side panel, it is necessary to open the UART terminal to display the achieved results. By clicking on the Tools icon in the right-hand panel, multiple different functions are displayed, among which is the UART Terminal. Click on the offered "UART Terminal" icon.

UART Application Output Step 1

Once the UART terminal is opened, the window takes on a new form. At the top of the tab are two buttons, one for adjusting the parameters of the UART terminal and the other for connecting the UART terminal. The tab's lower part is reserved for displaying the achieved results. Before connecting, the terminal has a Disconnected status, indicating that the terminal is not yet active. Before connecting, it is necessary to check the set parameters of the UART terminal. Click on the "OPTIONS" button.

UART Application Output Step 2

In the newly opened UART Terminal Options field, we check if the terminal settings are correct, such as the set port and the Baud rate of UART communication. If the data is not displayed properly, it is possible that the Baud rate value is not set correctly and needs to be adjusted to 115200. If all the parameters are set correctly, click on "CONFIGURE".

UART Application Output Step 3

The next step is to click on the "CONNECT" button, after which the terminal status changes from Disconnected to Connected in green, and the data is displayed in the Received data field.

UART Application Output Step 4

Software Support

Library Description

This library contains API for USB-C Source Click driver.

Key functions:

  • usbcsource_hw_reset - HW reset function.

  • usbcsource_get_alert_status - Get alert status function.

  • usbcsource_set_pdo_config - Set PDO configuration 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 USBCSource Click example
 *
 * # Description
 * This is an example that demonstrates the use of the USB-C Source Click board.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Initialization driver enables - I2C, set hardware reset and default configuration 
 * and display configuration of the five PDOs, also write log.
 *
 * ## Application Task
 * In this example, we show port status, monitoring, and connections.
 * All data logs write on USB uart changes every 5 sec.
 * 
 * Additional Functions :
 * - void display_port_status ( ) - Display port status info.
 * - void display_monitoring_status ( ) - Display monitoring status info.
 * - void display_connection_status ( ) - Display connection status info.
 *
 * @author Stefan Ilic
 *
 */

#include "board.h"
#include "log.h"
#include "usbcsource.h"

static usbcsource_t usbcsource;
static log_t logger;

port_status_t port_status;
monitor_status_t monitor_status;
connection_status_t conn_status;
pdo_config_t pdo_data;

/**
 * @brief USB-C Source display port status.
 * @details This function is used for displaying port status.
 */
void display_port_status ( void );

/**
 * @brief USB-C Source display monitoring status.
 * @details This function is used for displaying monitoring status.
 */
void display_monitoring_status ( void );

/**
 * @brief USB-C Source display connection status.
 * @details This function is used for displaying connection status.
 */
void display_connection_status ( void );

void application_init ( void ) {
    log_cfg_t log_cfg;  /**< Logger config object. */
    usbcsource_cfg_t usbcsource_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.
    usbcsource_cfg_setup( &usbcsource_cfg );
    USBCSOURCE_MAP_MIKROBUS( usbcsource_cfg, MIKROBUS_1 );
    err_t init_flag = usbcsource_init( &usbcsource, &usbcsource_cfg );
    if ( I2C_MASTER_ERROR == init_flag ) {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

    usbcsource_hw_reset( &usbcsource );
    Delay_ms( 500 );
    usbcsource_default_config( &usbcsource );
    Delay_ms( 500 );
    log_printf( &logger, "- - - - - - - - - - - - - -\r\n" );
    
    usbcsource_get_pdo_config( &usbcsource, USBCSOURCE_SEL_PDO1, &pdo_data );
    log_printf( &logger, " PDO 1 - Voltage = %.2f V \r\n", pdo_data.vtg_data );
    log_printf( &logger, " PDO 1 - Current = %.2f A \r\n", pdo_data.curr_data );
    log_printf( &logger, "- - - - - - - - - - - - - -\r\n" );
    
    usbcsource_get_pdo_config( &usbcsource, USBCSOURCE_SEL_PDO2, &pdo_data );
    log_printf( &logger, " PDO 2 - Voltage = %.2f V \r\n", pdo_data.vtg_data );
    log_printf( &logger, " PDO 2 - Current = %.2f A \r\n", pdo_data.curr_data );
    log_printf( &logger, "- - - - - - - - - - - - - -\r\n" );
    
    usbcsource_get_pdo_config( &usbcsource, USBCSOURCE_SEL_PDO3, &pdo_data );
    log_printf( &logger, " PDO 3 - Voltage = %.2f V \r\n", pdo_data.vtg_data );
    log_printf( &logger, " PDO 3 - Current = %.2f A \r\n", pdo_data.curr_data );
    log_printf( &logger, "- - - - - - - - - - - - - -\r\n" );
    
    usbcsource_get_pdo_config( &usbcsource, USBCSOURCE_SEL_PDO4, &pdo_data );
    log_printf( &logger, " PDO 4 - Voltage = %.2f V \r\n", pdo_data.vtg_data );
    log_printf( &logger, " PDO 4 - Current = %.2f A \r\n", pdo_data.curr_data );
    log_printf( &logger, "- - - - - - - - - - - - - -\r\n" );
    
    usbcsource_get_pdo_config( &usbcsource, USBCSOURCE_SEL_PDO5, &pdo_data );
    log_printf( &logger, " PDO 5 - Voltage = %.2f V \r\n", pdo_data.vtg_data );
    log_printf( &logger, " PDO 5 - Current = %.2f A \r\n", pdo_data.curr_data );
    log_printf( &logger, "- - - - - - - - - - - - - -\r\n" );
    
    log_info( &logger, " Application Task " );
}

void application_task ( void ) {
    usbcsource_get_port_status( &usbcsource, &port_status );
    display_port_status( );
    Delay_ms( 100 );
    log_printf( &logger, "- - - - - - - - - - - - - - " );
    log_printf( &logger, "- - - - - - - - - - - - - -\r\n" );
    
    usbcsource_get_monitoring_status( &usbcsource, &monitor_status );
    display_monitoring_status( );
    Delay_ms( 100 );
    log_printf( &logger, "- - - - - - - - - - - - - - " );
    log_printf( &logger, "- - - - - - - - - - - - - -\r\n" );
    
    usbcsource_get_connection_status( &usbcsource, &conn_status );
    display_connection_status( );
    Delay_ms( 100 );
    log_printf( &logger, "- - - - - - - - - - - - - - " );
    log_printf( &logger, "- - - - - - - - - - - - - -\r\n" );
    Delay_ms( 5000 );
}

void main ( void ) {
    application_init( );

    for ( ; ; ) {
        application_task( );
    }
}

void display_port_status ( void ) {
    log_printf( &logger, " Attached Device   : " );
    
    switch ( port_status.attached_device ) {
        case USBCSOURCE_ATTACHED_DEVICE_NONE_ATT: {
            log_printf( &logger, "No device connected\r\n" );
            break;
        }
        case USBCSOURCE_ATTACHED_DEVICE_SNK_ATT: {
            log_printf( &logger, "Sink device connected\r\n" );
            break;
        }
        case USBCSOURCE_ATTACHED_DEVICE_SRC_ATT: {
            log_printf( &logger, "Source device connected\r\n" );
            break;
        }
        case USBCSOURCE_ATTACHED_DEVICE_DBG_ATT: {
            log_printf( &logger, "Debug accessory device connected\r\n" );
            break;
        }
        case USBCSOURCE_ATTACHED_DEVICE_AUD_ATT: {
            log_printf( &logger, "Audio accessory device connected\r\n" );
            break;
        }
        case USBCSOURCE_ATTACHED_DEVICE_POW_ACC_ATT: {
            log_printf( &logger, "Power accessory device connected\r\n" );
            break;
        }
    }
    
    log_printf( &logger, " Low Power Standby :" ); 
    if ( port_status.low_power_standby == USBCSOURCE_LOW_POWER_STANDBY_ON ) {
        log_printf( &logger, " ON\r\n" );
    } else {
        log_printf( &logger, " OFF\r\n" );
    }

    log_printf( &logger, " Power Mode        :" );
    if ( port_status.power_mode == USBCSOURCE_POWER_MODE_SRC ) {
        log_printf( &logger, " Source\r\n" );
    } else {
        log_printf( &logger, " Sink\r\n" );
    }

    log_printf( &logger, " Data Mode         :" );
    if ( port_status.data_mode == USBCSOURCE_DATA_MODE_DFP ) {
        log_printf( &logger, " DFP\r\n" );
    } else {
        log_printf( &logger, " UFP\r\n" );
    }

    log_printf( &logger, " Attach            :" );
    if ( port_status.attach == USBCSOURCE_CONN_ATTACHED ) {
        log_printf( &logger, " Attached\r\n" );
    } else {
        log_printf( &logger, " Unattached\r\n" );
    }
}

void display_monitoring_status ( void ) {
    log_printf( &logger, " VBUS Ready        :" );
    if ( monitor_status.vbus_ready == USBCSOURCE_VBUS_READY_CONNECTED ) {
        log_printf( &logger, " Connected\r\n" );
    } else {
        log_printf( &logger, " Disconnected\r\n" );
    }

    log_printf( &logger, " VBUS Safe         :" );
    if ( monitor_status.vbus_vsafe0v == USBCSOURCE_VBUS_VSAFE0V_0_8V_LOWER ) {
        log_printf( &logger, " Lower than 0.8V\r\n" );
    } else {
        log_printf( &logger, " Higher than 0.8V\r\n" );
    }

    log_printf( &logger, " VBUS Valid        :" );
    if ( monitor_status.vbus_valid == USBCSOURCE_VBUS_VALID_3_9V_HIGHER ) {
        log_printf( &logger, " Lower than 3.9V\r\n" );
    } else {
        log_printf( &logger, " Higher than 3.9V\r\n" );
    }
}

void display_connection_status ( void ) {
    log_printf( &logger, " Conn. orientation :" );
    if ( conn_status.cc_reverse == 1 ) {
        log_printf( &logger, " Twisted\r\n" );
    } else {
        log_printf( &logger, " Straight\r\n" );
    }

    log_printf( &logger, " Sink Power Level  :" );
    if ( conn_status.snk_power_level == 0 ) {
        log_printf( &logger, " Rp standard current is connected\r\n" );
    } else if ( conn_status.snk_power_level == 1 ) {
        log_printf( &logger, "  Rp 1.5A is connected\r\n" );
    } else {
        log_printf( &logger, "  Rp 3.0A is connected\r\n" );
    }
}

// ------------------------------------------------------------------------ END

Additional Support

Resources