Skip to content

Latest commit

 

History

History

current10

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Current 10 Click

Current 10 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.


Click Library

  • Author : Stefan Filipovic
  • Date : Sep 2024.
  • Type : ADC/I2C type

Software Support

Example Description

This example demonstrates the use of Current 10 Click board by reading and displaying the input current measurements.

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Current10

Example Key Functions

  • current10_cfg_setup Config Object Initialization function.
void current10_cfg_setup ( current10_cfg_t *cfg );
  • current10_init Initialization function.
err_t current10_init ( current10_t *ctx, current10_cfg_t *cfg );
  • current10_calib_offset This function calibrates the zero current offset value.
err_t current10_calib_offset ( current10_t *ctx );
  • current10_calib_resolution This function calibrates the data resolution at the known load current.
err_t current10_calib_resolution ( current10_t *ctx, float calib_current );
  • current10_read_current This function reads the input current level [A].
err_t current10_read_current ( current10_t *ctx, float *current );

Application Init

Initializes the driver and calibrates the zero current offset and data resolution at 3A load current.

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    current10_cfg_t current10_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.
    current10_cfg_setup( &current10_cfg );
    CURRENT10_MAP_MIKROBUS( current10_cfg, MIKROBUS_1 );
    err_t init_flag = current10_init( &current10, &current10_cfg );
    if ( ( ADC_ERROR == init_flag ) || ( I2C_MASTER_ERROR == init_flag ) )
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    log_printf( &logger, " Calibrating zero current offset in 5 seconds...\r\n" );
    log_printf( &logger, " Make sure no current flows through the sensor during the calibration process.\r\n" );
    for ( uint8_t cnt = 5; cnt > 0; cnt-- )
    {
        log_printf( &logger, " %u\r\n", ( uint16_t ) cnt );
        Delay_ms ( 1000 );
    }
    if ( CURRENT10_ERROR == current10_calib_offset ( &current10 ) )
    {
        log_error( &logger, " Calibrate offset." );
        for ( ; ; );
    }
    log_printf( &logger, " Offset calibration DONE.\r\n\n" );

    log_printf( &logger, " Calibrating data resolution in 5 seconds...\r\n" );
    log_printf( &logger, " Keep the load current set at %.1fA during the calibration process.\r\n", 
                CURRENT10_CALIBRATING_CURRENT );
    for ( uint8_t cnt = 5; cnt > 0; cnt-- )
    {
        log_printf( &logger, " %u\r\n", ( uint16_t ) cnt );
        Delay_ms ( 1000 );
    }
    if ( CURRENT10_ERROR == current10_calib_resolution ( &current10, CURRENT10_CALIBRATING_CURRENT ) )
    {
        log_error( &logger, " Calibrate resolution." );
        for ( ; ; );
    }
    log_printf( &logger, " Data resolution calibration DONE.\r\n" );
    
    log_info( &logger, " Application Task " );
}

Application Task

Reads the input current measurements and displays the results on the USB UART approximately once per second.

void application_task ( void )
{
    float current = 0;
    if ( CURRENT10_OK == current10_read_current ( &current10, &current ) ) 
    {
        log_printf( &logger, " Current : %.1f A\r\n\n", current );
        Delay_ms ( 1000 );
    }
}

Note

The measurement range is approximately: +/- 75A.

Application Output

This Click board can be interfaced and monitored in two ways:

  • Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
  • UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.