feat: BUTTON_BUILTIN alias for USER_BTN
#1490
Closed
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.
Create an alias for those new to STM32duino environment.
USER_BTNis commonplace in STM32duino, however there are several instances ofBUTTON_BUILTINacross other Arduino BSPs. The naming convention ofBUTTON_BUILTINis more closely aligned toLED_BUILTIN, and there appears to be some precedent.Examples:
... as well as several other examples that can be discovered by Googling,
"BUTTON_BUILTIN" arduino.Since ST is the clear leader in boards having a built-in button, it has a unique opportunity to help reinforce the semi-standardized precedent
BUTTON_BUILTINby providing an alias for all boards that support aUSER_BTN.