-
Notifications
You must be signed in to change notification settings - Fork 21
doc: lib: add bm_buttons documentation #422
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
eivindj-nordic
wants to merge
1
commit into
nrfconnect:main
Choose a base branch
from
eivindj-nordic:doc_buttons
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+63
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| .. _lib_bm_buttons: | ||
|
|
||
| Button handling library | ||
| ####################### | ||
|
|
||
| .. contents:: | ||
| :local: | ||
| :depth: 2 | ||
|
|
||
|
|
||
| Overview | ||
| ******** | ||
|
|
||
| The button handling library uses the GPIOTE to detect when a button has been pushed. | ||
| To handle debouncing, a timer is started in the GPIOTE event handler. | ||
| The button will only be reported as pushed to the application if the corresponding pin is still active when the timer expires. | ||
|
|
||
| Configuration | ||
| ************* | ||
|
|
||
| The library is enabled using the Kconfig system. | ||
| Set the :kconfig:option:`CONFIG_BM_BUTTONS` Kconfig option to enable the library. | ||
|
|
||
| The number of pins available for use by the button handling library is set by the :kconfig:option:`CONFIG_BM_BUTTONS_NUM_PINS` Kconfig option. | ||
|
|
||
| Initialization | ||
| ============== | ||
|
|
||
| The button handling library is initialized by calling the :c:func:`bm_buttons_init` function. | ||
| The init function takes an array of button configurations as an argument, see the :c:struct:`bm_buttons_config` struct for details. | ||
| It also takes, as an argument, the detection delay time used for the debouncing. | ||
| Each button configuration takes a separate :c:type:`bm_buttons_handler_t` function. | ||
| The button pin number and state is provided to the event handler on a button event. | ||
| Thus, all configurations can use the same event handler. | ||
|
|
||
| Usage | ||
| ***** | ||
|
|
||
| After initialization the buttons are enabled by calling the :c:func:`bm_buttons_enable` function. | ||
| Likewise, the buttons can be disabled by calling the :c:func:`bm_buttons_disable` function. | ||
|
|
||
| Once a button is pressed and the debouncing process succeeds (the button state has not changed during the detection_delay period), the button's event handler function is called. | ||
|
|
||
| When the buttons are enabled, it is possible to check if a button is pressed or not by calling the :c:func:`bm_buttons_is_pressed` function. | ||
|
|
||
| The button library can be deinitialized by calling the :c:func:`bm_buttons_deinit` function. | ||
|
|
||
| Dependencies | ||
| ************ | ||
|
|
||
| This library uses the following |BMshort| libraries: | ||
|
|
||
| * Timer - :kconfig:option:`CONFIG_BM_TIMER` | ||
|
|
||
| API documentation | ||
| ***************** | ||
|
|
||
| | Header file: :file:`include/bm/bm_buttons.h` | ||
| | Source files: :file:`lib/bm_buttons/` | ||
| :ref:`Button handling library API reference <api_bm_buttons>` | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When more of the library documentation is merged, this section (and this section in other modules) could be updated with links.