262 Commits

Author SHA1 Message Date
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
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
Thomas Boyer-Chammard
5c1dd45d1c
Fix crosscompiler path in tutorial (#2599) 2024-03-19 11:05:48 -07:00
Josh Soref
9633049549
Upgrade to check-spelling v0.0.22 (#2316)
* drop: @params None

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

* spelling: anymore

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

* spelling: baremetal

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: cookiecutter

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

* spelling: macos

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

* spelling: neither

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: param

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

* spelling: unix

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

* grammar: like

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

* Update check-spelling to v0.0.22

- enables sarif reporting
- enables checking dependabot PRs to validate extra_dictionaries in the
    future
- refreshes dictionaries
- refreshes metadata

* Shim for check-spelling v0.0.21

* Comment out false positive

---------

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Co-authored-by: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com>
2023-10-26 13:32:48 -07:00
M Starch
b748964d38
Add deployment to arm-linux paths. Fixes #2248. (#2315) 2023-10-24 14:12:58 -07:00
Thomas Boyer Chammard
206f74bb08
Update Docker command (#2267) 2023-09-05 18:17:13 -07:00
M Starch
99420c9de8 Update Windows.md to remove firewall stuff 2023-08-17 17:34:57 -07:00
M Starch
5639586369 Update ArmLinuxTutorial.md to rework for TcpServer 2023-08-17 17:14:12 -07:00
M Starch
a8058dd15f
A note on sudo for virtual environments (#2180)
* A note on sudo for virtual environments

* Highlighting mac note

* Update HelloWorld link

* Bootstrapping hints.

---------

Co-authored-by: thomas-bc <thomas.boyerchammard@gmail.com>
2023-08-03 11:30:15 -07:00
Thomas Boyer Chammard
287bedc466
Add Arduino tutorial to index (#2177) 2023-08-02 15:26:37 -07:00
Thomas Boyer Chammard
92c9f07123
Reference cross-compilation in tutorial index (#2155) 2023-07-25 10:56:20 -07:00
Thomas Boyer Chammard
3cd2083634
Migrate MathComponent tutorial to fprime-community (#2119)
* Migrate MathComponent tutorial to fprime-community

* update spelling
2023-07-18 09:52:40 -07:00
Michael Boehm
eabd5a585d
Cross-Compiler Documentation Update + Minor CodeQL Alert Resolutions (#2098)
* Updates to resolve "Complex multi-line /.../-style comment found. Lint may give bogus warnings. Consider replacing these with //-style comments, with #if 0...#endif, or with more clearly structured multi-line comments." alert.

Fixed all
	- Except external libraries

* Resolve "Storage-class specifier (static, extern, typedef, etc) should be at the beginning of the declaration." alert.

All resolved.

* Updated F Prime Cross Compilation Documentation

Correct for most recent version of devel.

* Spelling Fixes

* Remove URL Pattern

* Added `rancherdesktop` to expect.txt

* cross-compile tutorial re-organization

* add macos.md and add step for running executable

* clean up command to run executable

* change [...] to <...>

---------

Co-authored-by: Justine West <justine.a.west@jpl.nasa.gov>
2023-07-17 14:01:10 -07:00
hAkselS
b3493ca03b
Migrate HelloWorld tutorial to F' community (#2095) 2023-06-28 14:17:22 -07:00
Noah
a0337f338b
Fixes main.cpp references in MathComponent tutorial (#2042)
* Adds telemetry packet definition step.

* Fixes typo in sample code

* Fixes some main.cpp references

* Changes incorrect `main.cpp` to `TestMain.cpp`
2023-05-24 10:36:47 -07:00
M Starch
ccb974a210
Rework tutorial index (#2035)
* Rework tutorial index

* Review suggestions
2023-05-18 14:19:13 -07:00
M Starch
68a5925d1e
Merge pull request #2032 from nasa/master
History sync (#2024)
2023-05-18 10:34:17 -07:00
Noah Braasch
4f65e1ef3f
Adds telemetry packet definition step. (#2024) 2023-05-17 12:14:40 -07:00
M Starch
0701b6af66
Add sourcing the virtual environment to the right spot (#1993)
* Add sourcing the virtual environment to the right spot

* Update HelloWorld.md for minor fixes

* Fixing regressions

* Update Deployments.md with minor fixes

* Update HelloWorld.md to add In: to the instructions

* sp
2023-04-28 13:59:35 -07:00
Roman Sobkuliak
bcaa558c7a
Fix post annotations in HelloWorld docs (#1985) 2023-04-25 19:09:06 -07:00
Thomas Boyer Chammard
6ac7b73ada
Update README and bump fprime-tools (#1971)
* Fix tutorial link

* Update README !

* Fixes

* Add user guide to getting started

* Resources

* Review update

* Peer review

* Bump tooling versions

* spelling
2023-04-19 14:57:54 -07:00
M Starch
124b6e8170
Tutorial/getting started (#1968)
* Revising the getting started tutorial to cover getting started

* Adding a generate step

* Additional generate note

* Clarifying the directory for running commands

* Adding actual output to New Project

* Updating HelloWorld.md with tool output

* Toushing up Deployments.md

* sp

* Fixing spacing

* Removing prereqs

* Update Tutorial.md to move next link
2023-04-18 17:37:41 -07:00
Ivan Perez, PhD
e9c2144a77
Remove references to install command from the tutorial (#1877) (#1928)
The tutorial refers to the "install" command in the 'Build Ref
Deployment' section.  However, that command was removed in 20b5f29, a
commit released as early as v2.0.0~193^2.

This commit removes references to the install command from the tutorial.

The mention that the build command also copies the binaries to the bin
dir is moved earlier in the text, simply because it flows better when
the rest of the note about the install command is removed.
2023-03-16 15:16:26 -07:00
U S A M A H
9c19109e0d
Change typo 'how' to 'now' (#1930) 2023-03-16 13:24:20 -07:00
Ani
54d89871e2
Documentation revision (./docs/*.md files) (#1570)
* Corrections and edits for *.md files in the root of /docs

* Edits on docs/UsersGuide/best/*.md

* Edits on docs/UsersGuide/cmake/*.md

* Edits on *.md files at the root of docs/UsersGuide/dev/

* Edits on docs/UsersGuide/{dev,gds,user}/*.md

* Edits on docs/Tutorials/*.md and a few others after a final read

* Revert changes

Co-authored-by: M Starch <LeStarch@googlemail.com>
2023-01-12 15:24:57 -08:00
M Starch
e596a2bcff
auto-generate connect ports option. Fixes #934 (#1786)
* auto-generate connect ports option. Fixes #934

* updating math tutorial

* making unit tests settings from #defines to constants

* fixing missing properties in signal gen
2022-12-21 09:39:04 -08:00
Rob Bocchino
64d08b7f00
Fixes to math component tutorial Markdown (#1802)
* Revise math tutorial

Migrate manual changes in generated code back into source

* Revise Math tutorial md

* Revise Math tutorial md

* Revise Math tutorial md

* Revise Math tutorial MD

* Revise Math component md

* Revise math component tutorial md

* Revise math component tutorial md

* Revise math component tutorial md

* Regenerate math component tutorial md

* Revise math component tutorial md

* Revise math component tutorial md
2022-12-19 10:58:47 -08:00
Rob Bocchino
32086326ca
Revise math tutorial (#1729)
Remove outdated reference to v3.0.0
2022-10-20 10:26:51 -07:00
M Starch
b76d8c9a0c
Update/types refactor as constants (#1623)
* lestarch: adding logical types implementation into Linux/StandardTypes.hpp

* lestarch: removing VxWorks StandardTypes from repository

* updated fprime types for correct compilation with vxworks and baremetal

* lestarch: refactoring types and configuration header w.r.t type design

* lestarch: replacing usages of AssertArg with FwAssertArgType

* lestarch: missspelled configuration

* lestarch: minor compilation fixes

* lestarch: renaming StandardTypes.hpp -> PlatformTypes.hpp

* lestarch: updating PRI tokens

* lestarch: replacing BasicTypes.hpp includes with FpConfig.hpp

* lestarch: UT and compilation fixes for types refactor

* lestarch: sp

* lestarch: fixing RPI issues in PassiveConsoleTextLogger

* lestarch: converting RPI build to debug

* lestarch: removing duplicate config imports

* lestarch: fixing documentation

* lestarch: fixing up multiple definitions and RPI compilation problems

* lestarch: reverting debug build

* lestarch: reverting platform types to class-based constants

* lestarch: reworking basic types

* lestarch: configured types refactor into classes

* lestarch: fixing bugs with static constants in classes

* lestarch: fixing platform types spelling and documentation

* lestarch: adding include guards to types headers

Co-authored-by: Kevin F Ortega <kevin.f.ortega@jpl.nasa.gov>
2022-08-18 13:25:56 -07:00
Josh Soref
1f7b07da36
Update check-spelling to v0.0.20 (#1583)
* spelling: and

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

* spelling: command

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

* spelling: cycle

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

* spelling: dependent

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

* spelling: github

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: pass

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

* spelling: preexisting

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

* spelling: that

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

* spelling: the

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

* Update check-spelling
2022-07-26 14:35:01 -07:00
Timothy Canham
ba4d16d16f
Latest ActiveRateGroup updates (#1510)
* Merged files from old branch

* Corrected instances

* Math tutorial version
2022-06-22 09:43:22 -07:00
Timothy Canham
ddcb2ec138
Update RateGroupDriver to new constructor and configure() function (#1467)
* Updated RateGroupDriver. Moved constructor arguments to new configure() call

* Updated topology to new RateGroupDriver constructor and configure() function

* Updated docs, added assert to make sure it is configured

* Fixed RPI and MathComponent tutorial code

* Fixed configure description

* Moved rgDivs back to configObjects

* Fixed typo in rateGroupDriver instance

* Updated RPI and MathComponent RDG FPP
2022-05-27 12:43:46 -07:00
M Starch
cc795f7c00
lestarch: defining CMD_SEQ in tutorial (#1387)
* lestarch: defining CMD_SEQ in tutorial

* lestarch: sp

* lestarch: recommended non-zero CMD_SEQ
2022-04-13 17:46:00 -07:00
Sean Marquez
1576674ca2
add missing quotes on include statement in 4.5.4 (#1308) 2022-03-15 14:03:51 -07:00
Esteban Duran
50c408769f
astroesteban: Add Cross Compilation Section To Math Tutorial (#1274)
* Add Cross Compilation Section To Math Tutorial

* Fix orer Typo

* astroesteban: Create Separate Cross-Compilation Section
2022-02-17 17:50:07 -08:00
Esteban Duran
8314f71086
Fix Section 4.5.1 of Math Component Tutorial (#1243)
* fix: fprime-util impl --ut command not working

#1238

* fix list formatting

#1238

* lestarch: sp

* Remove Placeholder Instructions

Co-authored-by: M Starch <LeStarch@googlemail.com>
2022-02-11 13:01:10 -08:00
Esteban Duran
595cf3682d
astroesteban: fix math component misleading instructions (#1273)
* astroesteban: fix math component tutorial typos

* Minor Notation Fixes
#1255
2022-02-09 14:57:59 -08:00
M Starch
3af4d25ffe
Merge pull request #1142 from LeStarch/update/final-v2-pull
Update/final v2 pull
2021-12-10 13:33:43 -05:00
bocchino
5314d84186 Fix spelling 2021-12-07 18:21:14 -08:00
bocchino
78a45081dc Fix comment in script 2021-12-07 18:10:26 -08:00
M Starch
656514451d lestarch: merging devel into v3.0.0 2021-12-07 17:20:45 -08:00
bocchino
13ab37c70b Revise formatting in math tutorial 2021-12-07 11:37:42 -08:00
bocchino
c9f857f23b Revise math tutorial
Add title header
Increment other section header indents by one
2021-12-07 11:36:50 -08:00
bocchino
184e3d88a6 Revise opcode for MathReceiver 2021-12-07 11:27:23 -08:00
bocchino
945659dafb Revise math tutorial
Remove adoc source files
2021-12-07 11:16:52 -08:00
bocchino
b9b7f2aa9a Revise math tutorial
Finish converting to md
Remove adoc version
2021-12-07 11:16:04 -08:00
bocchino
436e192ff1 Fix formatting in math tutorial 2021-12-07 11:13:00 -08:00
bocchino
8e0e5f96fc Revise math tutorial
Fix formatting
2021-12-07 11:11:16 -08:00
bocchino
60e0d333f0 Revise math tutorial
Revise checking scripts
2021-12-07 11:08:39 -08:00
bocchino
f888c72fe1 Revise math tutorial 2021-12-07 11:04:55 -08:00