Skip to content

Fix issues in 'momentary2nist' and 'toggle2nist' components #4576

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.

Sign up for GitHub

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

Merged
grandixximo merged 1 commit into from
Sep 24, 2026
+47 −40
Merged

Fix issues in 'momentary2nist' and 'toggle2nist' components #4576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 16 additions & 21 deletions src/hal/components/momentary2nist.comp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ 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)
A debounce delay in cycles can be set for 'in'. (default = 2, maximum = 10000)
A maximum output pulse length in cycles can be set for 'on' and 'off'. (default = 1000)

* 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.
* If *is-on* does not confirm a state change until *max-pulse-length* is reached both pins *on* and *off* will remain low until the *in* pin changes state.
....
┐ ┌─────xxxxxxxxxxxx┐ ┌─────xxxxxxxxxxxx┐
in : └─────┘ xxxxxxxxxxxx└───────────┘ xxxxxxxxxxxx└─────
Expand All @@ -30,12 +31,12 @@ 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 in ui32 max_pulse_length = 1000 "max output pulse length";
pin out bool on "turn device on";
pin out bool off "turn device off";
variable unsigned debounce_cntr;
variable unsigned pulse_length;
variable bool state;
variable unsigned state = 2;

option period no;
function _;
Expand All @@ -52,34 +53,28 @@ FUNCTION(_) {
debounce_val = 2; // set a sane value
}

if (in_val && state == 0 ) { // input has changed from debounced 0 -> 1
if (in_val && state == 2 ) { // input has changed from 0 -> 1
debounce_cntr++;
if ( debounce_cntr >= debounce_val ) {
if (!ison_val) { // 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;
on_set(!ison_val);
off_set(ison_val);
pulse_length = 0;
state = !ison_val;
debounce_cntr = 0;
}
} else if (!in_val && state == 1) { // input has changed from debounced 1 -> 0
} else if (!in_val && state < 2) { // input has changed from 1 -> 0
debounce_cntr++;
if ( debounce_cntr >= debounce_val ) {
state = 0;
state = 2;
debounce_cntr = 0;
}
} else if ((!ison_val && off) || (ison_val && on) || (pulse_length > max_pulse_length)) {
// reset outputs once device has switched or maximum pulse length is reached
} else if ( (state < 2) && (ison_val != state) && (pulse_length < max_pulse_length) ) {
// Waiting for the 'ison' pin to confirm change of state
pulse_length ++;
} else {
on_set(0);
off_set(0);
debounce_cntr = 0;
pulse_length = 0;
} else {
debounce_cntr = 0;
pulse_length ++;
}
}

50 changes: 31 additions & 19 deletions src/hal/components/toggle2nist.comp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ description
Toggle2nist can be used with a latching switch or 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)
A debounce delay in cycles can be set for 'in'. (default = 2, maximum = 10000)
A maximum output pulse length in cycles can be set for 'on' and 'off'. (default and minimum = 1000)

* On a rising edge on pin *in* when *is-on* is low: It sets *on* until *is-on* becomes high.
* On a falling 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.
* If *is-on* does not confirm a state change until *max-pulse-length* is reached both pins *on* and *off* will remain low until the *in* pin changes state.

....
       ┐     ┌─────────────────────────────┐
Expand All @@ -31,12 +32,13 @@ is-on: └─────────────────┘       
pin in bool in "toggle 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 in ui32 max_pulse_length = 1000 "max output pulse length";
pin out bool on "turn device on";
pin out bool off "turn device off";
variable unsigned debounce_cntr;
variable unsigned pulse_length;
variable bool state;
variable unsigned state = 2;
variable bool old_in_val;

option period no;
function _;
Expand All @@ -48,39 +50,49 @@ FUNCTION(_) {
rtapi_bool in_val = in;
rtapi_bool ison_val = is_on;
rtapi_uint debounce_val = debounce;
rtapi_uint max_pulse_length_val = max_pulse_length;

if (( debounce_val < 1 ) || ( debounce_val > 10000 )) {
debounce_val = 2; // set a sane value
}
if ( max_pulse_length_val < 1000 ) {
max_pulse_length_val = 1000; // set a sane value
}

if (in_val && state == 0 ) { /* input has changed from debounced 0 -> 1 */
if (in_val && !ison_val && state == 2 ) { /* change from 0 -> 1 has been requested */
Comment thread
grandixximo marked this conversation as resolved.
debounce_cntr++;
if ( debounce_cntr >= debounce_val ) {
if (!ison_val) { /* turn ON if it's off */
on_set(1);
off_set(0);
}
on_set(1);
off_set(0);
pulse_length = 0;
state = 1;
debounce_cntr = 0;
}
} else if (!in_val && state == 1) { /* input has changed from debounced 1 -> 0 */
} else if (!in_val && ison_val && state == 2) { /* change from 1 -> 0 has been requested */
debounce_cntr++;
if ( debounce_cntr >= debounce_val ) {
if (ison_val) { /* turn OFF if it's on */
on_set(0);
off_set(1);
}
on_set(0);
off_set(1);
pulse_length = 0;
state = 0;
debounce_cntr = 0;
}
} else if ((!ison_val && off) || (ison_val && on) || (pulse_length > max_pulse_length)) {
// reset outputs once device has switched or maximum pulse length is reached
} else if ( (state < 2) && (ison_val != state) && (pulse_length < max_pulse_length_val) ) {
// Waiting for the 'ison' pin to confirm change of state
pulse_length ++;
} else if (pulse_length >= max_pulse_length_val) {
// Timeout waiting for 'ison' pin to confirm change of state
on_set(0);
off_set(0);
debounce_cntr = 0;
pulse_length = 0;
if (in_val != old_in_val) {
pulse_length = 0;
state = 2;
}
} else {
on_set(0);
off_set(0);
debounce_cntr = 0;
pulse_length ++;
state = 2;
}
old_in_val = in_val;
}
Loading