util/debounce: Debouncing / hysteresis utility pkg #1268
Merged
Conversation
This file contains 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
| * false if the debouncer is in the low state. | ||
| */ | ||
| static inline bool | ||
| debouncer_high(const debouncer_t *debouncer) |
There was a problem hiding this comment.
I would make it return int instead with 0 for low, 1 for high - just as logic state.
and change name to debouncer_get/state_get/read or something like this.
There was a problem hiding this comment.
Thanks, Andrzej. I have changed debouncer_high to debouncer_state, and made it return 0 or 1 rather than a bool.
andrzej-kaczmarek
approved these changes
Jul 12, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I needed this utility for something, and I thought it was generally useful enough to be added to core. Perhaps this would be better placed in a different repo.
I struggled a lot deciding on a width for the integers in
struct debouncer.uint32_trequires a bit more memory than I was comfortable with. I thought about using macros to define several instances of the API (debouncer8,debouncer16,debouncer32), but that was making the code too complicated to be readable. I also considered a single syscfg setting which determined the integer width for all debouncers, but I didn't think that was very useful, and it still made the interface difficult to read due to the need for macros. In the end, I just settled on what I think works in most cases:uint16_t.