From fec3c74f8f2e6b790b6d0768b646d6d5d6ba3e8c Mon Sep 17 00:00:00 2001 From: Rob Bocchino Date: Thu, 16 Jan 2025 09:36:21 -0800 Subject: [PATCH] Revise User's Guide Addresses #571 --- docs/fpp-spec.html | 2 +- docs/fpp-users-guide.html | 62 +++++++++---------- .../Analyzing-and-Translating-Models.adoc | 10 +-- docs/users-guide/Defining-Components.adoc | 44 ++++++------- docs/users-guide/Defining-State-Machines.adoc | 4 +- docs/users-guide/Introduction.adoc | 2 +- 6 files changed, 62 insertions(+), 62 deletions(-) diff --git a/docs/fpp-spec.html b/docs/fpp-spec.html index 3d25c330b..e5b954ca5 100644 --- a/docs/fpp-spec.html +++ b/docs/fpp-spec.html @@ -10582,7 +10582,7 @@

22.4. Translation Tools

diff --git a/docs/fpp-users-guide.html b/docs/fpp-users-guide.html index e9edf6138..78716e0ba 100644 --- a/docs/fpp-users-guide.html +++ b/docs/fpp-users-guide.html @@ -756,7 +756,7 @@

1. Introduction

SmallSat 2018 provides an overview of F Prime. For more detailed information about F Prime, see the -F Prime User Manual.

+F Prime User Manual.

The goals of FPP are as follows:

@@ -3635,8 +3635,8 @@

9.1. Writing of FPP state machines. For more details about the C++ code generation for state machines, see the -F Prime design -documentation.

+F +Prime design documentation.

@@ -5794,7 +5794,7 @@

10.2.1. Basic P 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 -F Prime User Manual.

+F Prime User Manual.

Note on terminology: As explained above, there is a technical @@ -6089,7 +6089,7 @@

10.2.6. Serial 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 F Prime User Manual.

+the F Prime User Manual.

@@ -6228,7 +6228,7 @@

10.3.1. Comman

For further information about command registration, receipt, and response, and implementing command handlers, see the -F Prime User Manual.

+F Prime User Manual.

@@ -6309,7 +6309,7 @@

10.3.2. Event Po

For further information about events in F Prime, see the -F Prime User Manual.

+F Prime User Manual.

@@ -6358,7 +6358,7 @@

10.3.3. Tele

For further information about telemetry in F Prime, see the -F Prime User Manual.

+F Prime User Manual.

@@ -6443,7 +6443,7 @@

10.3.4. Para

For further information about parameters in F Prime, see the -F Prime User Manual.

+F Prime User Manual.

@@ -6493,7 +6493,7 @@

10.3.5. Time

For further information about time in F Prime, see the -F Prime User Manual.

+F Prime User Manual.

@@ -6616,8 +6616,8 @@

10.3.6. D

For further information about data products in F Prime, see the -data -products documentation in the F Prime repository.

+F +Prime design documentation.

@@ -6761,7 +6761,7 @@

10.5. Commands

For complete information about F Prime command dispatch and handling, see the -F Prime User Manual. +F Prime User Manual. Here we concentrate on how to specify commands in FPP.

@@ -7124,7 +7124,7 @@

10.6. Events

For complete information about F Prime event handling, see the -F Prime User Manual. +F Prime User Manual. Here we concentrate on how to specify events in FPP.

@@ -7423,7 +7423,7 @@

10.6.4. Throttling

emit the event until the throttling is canceled. Typically, the canceling happens via a FSW command. For details, see the -F Prime User Manual.

+F Prime User Manual.

@@ -7444,7 +7444,7 @@

10.7. Telemetry

For complete information about F Prime telemetry handling, see the -F Prime User Manual. +F Prime User Manual. Here we concentrate on how to specify telemetry channels in FPP.

@@ -7804,7 +7804,7 @@

