Add fault documentation #64
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
It looks like it is generated from the csv file... can we not just save the csv file in the repo? Having code generated from Excel spreadsheets terrifies me |
|
|
||
| # Fault Config Files Generation | ||
|
|
||
| There is a script that will generate the fault config files by parsing the FMECA spreadsheet. This script assumes the steps in the previous section were completed and the FMECA spreadsheet was saved as a csv file in the doc folder. If it was not saved in the doc folder, please set the FMECA_CSV_PATH environment variable to folder were it was saved. Then run the following line: |
There was a problem hiding this comment.
If I save as csv, it only saves the first page, is that ok? (skips the not monitored faults)
|
We have decided that the FMECA should be converted to a json file much like our command schema. The tools that process the FMECA spreadsheet will also need to be converted. |
|
Katie would still like to do this, and may have time early in 2024. If not we should close this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Moved the FMECA spreadsheet from freeflyer_docs to the doc folder. Also added documentation on how to add faults and modified the generate faults config script to account for the FMECA being moved.