hallcurrent20 2.2.0
Loading...
Searching...
No Matches
hallcurrent20


Hall Current 20 Click

Hall Current 20 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 : Oct 2024.
  • Type : ADC/I2C type

Software Support

Example Description

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

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.HallCurrent20

Example Key Functions

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;
hallcurrent20_cfg_t hallcurrent20_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
hallcurrent20_cfg_setup( &hallcurrent20_cfg );
HALLCURRENT20_MAP_MIKROBUS( hallcurrent20_cfg, MIKROBUS_1 );
if ( HALLCURRENT20_OK != hallcurrent20_init( &hallcurrent20, &hallcurrent20_cfg ) )
{
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 ( HALLCURRENT20_ERROR == hallcurrent20_calib_offset ( &hallcurrent20 ) )
{
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",
for ( uint8_t cnt = 5; cnt > 0; cnt-- )
{
log_printf( &logger, " %u\r\n", ( uint16_t ) cnt );
Delay_ms ( 1000 );
}
{
log_error( &logger, " Calibrate resolution." );
for ( ; ; );
}
log_printf( &logger, " Data resolution calibration DONE.\r\n" );
log_info( &logger, " Application Task " );
}
#define HALLCURRENT20_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition hallcurrent20.h:113
@ HALLCURRENT20_OK
Definition hallcurrent20.h:179
@ HALLCURRENT20_ERROR
Definition hallcurrent20.h:180
void application_init(void)
Definition main.c:36
#define HALLCURRENT20_CALIBRATING_CURRENT
Definition main.c:31

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 ( HALLCURRENT20_OK == hallcurrent20_read_current ( &hallcurrent20, &current ) )
{
log_printf( &logger, " Current : %.1f A\r\n\n", current );
Delay_ms ( 1000 );
}
}
void application_task(void)
Definition main.c:95

Note

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

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.