nasa/fpp
1
0
Fork 0
mirror of https://github.com/nasa/fpp.git synced 2025-12-11 03:05:32 -06:00
Code Issues Packages Projects Releases 83 Wiki Activity

Revise spec for events

Browse Source
This commit is contained in:
Rob Bocchino 2025-09-22 13:22:12 -07:00
parent 32028b688a
commit 1149b73bc7
2 changed files with 37 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/fpp-spec.html
View File

@ -6102,14 +6102,18 @@ It has the following meaning:</p>
<ul>
<li>
<p>The expression <em>e</em> following <code>throttle</code> specifies the <strong>maximum throttle
count</strong>.
count</strong> for events with the specified numeric identifier.
The type of <em>e</em> must be convertible to
<a href="#Types_Internal-Types_Integer"><em>Integer</em></a> and must evaluate to an integer
in the range \$[0, 2^31)\$.
When the FSW asks the framework to emit events, a <strong>throttle count</strong>
starts at zero and goes up by one with each event emitted.
When the throttle count equals the maximum throttle count, no more events
are emitted until the throttle count is reset.</p>
For each event identifier <em>I</em> for which throttling is specified,
the framework maintains a <strong>throttle count</strong>.
The throttle count for identifier <em>I</em>
starts at zero and goes up by one with each event emitted with identifier <em>I</em>.
When the throttle count for identifier <em>I</em> equals the maximum throttle count
for <em>I</em>, no more events
with identifier <em>I</em> are emitted until the throttle count for identifier <em>I</em> is
reset.</p>
</li>
<li>
<p>The optional expression <em>e</em> following <code>every</code> specifies the <strong>throttle
@ -6133,12 +6137,15 @@ period</strong>.
</ul>
</div>
<div class="paragraph">
<p>If a throttle period \$p\$ is specified, and the throttle count
goes from zero to nonzero at time \$t\$, and an event request
occurs at or after time \$t + p\$, then the throttle count is
automatically reset to zero.
If no throttle period is specified, then the throttle count must be
reset in some other way (typically this is done by command).</p>
<p>If a throttle period \$p\$ is specified for event <em>I</em>, and the throttle
count
for <em>I</em> goes from zero to nonzero at time \$t\$, and a request
to emit event <em>I</em> occurs at or after time \$t + p\$, then the event is
emitted,
regardless of the throttle count for <em>I</em>, and the throttle count
for <em>I</em> is automatically reset to zero.
If no throttle period is specified for event <em>I</em>, then the throttle count
for <em>I</em> must be reset in some other way (typically this is done by command).</p>
</div>
</li>
</ul>
@ -11882,7 +11889,7 @@ equivalent.</p>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-09-22 12:00:45 -0700
Last updated 2025-09-22 13:21:26 -0700
</div>
</div>
<script src="code-prettify/run_prettify.js"></script>

29
docs/spec/Specifiers/Event-Specifiers.adoc
View File

@ -67,14 +67,18 @@ argument whose type is a <<Types_Internal-Types_Numeric-Types,numeric type>>.
It has the following meaning:
** The expression _e_ following `throttle` specifies the *maximum throttle
count*.
count* for events with the specified numeric identifier.
The type of _e_ must be convertible to
<<Types_Internal-Types_Integer,_Integer_>> and must evaluate to an integer
in the range stem:[[0, 2^31)].
When the FSW asks the framework to emit events, a *throttle count*
starts at zero and goes up by one with each event emitted.
When the throttle count equals the maximum throttle count, no more events
are emitted until the throttle count is reset.
For each event identifier _I_ for which throttling is specified,
the framework maintains a *throttle count*.
The throttle count for identifier _I_
starts at zero and goes up by one with each event emitted with identifier _I_.
When the throttle count for identifier _I_ equals the maximum throttle count
for _I_, no more events
with identifier _I_ are emitted until the throttle count for identifier _I_ is
reset.
** The optional expression _e_ following `every` specifies the *throttle
period*.
@ -93,12 +97,15 @@ stem:[[0,10^6)], and stem:[s + u] must be greater than zero.
+
+
If a throttle period stem:[p] is specified, and the throttle count
goes from zero to nonzero at time stem:[t], and an event request
occurs at or after time stem:[t + p], then the throttle count is
automatically reset to zero.
If no throttle period is specified, then the throttle count must be
reset in some other way (typically this is done by command).
If a throttle period stem:[p] is specified for event _I_, and the throttle
count
for _I_ goes from zero to nonzero at time stem:[t], and a request
to emit event _I_ occurs at or after time stem:[t + p], then the event is
emitted,
regardless of the throttle count for _I_, and the throttle count
for _I_ is automatically reset to zero.
If no throttle period is specified for event _I_, then the throttle count
for _I_ must be reset in some other way (typically this is done by command).
==== Examples