Hall Current 19 click
PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU
[click Product page](CLICK_PRODUCT_PAGE_LINK)
Click library
- Author : Stefan Ilic
- Date : Feb 2024.
- Type : ADC type
Software Support
We provide a library for the Hall Current 19 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 19 Click driver.
Standard key functions :
hallcurrent19_cfg_setup
Config Object Initialization function.
void hallcurrent19_cfg_setup(hallcurrent19_cfg_t *cfg)
Hall Current 19 configuration object setup function.
Hall Current 19 Click configuration object.
Definition: hallcurrent19.h:125
hallcurrent19_init
Initialization function.
err_t hallcurrent19_init(hallcurrent19_t *ctx, hallcurrent19_cfg_t *cfg)
Hall Current 19 initialization function.
Hall Current 19 Click context object.
Definition: hallcurrent19.h:110
Example key functions :
hallcurrent19_get_oc2
This function is used to get state of the overcurrent 2 detection of the Hall Current 19 Click board.
uint8_t hallcurrent19_get_oc2(hallcurrent19_t *ctx)
Hall Current 19 get over current detection 2 state function.
hallcurrent19_set_zero_ref
This function sets the zero voltage reference of the Hall Current 19 Click board.
err_t hallcurrent19_set_zero_ref(hallcurrent19_t *ctx)
Hall Current 19 set zero reference function.
hallcurrent19_get_current
This function reads and calculate input current value of the Hall Current 19 Click board.
err_t hallcurrent19_get_current(hallcurrent19_t *ctx, float *data_out)
Hall Current 19 get current function.
Example Description
This example demonstrates the use of Hall Current 19 click board
by reading and displaying the current measurements.
The demo application is composed of two sections :
Application Init
After driver initialization and set the zero voltage reference.
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
log_printf( &logger, " Turn off the load current in the following 5 sec.\r\n" );
Delay_ms( 5000 );
{
log_printf( &logger, " Process complete!\r\n");
}
else
{
log_error( &logger, " Zero reference." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
#define HALLCURRENT19_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: hallcurrent19.h:97
@ HALLCURRENT19_OK
Definition: hallcurrent19.h:141
void application_init(void)
Definition: main.c:29
Application Task
The demo application reads the current measurements [A] and displays the results.
Results are being sent to the UART Terminal, where you can track their changes.
{
float voltage = 0;
{
log_printf( &logger, " Current : %.3f[A]\r\n\n", voltage );
Delay_ms( 1000 );
}
{
log_printf( &logger, " Current over 7A \r\n" );
}
{
log_printf( &logger, " Current over 17.5A \r\n" );
}
}
#define HALLCURRENT19_OCD_ACTIVE
Hall Current 19 Over Current Detection values.
Definition: hallcurrent19.h:78
uint8_t hallcurrent19_get_oc1(hallcurrent19_t *ctx)
Hall Current 19 get over current detection 1 state function.
void application_task(void)
Definition: main.c:71
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.HallCurrent19
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.