10.8. Parameters

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 -F Prime User Manual. +F Prime User Manual. Here we concentrate on how to specify parameters in FPP.

@@ -8135,8 +8135,8 @@

10.9. Data Products

(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 -F Prime data -products documentation.

+F +Prime design documentation.

10.9.1. Basic Data Products

@@ -8149,8 +8149,8 @@

10.9.1. Basic Dat representing a list of serialized records. A record is a unit of data. For a complete specification of the container format, see the -documentation -on F Prime framework support for data products.

+F +Prime design documentation.

In an F Prime component, you can specify one or more containers @@ -8215,8 +8215,8 @@

10.9.1. Basic Dat

The FPP back end uses this specification to generate code for requesting buffers to hold containers and for serializing records into containers. See the -F -Prime data products documentation for the details.

+F +Prime design documentation for the details.

Note the following:

@@ -8456,8 +8456,8 @@

10.10. State Machine Instan machine definitions may be internal (specified in FPP) or external (specified by an external tool). For more details about the C++ code generation for instances of internal state machines, see the -F Prime design -documentation.

+F +Prime design documentation.

@@ -12988,13 +12988,13 @@

Once you generate C++ code for these definitions, you can use it to write a flight software implementation. -The F +The 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 -F +F Prime design documentation.

@@ -13006,7 +13006,7 @@

F +the F Prime User Manual.

@@ -13982,8 +13982,8 @@

14.8. G T TopologyDictionary.json. The dictionary is specified in JavaScript Object Notation (JSON) format. The JSON format is specified in the -F -Prime dictionary documentation.

+F +Prime design documentation.

Here is a common use case:

@@ -14817,7 +14817,7 @@

-Last updated 2024-12-11 16:51:28 -0800 +Last updated 2025-01-16 09:31:14 -0800

diff --git a/docs/users-guide/Analyzing-and-Translating-Models.adoc b/docs/users-guide/Analyzing-and-Translating-Models.adoc index 0eeb68e73..08f33824c 100644 --- a/docs/users-guide/Analyzing-and-Translating-Models.adoc +++ b/docs/users-guide/Analyzing-and-Translating-Models.adoc @@ -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/devel/documentation/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/devel/documentation/user-manual/design/state-machines/[F Prime design documentation]. ==== Component Implementation and Unit Test Code @@ -581,7 +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 +the https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. *Generating implementation templates:* @@ -1361,8 +1361,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/devel/documentation/user-manual/design/fpp-json-dict/[F +Prime design documentation]. Here is a common use case: diff --git a/docs/users-guide/Defining-Components.adoc b/docs/users-guide/Defining-Components.adoc index 41c015807..e0ccee9dd 100644 --- a/docs/users-guide/Defining-Components.adoc +++ b/docs/users-guide/Defining-Components.adoc @@ -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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/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/devel/documentation/reference/sdd/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/devel/documentation/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/devel/documentation/user-manual/design/state-machines/[F +Prime design documentation]. === Constants, Types, Enums, and State Machines diff --git a/docs/users-guide/Defining-State-Machines.adoc b/docs/users-guide/Defining-State-Machines.adoc index 0c488d39f..c08202aa2 100644 --- a/docs/users-guide/Defining-State-Machines.adoc +++ b/docs/users-guide/Defining-State-Machines.adoc @@ -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/devel/documentation/user-manual/design/state-machines/[F +Prime design documentation]. === States, Signals, and Transitions diff --git a/docs/users-guide/Introduction.adoc b/docs/users-guide/Introduction.adoc index d6d6ad5fd..af688e63d 100644 --- a/docs/users-guide/Introduction.adoc +++ b/docs/users-guide/Introduction.adoc @@ -7,7 +7,7 @@ A https://digitalcommons.usu.edu/smallsat/2018/all2018/328/[paper presented at SmallSat 2018] provides an overview of F Prime. 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/devel/documentation/user-manual/[F Prime User Manual]. The goals of FPP are as follows: