hallcurrent15

---

Hall Current 15 Click

Hall Current 15 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 : Apr 2022.
• Type : ADC/I2C type

Software Support

Example Description

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

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.HallCurrent15

Example Key Functions

• hallcurrent15_cfg_setup Config Object Initialization function.

void hallcurrent15_cfg_setup ( hallcurrent15_cfg_t *cfg );

• hallcurrent15_init Initialization function.

err_t hallcurrent15_init ( hallcurrent15_t *ctx, hallcurrent15_cfg_t *cfg );

• hallcurrent15_read_raw_adc This function reads raw ADC value.

err_t hallcurrent15_read_raw_adc ( hallcurrent15_t *ctx, uint16_t *raw_adc );

• hallcurrent15_read_voltage This function reads raw ADC value and converts it to proportional voltage level.

err_t hallcurrent15_read_voltage ( hallcurrent15_t *ctx, float *voltage );

• hallcurrent15_read_current This function reads the input current level [A] based on HALLCURRENT15_NUM_CONVERSIONS of voltage measurements.

err_t hallcurrent15_read_current ( hallcurrent15_t *ctx, float *current );

Application Init

Initializes the driver and logger.

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    hallcurrent15_cfg_t hallcurrent15_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.
    hallcurrent15_cfg_setup( &hallcurrent15_cfg );
    HALLCURRENT15_MAP_MIKROBUS( hallcurrent15_cfg, MIKROBUS_1 );
    err_t init_flag = hallcurrent15_init( &hallcurrent15, &hallcurrent15_cfg );
    if ( ( ADC_ERROR == init_flag ) || ( I2C_MASTER_ERROR == init_flag ) )
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    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 ( HALLCURRENT15_OK == hallcurrent15_read_current ( &hallcurrent15, &current ) ) 
    {
        log_printf( &logger, " Current : %.3f[A]\r\n\n", current );
        Delay_ms ( 1000 );
    }
}

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.

---