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

Updates to release branch

Browse Source
This commit is contained in:
Rob Bocchino 2025-01-22 18:20:00 -08:00
parent 275a026f5f
commit daef9115f9
14 changed files with 97 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.adoc
View File

@ -3,7 +3,7 @@
This repository contains the code and documentation for F Prime Prime (FPP for
short).
FPP is a modeling language for the
https://nasa.github.io/fprime/[F Prime flight software framework].
https://fprime.jpl.nasa.gov[F Prime flight software framework].
== Contents
@ -24,7 +24,7 @@ To use or develop FPP in a standalone mode, you should install these tools.
To use FPP as part of F Prime development, you can install the F Prime tool set,
which includes FPP.
See the F Prime installation instructions
https://github.com/nasa/fprime/blob/master/docs/INSTALL.md[here].
https://fprime.jpl.nasa.gov/latest/getting-started/installing-fprime/[here].
=== Spec and User's Guide

2
compiler/.jvmopts Normal file
View File

@ -0,0 +1,2 @@
-XX:+CMSClassUnloadingEnabled
-Xss2M

4
compiler/build.sbt
View File

@ -9,7 +9,7 @@ lazy val settings = Seq(
"-deprecation",
"-unchecked",
"-Xfatal-warnings",
"-Xmax-inlines:200"
"-Xmax-inlines:100"
),
libraryDependencies ++= dependencies,
Test / testOptions += Tests.Argument(TestFrameworks.ScalaTest, "-oNCXELOPQRM"),
@ -110,4 +110,4 @@ lazy val fpp_to_dict = (project in file("tools/fpp-to-dict"))
lazy val fpp_to_layout = (project in file("tools/fpp-to-layout"))
.settings(settings)
.dependsOn(lib)
.enablePlugins(AssemblyPlugin)
.enablePlugins(AssemblyPlugin)

7
docs/fpp-spec.html
View File

@ -977,10 +977,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<p>This document provides a detailed description of <strong>F Prime Prime</strong>, also known
as FPP or F Double Prime.
FPP is a modeling language for the
<a href="https://nasa.github.io/fprime/">F Prime flight software framework</a>.
A <a href="https://digitalcommons.usu.edu/smallsat/2018/all2018/328/">paper presented at
SmallSat 2018</a>
provides an overview of F Prime.</p>
<a href="https://fprime.jpl.nasa.gov">F Prime flight software framework</a>.</p>
</div>
<div class="paragraph">
<p>The goals of FPP are as follows:</p>
@ -10582,7 +10579,7 @@ equivalent.</p>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-12-11 16:51:10 -0800
Last updated 2025-01-22 18:15:37 -0800
</div>
</div>
<script src="code-prettify/run_prettify.js"></script>

72
docs/fpp-users-guide.html
View File

