Current Limit 5 Click
Current Limit 5 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 : Jan 2022.
- Type : I2C type
Software Support
Example Description
This example demonstrates the use of Current Limit 5 Click board by limiting the current to a certain value and displaying an appropriate message when the current reaches the limit.
Example Libraries
- MikroSDK.Board
- MikroSDK.Log
- Click.CurrentLimit5
Example Key Functions
- currentlimit5_cfg_setup Config Object Initialization function.
void currentlimit5_cfg_setup(currentlimit5_cfg_t *cfg)
Current Limit 5 configuration object setup function.
Current Limit 5 Click configuration object.
Definition currentlimit5.h:135
- currentlimit5_init Initialization function.
err_t currentlimit5_init(currentlimit5_t *ctx, currentlimit5_cfg_t *cfg)
Current Limit 5 initialization function.
Current Limit 5 Click context object.
Definition currentlimit5.h:115
- currentlimit5_set_ilimit This function sets the current limit value by configuring the onboard digital potentiometer.
currentlimit5_ilimit_t
Current Limit 5 Click Ilimit values.
Definition currentlimit5.h:163
err_t currentlimit5_set_ilimit(currentlimit5_t *ctx, currentlimit5_ilimit_t ilimit)
Current Limit 5 set ilimit function.
- currentlimit5_get_fault_pin This function returns the fault pin logic state.
uint8_t currentlimit5_get_fault_pin(currentlimit5_t *ctx)
Current Limit 5 get fault pin function.
- currentlimit5_enable_limit This function enables the current limiting switch.
void currentlimit5_enable_limit(currentlimit5_t *ctx)
Current Limit 5 enable limit function.
Application Init
Initializes the driver and performs the Click default configuration which sets the current limit to 200mA.
{
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_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
@ CURRENTLIMIT5_ERROR
Definition currentlimit5.h:154
#define CURRENTLIMIT5_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition currentlimit5.h:101
err_t currentlimit5_default_cfg(currentlimit5_t *ctx)
Current Limit 5 default configuration function.
void application_init(void)
Definition main.c:30
Application Task
Displays the fault indicator state on the USB UART.
{
static uint8_t currentlimit_ind = 2;
{
if ( currentlimit_ind != 0 )
{
log_printf ( &logger, " The switch is in normal operation \r\n\n" );
currentlimit_ind = 0;
}
}
else
{
if ( currentlimit_ind != 1 )
{
log_printf ( &logger, " The switch is in the current limiting or thermal shutdown operation \r\n\n" );
currentlimit_ind = 1;
}
}
}
void application_task(void)
Definition main.c:66
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.