hallcurrent13  2.0.0.0
Main Page

Hall Current 13 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Stefan Filipovic
  • Date : Jan 2022.
  • Type : ADC/I2C type

Software Support

We provide a library for the Hall Current 13 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 13 Click driver.

Standard key functions :

Example key functions :

Example Description

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

The demo application is composed of two sections :

Application Init

Initializes the driver and logger.

void application_init ( void )
{
log_cfg_t log_cfg;
hallcurrent13_cfg_t hallcurrent13_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
hallcurrent13_cfg_setup( &hallcurrent13_cfg );
HALLCURRENT13_MAP_MIKROBUS( hallcurrent13_cfg, MIKROBUS_1 );
err_t init_flag = hallcurrent13_init( &hallcurrent13, &hallcurrent13_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 ( HALLCURRENT13_OK == hallcurrent13_read_current ( &hallcurrent13, &current ) )
{
log_printf( &logger, " Current : %.3f[A]\r\n\n", current );
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.HallCurrent13

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.


hallcurrent13_read_voltage
err_t hallcurrent13_read_voltage(hallcurrent13_t *ctx, float *voltage)
Hall Current 13 read voltage level function.
hallcurrent13_set_vref
err_t hallcurrent13_set_vref(hallcurrent13_t *ctx, float vref)
Hall Current 13 set vref function.
hallcurrent13_cfg_t
Hall Current 13 Click configuration object.
Definition: hallcurrent13.h:135
hallcurrent13_init
err_t hallcurrent13_init(hallcurrent13_t *ctx, hallcurrent13_cfg_t *cfg)
Hall Current 13 initialization function.
application_task
void application_task(void)
Definition: main.c:60
HALLCURRENT13_MAP_MIKROBUS
#define HALLCURRENT13_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: hallcurrent13.h:95
hallcurrent13_read_current
err_t hallcurrent13_read_current(hallcurrent13_t *ctx, float *current)
Hall Current 13 read current function.
HALLCURRENT13_OK
@ HALLCURRENT13_OK
Definition: hallcurrent13.h:156
application_init
void application_init(void)
Definition: main.c:29
hallcurrent13_cfg_setup
void hallcurrent13_cfg_setup(hallcurrent13_cfg_t *cfg)
Hall Current 13 configuration object setup function.
hallcurrent13_t
Hall Current 13 Click context object.
Definition: hallcurrent13.h:119