@ -751,12 +751,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<div class="paragraph">
<p>This document describes <strong>F Prime Prime</strong>, also known as FPP or F Double Prime.
FPP is a modeling language for the
<a href="https://nasa.github.io/fprime/">F Prime flight software framework</a>.
A <a href="https://digitalcommons.usu.edu/smallsat/2018/all2018/328/">paper presented at
SmallSat 2018</a>
provides an overview of F Prime.
<a href="https://fprime.jpl.nasa.gov">F Prime flight software framework</a>.
For more detailed information about F Prime, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.</p>
</div>
<div class="paragraph">
<p>The goals of FPP are as follows:</p>
@ -3635,8 +3632,8 @@ applications that use F Prime.</p>
of FPP state machines.
For more details about the C&#43;&#43; code generation
for state machines, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime design
documentation</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/state-machines/">F
Prime design documentation</a>.</p>
</div>
</div>
<div class="sect2">
@ -5794,7 +5791,7 @@ For example, in the C&#43;&#43; implementation, you would generate a
base class with a virtual handler function, and then override that virtual
function in a derived class that you write.
For further details about implementing F Prime components, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.</p>
</div>
<div class="paragraph">
<p><strong>Note on terminology:</strong> As explained above, there is a technical
@ -6089,7 +6086,7 @@ on that side.
This flexibility comes at the cost that you lose the type
compile-time type checking provided by port connections with named types.
For more information about serial ports and their use, see
the <a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
the <a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.</p>
</div>
</div>
</div>
@ -6228,7 +6225,7 @@ properly with F Prime C&#43;&#43; code generation.</p>
<div class="paragraph">
<p>For further information about command registration, receipt, and
response, and implementing command handlers, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.</p>
</div>
</div>
<div class="sect3">
@ -6309,7 +6306,7 @@ simplified definitions of these ports:</p>
</div>
<div class="paragraph">
<p>For further information about events in F Prime, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.</p>
</div>
</div>
<div class="sect3">
@ -6358,7 +6355,7 @@ simplified definition of this port:</p>
</div>
<div class="paragraph">
<p>For further information about telemetry in F Prime, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.</p>
</div>
</div>
<div class="sect3">
@ -6443,7 +6440,7 @@ simplified definitions of these ports:</p>
</div>
<div class="paragraph">
<p>For further information about parameters in F Prime, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.</p>
</div>
</div>
<div class="sect3">
@ -6493,7 +6490,7 @@ simplified definition of this port:</p>
</div>
<div class="paragraph">
<p>For further information about time in F Prime, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.</p>
</div>
</div>
<div class="sect3">
@ -6616,8 +6613,8 @@ simplified definitions of these ports:</p>
</div>
<div class="paragraph">
<p>For further information about data products in F Prime, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/design/data-products/">data
products documentation</a> in the F Prime repository.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/data-products/">F
Prime design documentation</a>.</p>
</div>
</div>
</div>
@ -6761,7 +6758,7 @@ as part of the component implementation.</p>
<div class="paragraph">
<p>For complete information about F Prime command dispatch and
handling, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.
Here we concentrate on how to specify commands in FPP.</p>
</div>
<div class="sect3">
@ -7124,7 +7121,7 @@ you can store in an on-board file system or send to the ground.</p>
<div class="paragraph">
<p>For complete information about F Prime event
handling, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.
Here we concentrate on how to specify events in FPP.</p>
</div>
<div class="sect3">
@ -7423,7 +7420,7 @@ instance has emitted it ten times.</p>
emit the event until the throttling is canceled.
Typically, the canceling happens via a FSW command.
For details, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.</p>
</div>
</div>
</div>
@ -7444,7 +7441,7 @@ or send them the ground.</p>
<div class="paragraph">
<p>For complete information about F Prime telemetry
handling, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.
Here we concentrate on how to specify telemetry channels in FPP.</p>
</div>
<div class="sect3">
@ -7804,7 +7801,7 @@ for a hardware device or a software algorithm.</p>
database component for storing parameters in a non-volatile
manner (e.g., on a file system).
For complete information about F Prime parameters, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.
Here we concentrate on how to specify parameters in FPP.</p>
</div>
<div class="sect3">
@ -8135,8 +8132,8 @@ for (1) managing buffers that can store data products in memory;
(2) writing data products to the file system; and (3)
cataloging stored data products for downlink in priority order.
For more information about these F Prime features, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime data
products documentation</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/data-products/">F
Prime design documentation</a>.</p>
</div>
<div class="sect3">
<h4 id="Defining-Components_Data-Products_Basic-Data-Products">10.9.1. Basic Data Products</h4>
@ -8149,8 +8146,8 @@ the container (e.g., the size of the data payload), and binary data
representing a list of serialized <strong>records</strong>.
A record is a unit of data.
For a complete specification of the container format, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/reference/api/cpp/html/_fw_dp.html">documentation</a>
on F Prime framework support for data products.</p>
<a href="https://fprime.jpl.nasa.gov/latest/Fw/Dp/docs/sdd/">F Prime design
documentation</a>.</p>
</div>
<div class="paragraph">
<p>In an F Prime component, you can specify one or more containers
@ -8215,8 +8212,8 @@ passive component BasicDataProducts {
<p>The FPP back end uses this specification to generate code for requesting
buffers to hold containers and for serializing records into containers.
See the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/design/data-products/">F
Prime data products documentation</a> for the details.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/data-products/">F
Prime design documentation</a> for the details.</p>
</div>
<div class="paragraph">
<p>Note the following:</p>
@ -8456,8 +8453,8 @@ active component StateMachine {
machine definitions may be internal (specified in FPP) or external (specified
by an external tool). For more details about the C&#43;&#43; code generation for
instances of internal state machines, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime design
documentation</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/state-machines/">F
Prime design documentation</a>.</p>
</div>
</div>
<div class="sect2">
@ -8850,7 +8847,9 @@ a schedule input port for driving the component periodically on a rate group,
a time get port for getting the time, and a telemetry port
for reporting telemetry.
(For more information on rate groups and the use of <code>Svc.Sched</code>
ports, see the F Prime documentation.)
ports, see the
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/rate-group/">F Prime
documentation</a>.)
We have given the component two telemetry channels:
<code>ImpulseTemp</code> for reporting the temperature of the impulse engine,
and <code>WarpTemp</code> for reporting the temperature of the warp core.</p>
@ -12988,13 +12987,13 @@ uses the name <code>A_B_CComponentAc_HPP</code> in its include guard.</p>
<div class="paragraph">
<p>Once you generate C&#43;&#43; code for these definitions, you can use it to
write a flight software implementation.
The <a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F
The <a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F
User Manual</a> explains how to do this.</p>
</div>
<div class="paragraph">
<p>For more information about the generated code for data products,
for state machines, and for state machine instances, see the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/state-machines/">F
Prime design documentation</a>.</p>
</div>
</div>
@ -13006,8 +13005,7 @@ or
partial implementations and for generating unit test code.
Here we cover the mechanics of using these options.
For more information on implementing and testing components in F Prime, see
the <a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F
Prime User Manual</a>.</p>
the <a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/">F Prime User Manual</a>.</p>
</div>
<div class="paragraph">
<p><strong>Generating implementation templates:</strong>
@ -13982,8 +13980,8 @@ file
<em>T</em> <code>TopologyDictionary.json</code>.
The dictionary is specified in JavaScript Object Notation (JSON) format.
The JSON format is specified in the
<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/design/fpp-json-dict/">F
Prime dictionary documentation</a>.</p>
<a href="https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/fpp-json-dict/">F
Prime design documentation</a>.</p>
</div>
<div class="paragraph">
<p>Here is a common use case:</p>
@ -14817,7 +14815,7 @@ function, you may.</p>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-12-11 16:51:28 -0800
Last updated 2025-01-22 18:17:25 -0800
</div>
</div>
<script src="code-prettify/run_prettify.js"></script>

6
docs/index.html
View File

@ -439,8 +439,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</div>
<div id="content">
<div class="paragraph">
<p>FPP is a modeling language for the <a href="https://nasa.github.io/fprime/">F Prime
flight software framework</a>.
<p>FPP is a modeling language for the
<a href="https://fprime.jpl.nasa.gov">F Prime flight software framework</a>.
To use FPP, you write a model in the source language; then you use the FPP
tools to generate XML and C&#43;&#43;. Compared to writing XML by hand, FPP provides
a cleaner and more succinct syntax, a well-defined semantics, good error
@ -463,7 +463,7 @@ generated code.</p>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-20 12:45:03 -0700
Last updated 2025-01-22 18:15:32 -0800
</div>
</div>
</body>

14
docs/index/defs.sh Normal file
View File

@ -0,0 +1,14 @@
#!/bin/sh -e
# ----------------------------------------------------------------------
# defs.sh
# ----------------------------------------------------------------------
export LEVEL=../..
. $LEVEL/defs.sh
redo-ifchange defs.sh
export FILES="
index.adoc
"

4
docs/index/index.adoc
View File

@ -1,7 +1,7 @@
= F Prime Prime (FPP)
FPP is a modeling language for the https://nasa.github.io/fprime/[F Prime
flight software framework].
FPP is a modeling language for the
https://fprime.jpl.nasa.gov[F Prime flight software framework].
To use FPP, you write a model in the source language; then you use the FPP
tools to generate XML and {cpp}. Compared to writing XML by hand, FPP provides
a cleaner and more succinct syntax, a well-defined semantics, good error

