Functions used to select Steps done on each ranging. More...
Collaboration diagram for VL53L1 Sequence Step Functions:
Functions | |
| VL53L1_Error | VL53L1_GetNumberOfSequenceSteps (VL53L1_DEV Dev, uint8_t *pNumberOfSequenceSteps) |
| Gets number of sequence steps managed by the API. More... | |
| VL53L1_Error | VL53L1_GetSequenceStepEnable (VL53L1_DEV Dev, VL53L1_SequenceStepId SequenceStepId, uint8_t *pSequenceStepEnabled) |
| Gets the (on/off) state of a requested sequence step. More... | |
| VL53L1_Error | VL53L1_GetSequenceStepsInfo (VL53L1_SequenceStepId SequenceStepId, char *pSequenceStepsString) |
| Gets the name of a given sequence step. More... | |
| VL53L1_Error | VL53L1_SetSequenceStepEnable (VL53L1_DEV Dev, VL53L1_SequenceStepId SequenceStepId, uint8_t SequenceStepEnabled) |
| Sets the (on/off) state of a requested sequence step. More... | |
Detailed Description
Functions used to select Steps done on each ranging.
Function Documentation
◆ VL53L1_GetNumberOfSequenceSteps()
| 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 1644 of file vl53l1_api.c.
◆ VL53L1_GetSequenceStepEnable()
| 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 1708 of file vl53l1_api.c.
◆ VL53L1_GetSequenceStepsInfo()
| 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 1659 of file vl53l1_api.c.
◆ VL53L1_SetSequenceStepEnable()
| 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 1675 of file vl53l1_api.c.