hallcurrent4

---

Hall Current 4 Click

Hall Current 4 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 : Katarina Perendic
• Date : okt 2019.
• Type : I2C type

Software Support

Example Description

Demo application shows is reading current data in mA using Hall current 4 Click.

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.HallCurrent4

Example Key Functions

• hallcurrent4_cfg_setup Config Object Initialization function.

void hallcurrent4_cfg_setup ( hallcurrent4_cfg_t *cfg );

• hallcurrent4_init Initialization function.

err_t hallcurrent4_init ( hallcurrent4_t *ctx, hallcurrent4_cfg_t *cfg );

• hallcurrent4_get_current_data Reads current in mA.

float hallcurrent4_get_current_data ( hallcurrent4_t *ctx );

• hallcurrent4_get_raw_data Reads raw (ADC) current data.

uint16_t hallcurrent4_get_raw_data ( hallcurrent4_t *ctx );

Application Init

Configuring Clicks and log objects.

void application_init ( void )
{
    log_cfg_t log_cfg;
    hallcurrent4_cfg_t cfg;

    /** 
     * 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.

    hallcurrent4_cfg_setup( &cfg );
    HALLCURRENT4_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    hallcurrent4_init( &hallcurrent4, &cfg );
}

Application Task

Reads Current value in mA and logs this data to USBUART every 1 sec.

void application_task ( void )
{
    float current;

    current = hallcurrent4_get_current_data( &hallcurrent4 );

    log_printf( &logger, " >> Current value: %.2f mA\r\n", current );
    log_printf( &logger, " ------------------------- \r\n" );
    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.

---