Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating the "Data Constructs: Commands, Events, Channels, and Parame…
…ters" Page in the F' User's Guide (#2147) * Update cmd-evt-chn-prm.md Changed "pipes" to "ports" early in the Commands section, because I've never heard pipes used as a term in F Prime and ports make sense in the context of component-to-component communication. * Update cmd-evt-chn-prm.md Changed the last line two lines of "Command Dispatching" to more clearly reflect the operational flow described in the next section, "Command Sequencing" * Update cmd-evt-chn-prm.md Changed the 3rd sentence under "Events" to say that components defining events, rather than commands, should hook up to the Svc::ActiveLogger. This should maybe actually say "defining events AND commands"--I forget if the system always sends out an event for a completed command--but the log ports are definitely required for events * Update cmd-evt-chn-prm.md Changed the sixth sentence under the events header to be more parsable; this may also mean the sentence now communicates incorrect information, but it should definitely should looked at because it doesn't quite make sense right now * Update cmd-evt-chn-prm.md Changed the last lines under the "Event" to more accurately reflect where the different log output ports store their event logs, assuming that these binary and text log ports line up with the "Fw.Log" and "Fw.TextLog" ports respectively as described in the FPP User's Guide in section 9.3.2 * Update cmd-evt-chn-prm.md Updated the second property under the header "Telemetry" to say that the name is prepended with the name of the component instance, and not just the component. This is both consistent with the other data constructs on this page, with how telemetry is usually packetized--"channel name="[componentInstance].[TELEMETRY_CHANNEL]""--and how telemetry coming from two different instances of the same component should intuitively be distinguishable. * Update cmd-evt-chn-prm.md Changed the second sentence under the "Telemetry Database" header for grammatical and semantic clarity. * Update cmd-evt-chn-prm.md Changed the last sentence in the figure 8 description to reflect how the parameter manager changes parameter values through the auto-generated set and save commands; my details might be a little fuzzy, so feel free to correct the specifics, but I think this section deserves a little more fleshing out. I'm also unsure of if the line before this should be expanded upon? Simply saying "Components can set and retrieve parameters" might appear rather opaque to folks who are newer to F' (like myself), even with the context of the Svc::PrmDb which one can look into further in the official F Prime repository. * Fixing minor regression --------- Co-authored-by: M Starch <LeStarch@googlemail.com>
- Loading branch information