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.
VL53L1 Sequence Step Functions
[VL53L1 cut1.1 Function Definition]
Functions used to select Steps done on each ranging. More...
Functions | |
| VL53L1_Error | VL53L1_GetNumberOfSequenceSteps (VL53L1_DEV Dev, uint8_t *pNumberOfSequenceSteps) |
| Gets number of sequence steps managed by the API. | |
| VL53L1_Error | VL53L1_GetSequenceStepsInfo (VL53L1_SequenceStepId SequenceStepId, char *pSequenceStepsString) |
| Gets the name of a given sequence step. | |
| VL53L1_Error | VL53L1_SetSequenceStepEnable (VL53L1_DEV Dev, VL53L1_SequenceStepId SequenceStepId, uint8_t SequenceStepEnabled) |
| Sets the (on/off) state of a requested sequence step. | |
| VL53L1_Error | VL53L1_GetSequenceStepEnable (VL53L1_DEV Dev, VL53L1_SequenceStepId SequenceStepId, uint8_t *pSequenceStepEnabled) |
| Gets the (on/off) state of a requested sequence step. | |
Detailed Description
Functions used to select Steps done on each ranging.
Function Documentation
| VL53L1_Error VL53L1_GetNumberOfSequenceSteps | ( | VL53L1_DEV | Dev, |
| uint8_t * | pNumberOfSequenceSteps | ||
| ) |
Gets number of sequence steps managed by the API.
- Function Description
- This function retrieves the number of sequence steps currently managed by the API
- Note:
- This function Accesses the device
- Parameters:
-
Dev Device Handle pNumberOfSequenceSteps Out parameter reporting the number of sequence steps.
- Returns:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1631 of file vl53l1_api.c.
| VL53L1_Error VL53L1_GetSequenceStepEnable | ( | VL53L1_DEV | Dev, |
| VL53L1_SequenceStepId | SequenceStepId, | ||
| uint8_t * | pSequenceStepEnabled | ||
| ) |
Gets the (on/off) state of a requested sequence step.
- Function Description
- This function retrieves the state of a requested sequence step, i.e. on/off.
- Note:
- This function Accesses the device
- Parameters:
-
Dev Device Handle SequenceStepId Sequence step identifier. pSequenceStepEnabled Out parameter reporting if the sequence step is enabled {0=Off,1=On}.
- Returns:
- VL53L1_ERROR_NONE Success
- VL53L1_ERROR_INVALID_PARAMS Error SequenceStepId parameter not supported.
- "Other error code" See VL53L1_Error
Definition at line 1693 of file vl53l1_api.c.
| VL53L1_Error VL53L1_GetSequenceStepsInfo | ( | VL53L1_SequenceStepId | SequenceStepId, |
| char * | pSequenceStepsString | ||
| ) |
Gets the name of a given sequence step.
- Function Description
- This function retrieves the name of sequence steps corresponding to SequenceStepId.
- Note:
- This function doesn't Accesses the device
- Parameters:
-
SequenceStepId Sequence step identifier. pSequenceStepsString Pointer to Info string. Shall be defined as char buf[VL53L1_MAX_STRING_LENGTH]
- Returns:
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1646 of file vl53l1_api.c.
| VL53L1_Error VL53L1_SetSequenceStepEnable | ( | VL53L1_DEV | Dev, |
| VL53L1_SequenceStepId | SequenceStepId, | ||
| uint8_t | SequenceStepEnabled | ||
| ) |
Sets the (on/off) state of a requested sequence step.
- Function Description
- This function enables/disables a requested sequence step.
- Note:
- This function Accesses the device
- Parameters:
-
Dev Device Handle SequenceStepId Sequence step identifier. SequenceStepEnabled Demanded state {0=Off,1=On} is enabled.
- Returns:
- VL53L1_ERROR_NONE Success
- VL53L1_ERROR_INVALID_PARAMS Error SequenceStepId parameter not supported.
- "Other error code" See VL53L1_Error
Definition at line 1662 of file vl53l1_api.c.
Generated on Tue Jul 12 2022 20:07:15 by
1.7.2