5
docs/spec/Introduction.adoc
View File

@ -3,10 +3,7 @@
This document provides a detailed description of **F Prime Prime**, also known
as FPP or F Double Prime.
FPP is a modeling language for the
https://nasa.github.io/fprime/[F Prime flight software framework].
A https://digitalcommons.usu.edu/smallsat/2018/all2018/328/[paper presented at
SmallSat 2018]
provides an overview of F Prime.
https://fprime.jpl.nasa.gov[F Prime flight software framework].
The goals of FPP are as follows:

11
docs/users-guide/Analyzing-and-Translating-Models.adoc
View File

@ -566,12 +566,12 @@ uses the name `A_B_CComponentAc_HPP` in its include guard.
Once you generate {cpp} code for these definitions, you can use it to
write a flight software implementation.
The https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F
The https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F
User Manual] explains how to do this.
For more information about the generated code for data products,
for state machines, and for state machine instances, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F
https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/state-machines/[F
Prime design documentation].
==== Component Implementation and Unit Test Code
@ -581,8 +581,7 @@ or
partial implementations and for generating unit test code.
Here we cover the mechanics of using these options.
For more information on implementing and testing components in F Prime, see
the https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F
Prime User Manual].
the https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
*Generating implementation templates:*
When you run `fpp-to-cpp` with option `-t` and without option `-u`,
@ -1361,8 +1360,8 @@ file
_T_ `TopologyDictionary.json`.
The dictionary is specified in JavaScript Object Notation (JSON) format.
The JSON format is specified in the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/design/fpp-json-dict/[F
Prime dictionary documentation].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/fpp-json-dict/[F
Prime design documentation].
Here is a common use case:

