Skip to content

Pattern Documentation: How-To: Load Parameters in Batch#5237

Merged
thomas-bc merged 20 commits into
nasa:develfrom
Specky26846:patch-2
Jun 10, 2026
Merged

Pattern Documentation: How-To: Load Parameters in Batch#5237
thomas-bc merged 20 commits into
nasa:develfrom
Specky26846:patch-2

Conversation

@Specky26846

@Specky26846 Specky26846 commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

This document provides a comprehensive guide on how to import parameters into the GDS using the fprime-prm-write tool, detailing methods for generating .dat and .seq files, along with troubleshooting tips.

Related Issue(s) #5238
Has Unit Tests (y/n) n
Documentation Included (y/n) y
Generative AI was used in this contribution (y/n) y

Change Description

This is a ROSES pattern documentation on how to import parameters into the GDS. This primarily uses the fprime-prm-write tool, and also mentions the fprime-prm-decode tool in the context of checking that the parameter change was successful.

Rationale

Users may want to import parameters into the GDS using fprime-prm-write for any of the following reason:

  • Set initial parameter values for system startup
  • Update multiple parameters at once without manual commanding
  • Version-control parameter configurations alongside your code
  • Share parameter sets between team members or mission phases

Testing/Review Recommendations

This will need to be reviewed either by the community or by students for the ROSES program.

Future Work

Will need to place this document in the correct How-To subfolder once #5266 is merged. This will also need to go through a usual ROSES community or student review.

AI Usage (see policy)

AI used to help with formatting, rephrasing, and suggestions for comprehension.

Specky26846 and others added 2 commits June 4, 2026 09:48
This document provides a comprehensive guide on how to import parameters into the GDS using the fprime-prm-write tool, detailing methods for generating .dat and .seq files, along with troubleshooting tips.
@Specky26846 Specky26846 marked this pull request as ready for review June 4, 2026 17:41
@Specky26846 Specky26846 changed the title Add guide for importing parameters to GDS Pattern Documentation: How-To: Input Parameters to the GDS Jun 4, 2026
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-howto.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-howto.md Outdated
Comment thread docs/how-to/prm-write-howto.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
@Specky26846 Specky26846 marked this pull request as draft June 4, 2026 21:04
Updated title and clarified command line instructions. Adjusted section on verifying parameter changes.
@Specky26846 Specky26846 changed the title Pattern Documentation: How-To: Input Parameters to the GDS Pattern Documentation: How-To: Load Parameters in Batch Jun 4, 2026
@Specky26846 Specky26846 marked this pull request as ready for review June 5, 2026 22:28
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Comment thread docs/how-to/prm-write-how-to.md Outdated
Specky26846 and others added 7 commits June 9, 2026 09:42
Co-authored-by: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com>
Co-authored-by: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com>
@Specky26846 Specky26846 requested a review from thomas-bc June 9, 2026 21:22
@thomas-bc thomas-bc merged commit 255802d into nasa:devel Jun 10, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants