Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
vl6180x_high_level_api.h File Reference
High level interface for the device, providing methods for basic ranging and ambient light sensor measurement. More...
Go to the source code of this file.
Functions | |
| sensor_error | get_vendor (uint8_t *pVendorStr) |
| Function to report the Vendor ID as a string. | |
| sensor_error | get_version (int32_t id, uint8_t *pVersionStr) |
| Function to report the Device Version as a string. | |
| uint32_t | get_max_range () |
| Function to return the Maximum range reported by the sensor. | |
| uint32_t | get_min_range () |
| Function to return the Minimum range reported by the sensor. | |
| sensor_error | initialise (uint8_t device_base_address) |
| Function to perform device initialisation. | |
| sensor_error | start_ranging (int32_t id) |
| Function to configure the device for single shot ranging. | |
| sensor_error | start_extended_ranging (int32_t id) |
| Function to configure the device for single shot extended ranging. | |
| sensor_error | get_range_measurement (int32_t id, sensor_RangeData *pRangeData) |
| Function to perform a single shot range measurement and reports the results to the given argument. | |
| sensor_error | start_als (int32_t id) |
| Function to configure the device for single shot ALS measurements. | |
| sensor_error | get_als_measurement (int32_t id, sensor_AlsData *pAlsData) |
| Function to perform a single shot ALS measurement and reports the results to the given argument. | |
| sensor_error | get_minimum_delay () |
| TBC. | |
Detailed Description
High level interface for the device, providing methods for basic ranging and ambient light sensor measurement.
Definition in file vl6180x_high_level_api.h.
Function Documentation
| sensor_error get_als_measurement | ( | int32_t | id, |
| sensor_AlsData * | pAlsData | ||
| ) |
Function to perform a single shot ALS measurement and reports the results to the given argument.
Pre-Requisite : Requires startAls() to be called beforehand.
Returns -1 to report error.
Definition at line 183 of file vl6180x_high_level_api.cpp.
| uint32_t get_max_range | ( | ) |
Function to return the Maximum range reported by the sensor.
Definition at line 61 of file vl6180x_high_level_api.cpp.
| uint32_t get_min_range | ( | ) |
Function to return the Minimum range reported by the sensor.
Definition at line 70 of file vl6180x_high_level_api.cpp.
| sensor_error get_minimum_delay | ( | ) |
TBC.
Definition at line 203 of file vl6180x_high_level_api.cpp.
| sensor_error get_range_measurement | ( | int32_t | id, |
| sensor_RangeData * | pRangeData | ||
| ) |
Function to perform a single shot range measurement and reports the results to the given argument.
Pre-Requisite : Requires startRanging() to be called beforehand.
Returns -1 to report error.
Definition at line 135 of file vl6180x_high_level_api.cpp.
| sensor_error get_vendor | ( | uint8_t * | pVendorStr ) |
Function to report the Vendor ID as a string.
Definition at line 45 of file vl6180x_high_level_api.cpp.
Function to report the Device Version as a string.
id : device identifier. 0, if only one device.
Returns -1 to report error.
Definition at line 53 of file vl6180x_high_level_api.cpp.
| sensor_error initialise | ( | uint8_t | device_base_address ) |
Function to perform device initialisation.
Returns -1 to report error.
Definition at line 75 of file vl6180x_high_level_api.cpp.
| sensor_error start_als | ( | int32_t | id ) |
Function to configure the device for single shot ALS measurements.
Returns -1 to report error.
Definition at line 160 of file vl6180x_high_level_api.cpp.
| sensor_error start_extended_ranging | ( | int32_t | id ) |
Function to configure the device for single shot extended ranging.
Returns -1 to report error.
Definition at line 112 of file vl6180x_high_level_api.cpp.
| sensor_error start_ranging | ( | int32_t | id ) |
Function to configure the device for single shot ranging.
Returns -1 to report error.
Definition at line 88 of file vl6180x_high_level_api.cpp.
Generated on Tue Jul 12 2022 22:19:50 by
1.7.2