4
docs/users-guide/Defining-Component-Instances.adoc
View File

@ -84,7 +84,9 @@ a schedule input port for driving the component periodically on a rate group,
a time get port for getting the time, and a telemetry port
for reporting telemetry.
(For more information on rate groups and the use of `Svc.Sched`
ports, see the F Prime documentation.)
ports, see the
https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/rate-group/[F Prime
documentation].)
We have given the component two telemetry channels:
`ImpulseTemp` for reporting the temperature of the impulse engine,
and `WarpTemp` for reporting the temperature of the warp core.

44
docs/users-guide/Defining-Components.adoc
View File

@ -142,7 +142,7 @@ For example, in the {cpp} implementation, you would generate a
base class with a virtual handler function, and then override that virtual
function in a derived class that you write.
For further details about implementing F Prime components, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
*Note on terminology:* As explained above, there is a technical
distinction between a _port type_ (defined outside any component, and providing
@ -405,7 +405,7 @@ on that side.
This flexibility comes at the cost that you lose the type
compile-time type checking provided by port connections with named types.
For more information about serial ports and their use, see
the https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
the https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
=== Special Port Instances
@ -507,7 +507,7 @@ properly with F Prime {cpp} code generation.
For further information about command registration, receipt, and
response, and implementing command handlers, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
==== Event Ports
@ -566,7 +566,7 @@ module Fw {
--------
For further information about events in F Prime, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
==== Telemetry Ports
@ -609,7 +609,7 @@ module Fw {
--------
For further information about telemetry in F Prime, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
==== Parameter Ports
@ -671,7 +671,7 @@ module Fw {
--------
For further information about parameters in F Prime, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
==== Time Get Ports
@ -715,7 +715,7 @@ module Fw {
--------
For further information about time in F Prime, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
==== Data Product Ports
@ -811,8 +811,8 @@ module Fw {
--------
For further information about data products in F Prime, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/design/data-products/[data
products documentation] in the F Prime repository.
https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/data-products/[F
Prime design documentation].
=== Internal Ports
@ -944,7 +944,7 @@ as part of the component implementation.
For complete information about F Prime command dispatch and
handling, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
Here we concentrate on how to specify commands in FPP.
==== Basic Commands
@ -1271,7 +1271,7 @@ you can store in an on-board file system or send to the ground.
For complete information about F Prime event
handling, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
Here we concentrate on how to specify events in FPP.
==== Basic Events
@ -1545,7 +1545,7 @@ Once an event is throttled, the component instance will no longer
emit the event until the throttling is canceled.
Typically, the canceling happens via a FSW command.
For details, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
=== Telemetry
@ -1562,7 +1562,7 @@ or send them the ground.
For complete information about F Prime telemetry
handling, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
Here we concentrate on how to specify telemetry channels in FPP.
==== Basic Telemetry
@ -1890,7 +1890,7 @@ F Prime has special support for parameters, including a parameter
database component for storing parameters in a non-volatile
manner (e.g., on a file system).
For complete information about F Prime parameters, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
Here we concentrate on how to specify parameters in FPP.
==== Basic Parameters
@ -2199,8 +2199,8 @@ for (1) managing buffers that can store data products in memory;
(2) writing data products to the file system; and (3)
cataloging stored data products for downlink in priority order.
For more information about these F Prime features, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime data
products documentation].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/data-products/[F
Prime design documentation].
==== Basic Data Products
@ -2212,8 +2212,8 @@ the container (e.g., the size of the data payload), and binary data
representing a list of serialized *records*.
A record is a unit of data.
For a complete specification of the container format, see the
https://fprime.jpl.nasa.gov/latest/documentation/reference/api/cpp/html/_fw_dp.html[documentation]
on F Prime framework support for data products.
https://fprime.jpl.nasa.gov/latest/Fw/Dp/docs/sdd/[F Prime design
documentation].
In an F Prime component, you can specify one or more containers
and one or more records.
@ -2275,8 +2275,8 @@ passive component BasicDataProducts {
The FPP back end uses this specification to generate code for requesting
buffers to hold containers and for serializing records into containers.
See the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/design/data-products/[F
Prime data products documentation] for the details.
https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/data-products/[F
Prime design documentation] for the details.
Note the following:
@ -2495,8 +2495,8 @@ As discussed
machine definitions may be internal (specified in FPP) or external (specified
by an external tool). For more details about the {cpp} code generation for
instances of internal state machines, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime design
documentation].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/state-machines/[F
Prime design documentation].
=== Constants, Types, Enums, and State Machines

4
docs/users-guide/Defining-State-Machines.adoc
View File

@ -87,8 +87,8 @@ In this manual, we focus on the syntax and high-level behavior
of FPP state machines.
For more details about the {cpp} code generation
for state machines, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime design
documentation].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/state-machines/[F
Prime design documentation].
=== States, Signals, and Transitions

7
docs/users-guide/Introduction.adoc
View File

@ -2,12 +2,9 @@
This document describes **F Prime Prime**, also known as FPP or F Double Prime.
FPP is a modeling language for the
https://nasa.github.io/fprime/[F Prime flight software framework].
A https://digitalcommons.usu.edu/smallsat/2018/all2018/328/[paper presented at
SmallSat 2018]
provides an overview of F Prime.
https://fprime.jpl.nasa.gov[F Prime flight software framework].
For more detailed information about F Prime, see the
https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F Prime User Manual].
https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual].
The goals of FPP are as follows: