Ultrasonic 5 Click
Ultrasonic 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 : Jun 2023.
- Type : SPI type
Software Support
Example Description
This example demonstrates the use of Ultrasonic 5 Click board by reading the measurements from the connected ultrasonic sensor and displaying it on a Serial Plot.
Example Libraries
- MikroSDK.Board
- MikroSDK.Log
- Click.Ultrasonic5
Example Key Functions
- ultrasonic5_cfg_setup Config Object Initialization function.
void ultrasonic5_cfg_setup(ultrasonic5_cfg_t *cfg)
Ultrasonic 5 configuration object setup function.
Ultrasonic 5 Click configuration object.
Definition ultrasonic5.h:303
- ultrasonic5_init Initialization function.
err_t ultrasonic5_init(ultrasonic5_t *ctx, ultrasonic5_cfg_t *cfg)
Ultrasonic 5 initialization function.
Ultrasonic 5 Click context object.
Definition ultrasonic5.h:280
- ultrasonic5_default_cfg Click Default Configuration function.
err_t ultrasonic5_default_cfg(ultrasonic5_t *ctx)
Ultrasonic 5 default configuration function.
- ultrasonic5_clear_io1_pin This function clears the IO1 pin to low logic state.
void ultrasonic5_clear_io1_pin(ultrasonic5_t *ctx)
Ultrasonic 5 clear io1 pin function.
- ultrasonic5_pwm_start This function starts the PWM module output.
err_t ultrasonic5_pwm_start(ultrasonic5_t *ctx)
Ultrasonic 5 start PWM module.
- ultrasonic5_read_an_pin_voltage This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.
err_t ultrasonic5_read_an_pin_voltage(ultrasonic5_t *ctx, float *data_out)
Ultrasonic 5 read AN pin voltage level function.
Application Init
Initializes the driver and performs the Click default configuration.
{
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 " );
}
#define ULTRASONIC5_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition ultrasonic5.h:262
void application_init(void)
Definition main.c:36
@ ULTRASONIC5_OK
Definition ultrasonic5.h:333
Application Task
Performs a burst generation which starts the measurement and then reads the next 200 ADC samples and displays the results on the USB UART (SerialPlot).
{
float voltage = 0;
Delay_500us ( );
for ( uint16_t cnt = 0; cnt < 200; cnt++ )
{
{
log_printf( &logger, "%.3f\r\n", voltage );
}
}
}
#define ULTRASONIC5_DEF_DYTY
Definition ultrasonic5.h:221
err_t ultrasonic5_set_duty_cycle(ultrasonic5_t *ctx, float duty_cycle)
Ultrasonic 5 sets PWM duty cycle.
void ultrasonic5_set_io1_pin(ultrasonic5_t *ctx)
Ultrasonic 5 set io1 pin function.
err_t ultrasonic5_pwm_stop(ultrasonic5_t *ctx)
Ultrasonic 5 stop PWM module.
void application_task(void)
Definition main.c:72
Note
In order to get valid measuremets a proper ultrasonic sensor must be connected to OUTA and OUTB. We have used an UTR-1440K-TT-R sensor for the test. We recommend using the SerialPlot tool for data visualizing. Refer to the datasheet "Application Curves" section in order to check and compare the results from the plotter.
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.