Skip to content

Commit 5e7f91f

Browse files
bocchinobocchino
committed
Update fpp spec
1 parent 96841d5 commit 5e7f91f

File tree

6 files changed

+40
-27
lines changed

6 files changed

+40
-27
lines changed

‎docs/fpp-spec.html

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7161,10 +7161,10 @@ <h4 id="Specifiers_Telemetry-Packet-Group-Specifiers_Syntax">7.16.1. Syntax</h4>
71617161
<div class="ulist">
71627162
<ul>
71637163
<li>
7164-
<p>An <a href="#Specifiers_Include-Specifiers">include specifier</a></p>
7164+
<p>An <a href="#Specifiers_Include-Specifiers">include specifier</a>.</p>
71657165
</li>
71667166
<li>
7167-
<p>A <a href="#Specifiers_Telemetry-Packet-Specifiers">telemetry packet specifier</a></p>
7167+
<p>A <a href="#Specifiers_Telemetry-Packet-Specifiers">telemetry packet specifier</a>.</p>
71687168
</li>
71697169
</ul>
71707170
</div>
@@ -7275,13 +7275,19 @@ <h4 id="Specifiers_Telemetry-Packet-Specifiers_Syntax">7.17.1. Syntax</h4>
72757275
<div class="ulist">
72767276
<ul>
72777277
<li>
7278-
<p>An <a href="#Specifiers_Include-Specifiers">include specifier</a></p>
7278+
<p><em>non-annotatable-include-specifier</em>.</p>
72797279
</li>
72807280
<li>
7281-
<p>A <a href="#Component-Instance-Member-Identifiers_Telemetry-Channel-Identifiers">telemetry channel identifier</a></p>
7281+
<p><em><a href="#Component-Instance-Member-Identifiers_Telemetry-Channel-Identifiers">telemetry-channel-identifier</a></em>.</p>
72827282
</li>
72837283
</ul>
72847284
</div>
7285+
<div class="paragraph">
7286+
<p>A <em>non-annotatable-include-specifier</em> is identical to an
7287+
<a href="#Specifiers_Include-Specifiers">include specifier</a>,
7288+
but it is not an
7289+
<a href="#Comments-and-Annotations_Annotations_Where-Annotations-Can-Occur">annotatable element</a>.</p>
7290+
</div>
72857291
</div>
72867292
<div class="sect3">
72877293
<h4 id="Specifiers_Telemetry-Packet-Specifiers_Semantics">7.17.2. Semantics</h4>
@@ -7328,15 +7334,15 @@ <h4 id="Specifiers_Telemetry-Packet-Specifiers_Semantics">7.17.2. Semantics</h4>
73287334
<h4 id="Specifiers_Telemetry-Packet-Specifiers_Examples">7.17.3. Examples</h4>
73297335
<div class="listingblock">
73307336
<div class="content">
7331-
<pre class="prettyprint highlight"><code data-lang="fpp"># CDH packet has id 0 and level 0
7337+
<pre class="prettyprint highlight"><code data-lang="fpp">@ CDH packet has id 0 and level 0
73327338
packet CDH id 0 level 0 {
73337339
commandDispatcher.commandsDispatched
73347340
rateGroup1Hz.rgMaxTime
73357341
include "DownlinkTelemetryChannels.fppi"
73367342
include "UplinkTelemetryChannels.fppi"
73377343
}
73387344

