717 Commits

Author SHA1 Message Date
M Starch
0a822b577a
Port patterns (#3132)
* Synchronous cancel guide, and Fw.Signal implementation

Fixing name in CMakeList for Fw.Signal

Draft of other port patterns

More port patterns with reoganized structure

Adding completion status port

Proof-read ports paterns doc

Fixing expert review elements w/ common port patterns

Updating links to point to devel examples

* Fixing path from old to new

* Fix relative links

* Update mkdocs.yml and ordering

* Fixing [!NOTE]

---------

Co-authored-by: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com>
2025-02-13 15:49:56 -08:00
Thomas Boyer-Chammard
3f61f887e4
Restructure user manual for holding design patterns (#3222)
* Doc restructure with design-patterns and build-system sections

* Restore advanced.md and uts.md

* Link in UTs

* Fix link

* Remove card layout from user manual landing page

* Add back the cards
2025-02-13 13:54:43 -08:00
Thomas Boyer-Chammard
fbecbaba3b
Use mkdocs search boosting instructions for website pages (#3212)
* Exclude Ref SDD from search results

* Update source-tree.md
2025-02-12 12:55:14 -08:00
Sibo Van Gool
82b6549356
[Docs] Correct small typos (#3165) 2025-01-28 09:18:37 -08:00
Thomas Boyer-Chammard
e09462f283
Fix outdated links and cross-reference docs locally (#3153) 2025-01-22 14:28:10 -08:00
Thomas Boyer-Chammard
f5265e8ff5
Fix mardkown warning in SBOM docs (#3152) 2025-01-21 15:39:39 -08:00
Thomas Boyer-Chammard
6f1369bbcf
Update docs structure for website versioning improvements (#3150)
---------

Co-authored-by: ashleynilo <ashley.k.santiago@jpl.nasa.gov>
2025-01-21 14:32:52 -08:00
M Starch
b4cfcafb7d
Integrating SBOM generation into CMake (#3138)
* Integrating SBOM generation into CMake

* Fixing missing 'syft' tool bug, adding documentation

* sp
2025-01-21 13:04:26 -08:00
Thomas Boyer-Chammard
334c525984
Add SDD aggregation into the core website (#3139) 2025-01-15 14:05:46 -08:00
Rob Bocchino
02a351c600
FPP v2.3.0a1 (#3066)
* Update requirements to use new fpp version

* Removed unneeded files

* update FppTest for new autocoder changes

* Get unit tests updated and working for fpp state machines phase 1 delivery

* Rename Fw/SMTest to Fw/Sm

* Update STARS to use FW_ASSERT

* Rename SMSignalBuffer to SmSignalBuffer

* Fix spelling issues with CI

* Update requirements to the FPP alpha release v2.2.0a3

* Fix requirements.txt

* Fix requirements.txt

* Initialize data in the constructor of SmSignalBuffer

* Add constructor list to all the constructors in SmSignalBuffer

* Reorganize FppTest directories

Move external state machine tests to state_machine/external

* Add missing file

* Reorganize FppTest/state_machine

external --> external_instance

* Add state machine test harness

* Revise SmGuard

* Fix include guard

* Add header file for test harness

* Revise Basic state machine

* Revise Basic test

* Add Junction test

* Add missing file

* Refactor internal state machine tests

* Add Nested state machine

* Revise Nested test

* Revise state machine tests

* Fix issues in string utils

* Revise FppTest

Add signals to state machine tests

* Refactor state machine test harness

* Revise autocode for Basic test

Replace with actual autocode

* Update fpp version

Fix F Prime to match
Switch initial/basic test from checked-in to auto-generated

* Revise FppTest

Make state machine guards const

* Update fpp version

Convert initial/Junction test to autocode

* Update fpp version

Make initial/nested test use autocode

* Start to add State/Basic test

* Revise FppTest

Revise namespaces in state machine tests

* Revise SmState::Basic test

* Update fpp version

Convert SmState/Basic test to use autocoding

* Update FppTest

* Add SmState/BasicSelf test

* Add state/BasicGuard test

* Add SmState/BasicU32 test

* Revise state machine tests

* Refactor state machine tests

* Revise FppTest

* Revise comments

* Refactor state machine tests

* Refactor state machine tests

* Refactor state machine tests

* Refactor state machine tests

* Revise state machine tests

* Revise state machine tests

* Revise state machine tests

* Revise state machine tests

* Revise fpp tests

* Revise state machine tests

* Revise state machine tests

* Revise state machine tests

* Revise state machine tests

* Revise state machine tests

* Add README files to FPP tests

* Start to add StateToState test

* Revise StateToState test

* Revise StateToState test

* Revise StateToState test

* Revise StateToState test

* Revise StateToState test

Remove hand-generated files

* Revise StateToState tests

* Add BasicInternal test

* Update fpp version

* Revise state machine tests

* Add state-to-junction test

* Add Internal state machine test

* Add Polymorphism test

* Add StateToChild test

* Revise README files

* Add junction/Basic test

* Revise FppTest build

* Update fpp version; revise Basic test

* Revise junction tests

* Add BasicGuardU32 test

* Add BasicGuardString test

* Add BasicGuardTestAbsType test

* Add BasicGuardTestArray test

* Add BasicGuardTestEnum test

* Add BasicGuardTestStruct test

* Add junction/Sequence test

* Add junction/SequenceU32 test

* Add junction/InputPairU16U32 test

* Add JunctionToState.fpp

* Add junction/JunctionToState test

* Add junction/JunctionToJunction test

* Update fpp version

* Update fpp version

Revise test code to match

* Update fpp version

* Update fpp version

* Fix CMakeLists

* Update fpp version

* Update fpp version

* Refactor sm tests

* Refactor sm tests

* Refactor sm tests

* Update fpp version

* Start to add internal_instance tests

* Add missing files

* Revise state machine tests

* Revise state machine tests

* Revise sm instance initial tests

* Revise sm instance init tests

* Revise sm instance initial tests

* Revise sm instance initial tests

* Add sm instance state tests

* Revise sm instance state tests

* Revise sm instance state tests

* Revise sm instance state tests

* Revise sm instance state tests

* Revise internal instance state tests

* Revise sm instance state tests

* Revise sm instance state tests

* Revsie BasicGuardTestAbsType

* Revise sm instance state tests

* Revise BasicGuardTestAbsType

* Add BasicGuardTestArray

* Add BasicGuardTestEnum

* Add BasicGuardTestStruct

* Add BasicGuardU32

* Add BasicInternal

* Revise BasicInternal

* Add BasicSelf

* Reformat code

* Add BasicString test

* Add BasicTestAbsType

* Add BasicTestArray

* Add BasicTestEnum

* Add BasicTestStruct

* Add BasicU32

* Remove extraneous file

* Remove extraneous files

* Revise sm tests

* Revise state machine tests

* Add Internal test

* Add Polymorphism test

* Add StateToChild test

* Add StateToJunction test

* Add StateToSelf test

* Add StateToState test

* Add junction/Basic

* Add BasicU32 test

* Add InputPairU16U32

* Add JunctionToJunction

* Revise comments

* Add JunctionToState

* Revise JunctionToState

* Revise JunctionToJunction

* Add Sequence test

* Add Sequence test

* Revise SequenceU32 test

* Revise state machine tests

Add tests for queued components

* Revise Basic test

Add schedIn handler

* Revise junction/Basic test

Add schedIn handler

* Revise state/Basic test

Add schedIn handler

* Revise initial/Basic test

Add multiple instances of the same state machine

* Revise state/Basic test

Add multiple instances of the same state machine

* Reformat code

* Update fpp version

* Update fpp; revise FppTest

* Refactor internal/initial tests

* Revise state machine tests

* Revise internal/state tests

* Revise state-machine/internal tests

Rename junction to choice

* Revise state-machine/internal tests

* Reformat C++ files

* Revise state-machine/internal_instance/initial tests

* Revise internal_instance/state tests

* Format code

* Revise internal_instance/choice tests

* Update fpp version

* Format code

* Update fpp version

* Improve const correctness in Fw/Port

* Update design

* Revise state machines design

* Revise state machine design

* Revise state machine design

* Revise state machine design

* Revise state machine design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machine instances design

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Update fpp version

* Update fpp version; revise code to match

* Update fpp version

* Revise state machines design

* Revise state machines design

Add class diagram

* Revise state machines design

* Revise state machines design

* Revise typography

Close up spaces in names with embedded variables

* Revise state machines design

* Revise state machines design

* Revise state machines design

* Revise state machine unit tests

* Revise state machine tests

Increase code coverage

* Revise state machine tests

Increase code coverage

* Update fpp version

* Update spelling

* Remove Design directory

This directory no longer exists in fprime/devel

* Update mkdocs

---------

Co-authored-by: watney <garth.j.watney@jpl.nasa.gov>
Co-authored-by: garthwatney <160269551+garthwatney@users.noreply.github.com>
Co-authored-by: M Starch <LeStarch@googlemail.com>
2025-01-06 14:58:54 -08:00
Josh Soref
5be3b19881
Check spelling 0.0.24 (#3051)
* Change line endings

* link: Checklist

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* link: described in detail

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* link: F´ key features

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* link: `Fw::Buffer` documentation is available

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* link: installing cmake command line tools on a mac

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* link: Svc.StaticMemory is described in more detail

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* link: testing_fw/predicates.py

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* link: the source code

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: a

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: adhered

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: cannot

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: case-sensitive

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: deployment

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: filter events based on event severity

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: its

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: nonexistent

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: prepending

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: products

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: schema

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: stressful

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: the

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* spelling: valued

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* Add check-spelling

---------

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2024-12-17 10:02:50 -08:00
Thomas Boyer-Chammard
97666b2755
Default website theme to light and minor format updates (#3067)
* Minor doc updates: formatting and add item in reference list

* Add bold font again

* Do not pick up system theme - hard default to light theme
2024-12-10 13:19:41 -08:00
Thomas Boyer-Chammard
2fbc151f2e
Remove "system preference" option for light/dark theme (#3065) 2024-12-10 11:24:54 -08:00
Thomas Boyer-Chammard
9f8355158e
Fix old XML docs to FPP and remove deprecated docs (#3062) 2024-12-10 11:23:13 -08:00
Thomas Boyer-Chammard
f378b20907
Clean up getting started guide (#3061) 2024-12-10 11:22:54 -08:00
Ashley Nilo
9367a3ba2f
Restructure docs for new website (#3036)
---------

Co-authored-by: chammard <thomas.boyer.chammard@jpl.nasa.gov>
2024-12-06 12:48:09 -08:00
M Starch
92df69218a
Add in Svc::ChronoTime for C++11 std::chrono implementation (#3049)
* Add in Svc::ChronoTime for C++11 std::chrono implementation. Fixes: nasa/fprime#3048

* Fix test name

* Fixing spelling problems
2024-11-25 13:36:22 -08:00
Thomas Boyer-Chammard
b8a259f791
Remove old RTEMS5 link from docs (#3044) 2024-11-25 11:09:34 -08:00
kevin-f-ortega
3c5fd74d08
Fix arm tut (#2962)
* removed sudo as it's no longer needed

* Updated to use json instead of xml since we are moving away from xml
2024-10-16 16:38:27 -07:00
Thomas Boyer-Chammard
fd7a51591b
Farewell, pirate logo! (#2958)
* Update F Prime logo

* Add fprime-sticker.png

* Such change, much wow

* Remove sticker png
2024-10-16 15:19:15 -07:00
kevin-f-ortega
4246aef14c
Remove sudo from cross-compilation tutorial (#2957) 2024-10-16 13:59:30 -07:00
Thomas Boyer-Chammard
d43fe504ff
Fix Jekyll docs build error from curly braces interpretation (#2951)
* Fix Jekyll docs build error from curly braces interpretation

* fix spelling
2024-10-15 11:33:45 -07:00
kevin-f-ortega
395a02558f
Fix paths in Cross Compiling Tutorial (#2885) 2024-09-23 09:36:41 -07:00
Zimri Leisher
b0716ad605
Add sequence dispatcher component (#2731)
* Add sequence dispatcher component

* Add seq start port to cmd sequencer

* Update author names and some include paths

* Get fully compiling, move consts/enums to correct places, check for connections on init

* Add spelling exceptions

* Get unit tests almost compiling...

* Fix string type in port, call component init in test

* Fix unit test compilation errors and assertions

* Switch back to using StringBase

* Switch to FwIndexType, remove textLogIn

* UpperCamel events, add warning for unexpected seq start

* remove init method, add check for connected to getNextAvailableIdx

* Update sdd, change event from low to high, static cast a portnum

* Add state diagram, add more warnings, fix wrong header types, use assert instead of warning for runSeq

---------

Co-authored-by: Zimri Leisher <zimri.leisher@fireflyspace.com>
2024-09-17 17:55:09 -07:00
Alex Mariano
4476828cb3
Update CI to use Json dictionaries (#2806)
* Change CI to use Json dictionaries

* Bumping to gds/tools for alpha release of JSON dictionary

* Change Workflow RPI Dictionary to JSON

* Install requirements.txt on RPIs for integration tests

---------

Co-authored-by: M Starch <LeStarch@googlemail.com>
Co-authored-by: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com>
2024-08-26 15:14:53 -07:00
Maurice Prather
fd117428d2
Updated troubleshooting md (#2843)
* Updated troubleshooting md

Improved 'fprime-util: command not found' section. Related to #2837

* Corrected typo
2024-08-21 15:52:53 -07:00
M Starch
7159e7e347
Implements #2723: Adds Os::Console to replace Os::Log (#2831)
* Initial logging refactor - WIP

* Removing LogAssert as it is not used

* Working on Fw::Logger rewrite

* Initial Os::Console refactor

* Fixing Fw::Logger unit tests

* Fixing up UT build

* Adding Os::Stub::Console implementation

* Added interface UTs

* Adding posix console tests

* Fixing Linux errors

* Spelling

* Initial review requests

* Fixing RPI build issues

* Fixing codeql errors

* Fixing code QL

* Validating 'message' parameter
2024-08-15 18:53:36 -07:00
Ali Mosallaei
afafe35382
docs: Add documentation for F' subtopologies (#2743)
* Initial work on subtopology documentation

* Begin work on MySubtopology.cpp

* Draft 1

* Fix technical errors

* Remove intentionally-empty.cpp

* Working in Thomas' comments; spelling and toc

* Spelling

* Add note about phases in subtopologies

* Link replacement change + info about fprime-util new subtopology

* Spelling

* Update docs to use phases and mention tool

* Address Thomas' comments

* Update for comments and addressing autocoder more

---------

Co-authored-by: M Starch <LeStarch@googlemail.com>
2024-08-01 16:49:21 -07:00
Ali Mosallaei
aa178da137
docs: Add AC pre-processor pattern to docs (#2808)
* Add pre-processor pattern to docs

* Update spelling

* Address comments
2024-07-31 14:58:10 -07:00
Alex Mariano
cd5dbc001b
Add Hub-Pattern Documentation (#2791)
* Add Hub Pattern Documentation

* Add more description to Hub Pattern

* Fix Hub Documentation and Images

* Fix Hub Diagram Text and typos

* Add Reference Placeholder

* Change Port In-Out Description

* Fix Spelling

* Fix Grammar + Remove Topology.cpp fix

* Fix Spelling

* Emphasize Example + Reword

* Link Hub-Pattern-Example

* Fix Spelling

* Fix Typo
2024-07-24 13:38:53 -07:00
Sibo Van Gool
6e250345f8
Change markdown formatting (#2804) 2024-07-22 10:33:48 -07:00
Thomas Boyer-Chammard
627e91a0c0
Add SmallSat Tutorial to upcoming events (#2789) 2024-06-27 10:24:19 -07:00
Gavin Knudsen
ab15995871
Reorganize Docs with Diatixis Method (#2717)
* Diataxis Regrouping Documentation

* fixed typo from three categories to four in documentation

* Fixed h4 tag error in TOC and links in Reference README and including Design general.md

* Fixed some more links in documentation

* Fixed links in documentation

* Fix md links

* wip

* Update Reference

* Change title

* Make reference a table

* Reword getting started

* Reword FPP user guide

---------

Co-authored-by: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com>
2024-06-26 10:23:36 -07:00
Thomas Boyer-Chammard
45a127add3
Add hyperlinks to Upcoming Events (#2787) 2024-06-25 10:46:33 -07:00
M Starch
70b47324c1
Update upcoming events (#2767)
* Update upcoming events

* Edits

* More edits

* spelling: Add google forms URLs to patterns.txt

* spelling: add Prime Prime to patterns

* Update with link to SMC-IT conference

* spelling: Add URLs to patterns
---------

Co-authored-by: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com>
2024-06-21 15:57:20 -07:00
Rob Bocchino
ca08ac93d7
Update FPP to v2.1.0a11 (#2745)
* Code updates for FPP v2.1.0a11

* Fix link in data products docs

* Remove uses of new

To keep the leak checker happy

* Revise string test

* Replace F' with F Prime in data products docs
2024-06-04 10:14:45 -07:00
Ryder Dettloff
5170217278
refactored FW_OBJ_NAME, FW_QUEUE_NAME, and FW_TASK_NAME. (#2751)
Co-authored-by: kayleyyoung253 <kayley.young253@gmail.com>
2024-06-04 10:12:37 -07:00
M Starch
8b92b70034
Remove dead link to kitware blog (#2746) 2024-05-24 12:00:08 -07:00
Thomas Boyer-Chammard
0fe467c6e2
Add -Wno-format-truncation to root project (#2719)
* Remove BUILD_TYPE=Release

* Add -Wno-format-truncation

* Only push to docs branch if from devel branch

* Only when not clang

* lock gcc version

* Lock to GCC and remove extra stuff

* debugging

* more debugging...

* Revert changes to autodocs CI

* Don't use -Wno-format-truncation when using clang-tidy
2024-05-20 17:08:16 -07:00
konerzajakub
bd2296f2f0
fixed typo (#2736) 2024-05-18 09:36:13 -07:00
Saurav Maheshkar
109e4bd399
feat(ci): add markdown link checker (#2651)
* feat(ci): add markdown link checker

* Fixing sp

* feat(ci): specify markdown lint check params

* Remove verbose mode

* Remove sdd.html links

* Add historical note to ci/README.md

* Fix broken links

* Fix more dead links

* Test replacementPatterns for CMake API

* Use config file correctly

* Fix config path

* Spell out replacement field

* Add C++ API redirect

* Escape `c++` pattern

* Fix another batch of dead links

* fix options and spelling

* docs: address comments

* docs: address comments

* Fix FPP Wiki links to NASA org

---------

Co-authored-by: M Starch <LeStarch@googlemail.com>
Co-authored-by: thomas-bc <thomas.boyerchammard@gmail.com>
Co-authored-by: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com>
2024-04-24 16:51:42 -07:00
Richard
8aa3c3f677
Trouble shooting guide update links (#2698)
* trouble-shooting-guide-2500
 - Add troubleshooting.md.
   This is currently a copy of the troubleshooting section of
   https://nasa.github.io/fprime/INSTALL.html

* trouble-shooting-guide-2500
 - Update INSTALL.md and remove troubleshooting guide and redirect
   to newly created separate file.
 - Remove empty line / space from troubleshooting.md.

* trouble-shooting-guide-2500
 - Update section links in INSTALL.md System Requirements to point
   to troubleshooting.md.

* trouble-shooting-guide-2500
 - Update expect.txt for text 'debian'. Changed from 'Debian' to
   catch all expected spelling.
2024-04-18 15:10:48 -07:00
Richard
16a718a510
trouble-shooting-guide-2500 (#2684)
* trouble-shooting-guide-2500
 - Add troubleshooting.md.
   This is currently a copy of the troubleshooting section of
   https://nasa.github.io/fprime/INSTALL.html

* trouble-shooting-guide-2500
 - Update INSTALL.md and remove troubleshooting guide and redirect
   to newly created separate file.
 - Remove empty line / space from troubleshooting.md.
2024-04-17 11:20:30 -07:00
M Starch
d57c95cd63
Revising integration test api. Fixes: #1902 (#2652)
* Revising integration test api. Fixes: #1902

* sp

* Adding reference to design doc
2024-04-16 15:17:47 -07:00
Thomas Boyer-Chammard
c4fc9a9727
Update JSON Dictionary spec (#2663)
* Add set/save commandKind

* Update dictionary spec

* Update reference dictionary

* ASCII-only annotation

* Update String Type Descriptor

* Add whitespaces to fix table rendering issues

* Reorder TOC to match

* Fix `default` to required: true

* Fix `size` description and range

* Add struct member descriptor annotation

* Fix Command annotation to not required
2024-04-15 09:22:55 -07:00
M Starch
fab3b9fe98
More GDS plugin guide improvements (#2670)
* More GDS plugin guide improvements

* sp
2024-04-10 13:03:13 -07:00
M Starch
c34ddb3e43
Initial documentation of fprime libraries (#2665)
* Initial documentation of fprime libraries

* Update Library How-To Guide

* Finished first-pass on library documentation

* sp

* Add link to how-to contents

* Review recommendations - part 1

* Review recommendations - part 2
2024-04-09 10:19:02 -07:00
M Starch
17bec566bc
Adding start apps and arguments (#2616)
* Adding start apps and arguments

* sp
2024-04-09 10:18:22 -07:00
M Starch
3166546c76
Fixing Documentation Generation fo macOS (#2655)
* Adding minor fixes to gen docs script for mac

* Adding in HowTo to docs generation

* sp
2024-04-02 17:39:31 -07:00
M Starch
1791e7c313
Correcting rate group documentation. Fixes #1719 (#2638) 2024-04-02 15:38:52 -07:00