hallcurrent16  2.1.0.0
Main Page

Hall Current 16 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Nenad Filipovic
  • Date : Jun 2023.
  • Type : SPI type

Software Support

We provide a library for the Hall Current 16 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Hall Current 16 Click driver.

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of Hall Current 16 click board by reading and displaying the current measurements.

The demo application is composed of two sections :

Application Init

The initialization of SPI module and log UART. After driver initialization, the app sets the default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
hallcurrent16_cfg_t hallcurrent16_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
hallcurrent16_cfg_setup( &hallcurrent16_cfg );
HALLCURRENT16_MAP_MIKROBUS( hallcurrent16_cfg, MIKROBUS_1 );
if ( SPI_MASTER_ERROR == hallcurrent16_init( &hallcurrent16, &hallcurrent16_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( HALLCURRENT16_ERROR == hallcurrent16_default_cfg ( &hallcurrent16 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
log_printf( &logger, " -------------------- \r\n" );
Delay_ms( 100 );
}

Application Task

The app reads the current measurements [V] and displays the results. Results are being sent to the UART Terminal, where you can track their changes.

void application_task ( void )
{
static float current;
if ( HALLCURRENT16_OK == hallcurrent16_get_current( &hallcurrent16, &current ) )
{
log_printf( &logger, " Current : %.3f A \r\n", current );
}
log_printf( &logger, " -------------------- \r\n" );
Delay_ms( 1000 );
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.HallCurrent16

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


hallcurrent16_default_cfg
err_t hallcurrent16_default_cfg(hallcurrent16_t *ctx)
Hall Current 16 default configuration function.
hallcurrent16_get_voltage
err_t hallcurrent16_get_voltage(hallcurrent16_t *ctx, float *voltage)
Hall Current 16 get voltage function.
HALLCURRENT16_ERROR
@ HALLCURRENT16_ERROR
Definition: hallcurrent16.h:189
hallcurrent16_cfg_t
Hall Current 16 Click configuration object.
Definition: hallcurrent16.h:162
application_task
void application_task(void)
Definition: main.c:68
hallcurrent16_init
err_t hallcurrent16_init(hallcurrent16_t *ctx, hallcurrent16_cfg_t *cfg)
Hall Current 16 initialization function.
HALLCURRENT16_MAP_MIKROBUS
#define HALLCURRENT16_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: hallcurrent16.h:114
hallcurrent16_get_ovc_fault
uint8_t hallcurrent16_get_ovc_fault(hallcurrent16_t *ctx)
Hall Current 16 get overcurrent fault function.
hallcurrent16_get_current
err_t hallcurrent16_get_current(hallcurrent16_t *ctx, float *current)
Hall Current 16 get current function.
application_init
void application_init(void)
Definition: main.c:30
hallcurrent16_cfg_setup
void hallcurrent16_cfg_setup(hallcurrent16_cfg_t *cfg)
Hall Current 16 configuration object setup function.
HALLCURRENT16_OK
@ HALLCURRENT16_OK
Definition: hallcurrent16.h:188
hallcurrent16_t
Hall Current 16 Click context object.
Definition: hallcurrent16.h:142