LightRanger Click
LightRanger 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 : MikroE Team
- Date : Dec 2019.
- Type : I2C type
Software Support
Example Description
This example collects data from the sensor and logs it to the terminal.
Example Libraries
- MikroSDK.Board
- MikroSDK.Log
- Click.LightRanger
Example Key Functions
- lightranger_cfg_setup Config Object Initialization function.
void lightranger_cfg_setup(lightranger_cfg_t *cfg)
Config Object Initialization function.
Click configuration structure definition.
Definition lightranger.h:236
- lightranger_init Initialization function.
LIGHTRANGER_RETVAL lightranger_init(lightranger_t *ctx, lightranger_cfg_t *cfg)
Initialization function.
Click ctx object definition.
Definition lightranger.h:216
- lightranger_write_byte This function writes a byte of data to given address.
void lightranger_write_byte(lightranger_t *ctx, uint16_t reg_addr, uint8_t write_command)
Generic write byte function.
- lightranger_get_ambiant_light This function reads register and calculates the light level in lux.
float lightranger_get_ambiant_light(lightranger_t *ctx, uint8_t als_gain_check)
Get ambiant light.
- lightranger_get_distance This function reads range result from register.
uint8_t lightranger_get_distance(lightranger_t *ctx)
Get Distance.
Application Init
Initialization driver for sensor Vl6180X and stars logging to terminal.
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
Delay_ms ( 1000 );
}
#define LIGHTRANGER_MAP_MIKROBUS(cfg, mikrobus)
Definition lightranger.h:67
void lightranger_default_cfg(lightranger_t *ctx)
Click Default Configuration function.
void application_init(void)
Definition main.c:37
Application Task
Measures and calculates ambient light intensity and distance from sensor, when the distance is changed log is updated, results are being sent to the Usart Terminal where you can track their changes. All data logs on usb uart for approximately every 1 sec when the data value changes.
{
uint8_t range_value;
float lux_value;
log_printf( &logger, "Proximity : %u mm\r\n", ( uint16_t ) range_value );
log_printf( &logger, "Ambient Light: %.2f lux\r\n", lux_value );
log_printf( &logger, "*******************************************\r\n" );
Delay_ms ( 500 );
}
#define LIGHTRANGER_CMD_GAIN_1X
Definition lightranger.h:195
void lightranger_poll_range(lightranger_t *ctx)
Poll range.
void lightranger_start_single_shot_range_mode(lightranger_t *ctx)
Function Start Single Mode.
void lightranger_interrupts_clear(lightranger_t *ctx)
Clear Interrupts.
void application_task(void)
Definition main.c:65
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.