Document switch position labels #4425
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on PR "Add labels to switch" from viamrobotics/rdk, update the documentation to reflect the RDK implementation of switch position labels functionality that enhances the GetNumberOfPositions method to return human-readable labels for switch positions in addition to the numeric count.
Key Enhancement:
GetNumberOfPositions
method now returns both the number of positions AND an array of string labels for those positionsRDK Implementation Changes:
GetNumberOfPositionsResponse
now includes arepeated string labels
fieldlabels
configuration field for custom position namesDocumentation Updates Needed:
This enhancement makes switch components more user-friendly by allowing developers to work with meaningful position names rather than just numeric indices, improving code readability and reducing the need for manual position-to-name mapping in user applications.
Trigger Events
If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)