Split toggle2nist component #4350
+103
−11
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| component momentary2nist "momentary button to nist logic"; | ||
|
|
||
| description | ||
| """ | ||
| Momentary2nist can be used with a momentary push button | ||
| to control a device that has separate on and off inputs | ||
| and an is-on output. | ||
| A debounce delay in cycles can be set for 'in'. (default = 2) | ||
| A maximum output pulse length in cycles can be set for 'on' and 'off'. (default = 100) | ||
|
|
||
| * On a rising edge on pin *in* when *is-on* is low: It sets *on* until *is-on* becomes high. | ||
| * On a rising edge on pin *in* when *is-on* is high: It sets *off* until *is-on* becomes low. | ||
| * Pins *on* and *off* remain high until *is-on* confirms the respective state or until *max-pulse-length* is reached. | ||
| .... | ||
| ┐ ┌─────xxxxxxxxxxxx┐ ┌─────xxxxxxxxxxxx┐ | ||
| in : └─────┘ xxxxxxxxxxxx└───────────┘ xxxxxxxxxxxx└───── | ||
|
|
||
| ┐ ┌───────────┐ | ||
| on : └─────┘ └───────────────────────────────────────── | ||
|
|
||
| ┐ ┌───────────┐ | ||
| off : └───────────────────────────────────┘ └─────────── | ||
|
|
||
| ┐ ┌─────────────────────────────┐ | ||
| is-on: └─────────────────┘ └─────────── | ||
| .... | ||
|
|
||
| """; | ||
|
|
||
| pin in bool in "momentary button in"; | ||
| pin in bool is_on "current state of device"; | ||
| pin in ui32 debounce = 2 "debounce delay for 'in'-pin in cycles"; | ||
| pin in ui32 max_pulse_length = 100 "max output pulse length"; | ||
| pin out bool on "turn device on"; | ||
| pin out bool off "turn device off"; | ||
| variable int debounce_cntr; | ||
| variable unsigned debounce_val; | ||
| variable unsigned pulse_length; | ||
| variable int state; | ||
|
|
||
|
Comment on lines
+39
to
+40
Contributor
There was a problem hiding this comment.
|
||
| option period no; | ||
| function _; | ||
| license "GPL"; | ||
| author "David Mueller"; | ||
| ;; | ||
| FUNCTION(_) { | ||
|
|
||
| if (( debounce < 1 ) || ( debounce > 10000 )) { | ||
| debounce_val = 2; // set a sane value | ||
| } else { | ||
| debounce_val = debounce; | ||
| } | ||
|
Comment on lines
+48
to
+52
Contributor
There was a problem hiding this comment. May I suggest (reads rtapi_u32 debounce_val = debounce;
if(debounce_val < 1 || debounce_val > 10000) {
debounce_val = 2; // set a sane value
}You may also want to cache rtapi_bool inval = in;
rtapi_bool isonval = is_on;and then use the cached values. |
||
|
|
||
| if (in && state == 0 ) { // input has changed from debounced 0 -> 1 | ||
| debounce_cntr++; | ||
| if ( debounce_cntr >= (int)debounce_val ) { | ||
| if (!is_on) { // turn ON if it's off | ||
| on_set(1); | ||
| off_set(0); | ||
| } else { // turn OFF if it's on | ||
| on_set(0); | ||
| off_set(1); | ||
| } | ||
| state = 1; | ||
| debounce_cntr = 0; | ||
| } | ||
| } else if (!in && state == 1) { // input has changed from debounced 1 -> 0 | ||
| debounce_cntr++; | ||
| if ( debounce_cntr >= (int)debounce_val ) { | ||
| state = 0; | ||
| debounce_cntr = 0; | ||
| } | ||
| } else if ((!is_on && off) || (is_on && on) || (pulse_length > max_pulse_length)) { | ||
| // reset outputs once device has switched or maximum pulse length is reached | ||
| on_set(0); | ||
| off_set(0); | ||
| debounce_cntr = 0; | ||
| pulse_length = 0; | ||
| } else { | ||
| debounce_cntr = 0; | ||
| pulse_length ++; | ||
| } | ||
| } | ||
|
|
||
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
Oops, something went wrong.
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.
debounce_valis unconditionally overwritten in the function. Having it as as variable here is expensive. Better use a local variable (see also other comment).