hallcurrent15  2.0.0.0
Main Page

Hall Current 15 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

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

Software Support

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

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of Hall Current 15 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;
hallcurrent15_cfg_t hallcurrent15_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
hallcurrent15_cfg_setup( &hallcurrent15_cfg );
HALLCURRENT15_MAP_MIKROBUS( hallcurrent15_cfg, MIKROBUS_1 );
err_t init_flag = hallcurrent15_init( &hallcurrent15, &hallcurrent15_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 ( HALLCURRENT15_OK == hallcurrent15_read_current ( &hallcurrent15, &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.HallCurrent15

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.


hallcurrent15_read_raw_adc
err_t hallcurrent15_read_raw_adc(hallcurrent15_t *ctx, uint16_t *raw_adc)
Hall Current 15 read raw ADC value function.
HALLCURRENT15_OK
@ HALLCURRENT15_OK
Definition: hallcurrent15.h:185
hallcurrent15_cfg_t
Hall Current 15 Click configuration object.
Definition: hallcurrent15.h:163
application_task
void application_task(void)
Definition: main.c:60
hallcurrent15_read_current
err_t hallcurrent15_read_current(hallcurrent15_t *ctx, float *current)
Hall Current 15 read current function.
hallcurrent15_read_voltage
err_t hallcurrent15_read_voltage(hallcurrent15_t *ctx, float *voltage)
Hall Current 15 read voltage level function.
hallcurrent15_init
err_t hallcurrent15_init(hallcurrent15_t *ctx, hallcurrent15_cfg_t *cfg)
Hall Current 15 initialization function.
hallcurrent15_cfg_setup
void hallcurrent15_cfg_setup(hallcurrent15_cfg_t *cfg)
Hall Current 15 configuration object setup function.
hallcurrent15_t
Hall Current 15 Click context object.
Definition: hallcurrent15.h:145
application_init
void application_init(void)
Definition: main.c:29
HALLCURRENT15_MAP_MIKROBUS
#define HALLCURRENT15_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: hallcurrent15.h:120