7339-
# Implicit id of ADCS packet is 1. Its level is 2.
7345+
@ Implicit id of ADCS packet is 1. Its level is 2.
73407346
packet ADCS level 2 {
73417347
adcs.mode
73427348
adcs.attitude
@@ -7608,10 +7614,11 @@ <h4 id="Component-Instance-Member-Identifiers_Port-Instance-Identifiers_Examples
76087614
<div class="sect2">
76097615
<h3 id="Component-Instance-Member-Identifiers_Telemetry-Channel-Identifiers">8.2. Telemetry Channel Identifiers</h3>
76107616
<div class="paragraph">
7611-
<p>A <strong>telemetry channel identifier</strong> identifies a telemetry channel
7612-
that is part of a component instance.
7613-
Telemetry channel identifiers appear in
7614-
<a href="#Specifiers_Telemetry-Packet-Specifiers">telemetry packet specifiers</a>.</p>
7617+
<p>A <strong>telemetry channel identifier</strong> identifies a telemetry channel that is part of
7618+
a component instance. Telemetry channel identifiers appear in
7619+
<a href="#Specifiers_Telemetry-Packet-Group-Specifiers">telemetry packet group
7620+
specifiers</a> and <a href="#Specifiers_Telemetry-Packet-Specifiers">telemetry packet
7621+
specifiers</a>.</p>
76157622
</div>
76167623
<div class="sect3">
76177624
<h4 id="Component-Instance-Member-Identifiers_Telemetry-Channel-Identifiers_Syntax">8.2.1. Syntax</h4>
@@ -10924,7 +10931,7 @@ <h3 id="Analysis-and-Translation_Translation-Tools">22.4. Translation Tools</h3>
1092410931
</div>
1092510932
<div id="footer">
1092610933
<div id="footer-text">
10927-
Last updated 2025-01-16 17:26:52 -0800
10934+
Last updated 2025-01-21 09:54:30 -0800
1092810935
</div>
1092910936
</div>
1093010937
<script src="code-prettify/run_prettify.js"></script>

‎docs/fpp-users-guide.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14817,7 +14817,7 @@ <h4 id="Writing-C-Plus-Plus-Implementations_Implementing-Deployments_Public-Symb
1481714817
</div>
1481814818
<div id="footer">
1481914819
<div id="footer-text">
14820-
Last updated 2025-01-16 15:54:49 -0800
14820+
Last updated 2025-01-21 09:54:50 -0800
1482114821
</div>
1482214822
</div>
1482314823
<script src="code-prettify/run_prettify.js"></script>

‎docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ <h1>F Prime Prime (FPP)</h1>
463463
</div>
464464
<div id="footer">
465465
<div id="footer-text">
466-
Last updated 2024-07-20 12:45:03 -0700
466+
Last updated 2025-01-21 09:53:59 -0800
467467
</div>
468468
</div>
469469
</body>

‎docs/spec/Component-Instance-Member-Identifiers.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,11 @@ port instance.
5050

5151
=== Telemetry Channel Identifiers
5252

53-
A *telemetry channel identifier* identifies a telemetry channel
54-
that is part of a component instance.
55-
Telemetry channel identifiers appear in
56-
<<Specifiers_Telemetry-Packet-Specifiers,telemetry packet specifiers>>.
53+
A *telemetry channel identifier* identifies a telemetry channel that is part of
54+
a component instance. Telemetry channel identifiers appear in
55+
<<Specifiers_Telemetry-Packet-Group-Specifiers,telemetry packet group
56+
specifiers>> and <<Specifiers_Telemetry-Packet-Specifiers,telemetry packet
57+
specifiers>>.
5758

5859
==== Syntax
5960

‎docs/spec/Specifiers/Telemetry-Packet-Group-Specifiers.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ which each element is a *telemetry packet group member*,
2121
and the terminating punctuation is a comma.
2222
A telemetry packet group member is one of the following:
2323

24-
* An <<Specifiers_Include-Specifiers,include specifier>>
24+
* An <<Specifiers_Include-Specifiers,include specifier>>.
2525

26-
* A <<Specifiers_Telemetry-Packet-Specifiers,telemetry packet specifier>>
26+
* A <<Specifiers_Telemetry-Packet-Specifiers,telemetry packet specifier>>.
2727

2828
_telemetry-channel-identifier-sequence_ is an
2929
<<Element-Sequences,element sequence>> in

‎docs/spec/Specifiers/Telemetry-Packet-Specifiers.adoc

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
A *telemetry packet specifier* specifies the format of a data
44
packet containing telemetry points.
55
A telemetry packet specifier is part of a
6-
<<Specifiers_Telemetry-Packet-Group-Specifiers,telemetry packet group
6+
<<Specifiers_Telemetry-Packet-Group-Specifiers,telemetry packet group
77
specifier>>, which is in turn part of a
88
<<Definitions_Topology-Definitions,topology definition>>.
99

@@ -23,10 +23,15 @@ which each element is a *telemetry packet member*,
2323
and the terminating punctuation is a comma.
2424
A telemetry packet member is one of the following:
2525

26-
* An <<Specifiers_Include-Specifiers,include specifier>>
26+
* _non-annotatable-include-specifier_.
2727

28-
* A <<Component-Instance-Member-Identifiers_Telemetry-Channel-Identifiers,
29-
telemetry channel identifier>>
28+
* _<<Component-Instance-Member-Identifiers_Telemetry-Channel-Identifiers,
29+
telemetry-channel-identifier>>_.
30+
31+
A _non-annotatable-include-specifier_ is identical to an
32+
<<Specifiers_Include-Specifiers,include specifier>>,
33+
but it is not an
34+
<<Comments-and-Annotations_Annotations_Where-Annotations-Can-Occur,annotatable element>>.
3035

3136
==== Semantics
3237

@@ -50,9 +55,9 @@ The type of _e_ must be
5055
<<Types_Internal-Types_Integer,_Integer_>>, and _e_ must evaluate
5156
to a nonnegative integer.
5257

53-
. FPP recursively resolves any include specifiers in
58+
. FPP recursively resolves any include specifiers in
5459
_telemetry-packet-member-sequence_.
55-
This action converts _telemetry-packet-member-sequence_ to a list _L_ of
60+
This action converts _telemetry-packet-member-sequence_ to a list _L_ of
5661
telemetry channel identifiers.
5762
For each telemetry channel identifier _I_ in _L_,
5863
the component instance referred to in _I_ must be
@@ -65,15 +70,15 @@ or through
6570

6671
[source,fpp]
6772
----
68-
# CDH packet has id 0 and level 0
73+
@ CDH packet has id 0 and level 0
6974
packet CDH id 0 level 0 {
7075
commandDispatcher.commandsDispatched
7176
rateGroup1Hz.rgMaxTime
7277
include "DownlinkTelemetryChannels.fppi"
7378
include "UplinkTelemetryChannels.fppi"
7479
}
7580
76-
# Implicit id of ADCS packet is 1. Its level is 2.
81+
@ Implicit id of ADCS packet is 1. Its level is 2.
7782
packet ADCS level 2 {
7883
adcs.mode
7984
adcs.attitude

0 commit comments

Comments
 (0)