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.
range_upscaling_driver.h File Reference
Application-level functions used for configuration and operation during upscaled ranging. More...
Go to the source code of this file.
Functions | |
| sensor_error | er_set_static_config (uint8_t device_base_address) |
| Device setup for Upscaled Ranging operations. | |
| sensor_error | er_set_part2Part_range_offset (uint8_t device_base_address, uint8_t part_to_part_range_offset) |
| Set the Part-to-Part Range Offset. | |
| uint8_t | er_range_get_part2Part_range_offset (uint8_t device_base_address) |
| Report the part-to-part range offset. | |
| uint32_t | er_get_result (uint8_t device_base_address) |
| Report result from last completed upscaled ranging operation. | |
| sensor_error | er_set_scaler (uint8_t scaler, uint8_t device_base_address) |
| Set the extended range scaling to either 2X or 3X scaling. An increased scaler \ will result in a greater measurement distance but more coarse resolution. | |
| uint8_t | er_get_scaler (uint8_t device_base_address) |
| Reports the current scaler setting. | |
| uint32_t | er_get_upper_limit (uint8_t device_base_address) |
| Function to return the Maximum range reported by the sensor. | |
| uint32_t | er_get_lower_limit (uint8_t device_base_address) |
| Function to return the Minimum range reported by the sensor. | |
Detailed Description
Application-level functions used for configuration and operation during upscaled ranging.
Definition in file range_upscaling_driver.h.
Function Documentation
Function to return the Minimum range reported by the sensor.
- Parameters:
-
[in] device_base_address
- Return values:
-
32-bit integer
Definition at line 265 of file range_upscaling_driver.cpp.
Report result from last completed upscaled ranging operation.
- Parameters:
-
[in] device_base_address
- Return values:
-
32-bit integer
Definition at line 182 of file range_upscaling_driver.cpp.
Reports the current scaler setting.
- Parameters:
-
[in] device_base_address
- Return values:
-
Byte-wide,integer
Definition at line 230 of file range_upscaling_driver.cpp.
Function to return the Maximum range reported by the sensor.
- Parameters:
-
[in] device_base_address
- Return values:
-
32-bit integer
Definition at line 241 of file range_upscaling_driver.cpp.
Report the part-to-part range offset.
Report the part-to-part range offset from sysrange_part_to_part_range_offset register.
- Parameters:
-
[in] device_base_address
- Return values:
-
Byte-wide,integer
Definition at line 171 of file range_upscaling_driver.cpp.
| sensor_error er_set_part2Part_range_offset | ( | uint8_t | device_base_address, |
| uint8_t | part_to_part_range_offset | ||
| ) |
Set the Part-to-Part Range Offset.
Set part-to-part range offset in the sysrange_part_to_part_range_offset register.
- Parameters:
-
[in] device_base_address [in] part_to_part_range_offset
- Return values:
-
sensor_error
Definition at line 160 of file range_upscaling_driver.cpp.
Set the extended range scaling to either 2X or 3X scaling. An increased scaler \ will result in a greater measurement distance but more coarse resolution.
- Parameters:
-
[in] scaler [in] device_base_address
- Return values:
-
sensor_error
Definition at line 196 of file range_upscaling_driver.cpp.
| sensor_error er_set_static_config | ( | uint8_t | device_base_address ) |
Device setup for Upscaled Ranging operations.
Device setup for extended-range operations. To apply these settings the operation bit (bit 0) in the SYSRANGE__START & SYSALS__START Registers must be cleared.
- Parameters:
-
[in] device_base_address
- Return values:
-
sensor_error
Definition at line 118 of file range_upscaling_driver.cpp.
Generated on Tue Jul 12 2022 22:19:50 by
1.7.2