Skip to content

Commit

Permalink
Fix nasa#42, update doxygen references
Browse files Browse the repository at this point in the history
  • Loading branch information
jphickey committed Mar 23, 2023
1 parent 2f4167d commit 745d539
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions docs/dox_src/cfs_hk.dox
Original file line number Diff line number Diff line change
Expand Up @@ -199,11 +199,11 @@

<H2>5. Monitoring the command counter</H2>

The #HK_HkPacket_t.CmdCounter will increment only
The #HK_HkTlm_Payload_t.CmdCounter will increment only
when the HK application receives a valid #HK_NOOP_CC.

<H2>6. Monitoring the command error counter</H2>
The #HK_HkPacket_t.ErrCounter will increment under the following conditions:
The #HK_HkTlm_Payload_t.ErrCounter will increment under the following conditions:
a. Invalid command code
b. Unexpected packet length field for #HK_SEND_COMBINED_PKT_MID command
c. Unexpected packet length field for #HK_SEND_HK_MID command
Expand All @@ -213,20 +213,20 @@
<H2>7. Monitoring the 'Combined Packets Sent" counter</H2>

Each time a #HK_SEND_COMBINED_PKT_MID \copybrief HK_SEND_COMBINED_PKT_MID is
received without error #HK_HkPacket_t.CombinedPacketsSent will increment.
received without error #HK_HkTlm_Payload_t.CombinedPacketsSent will increment.

<H2>8. Monitoring the 'Missing Data" counter</H2>

Each time a #HK_SEND_COMBINED_PKT_MID \copybrief HK_SEND_COMBINED_PKT_MID is
received without error, the HK app begins checking the 'Data Present' flag (located
in the run-time table) for each of the data sections that make up the output packet.
If a data portion is missing, HK sends a debug event (which is filtered by default)
and increments #HK_HkPacket_t.MissingDataCtr.
and increments #HK_HkTlm_Payload_t.MissingDataCtr.
The event will display the Message ID of the input message that would normally
provide the missing portion.

<B>NOTE:</B> HK will report only one missing data portion in any output message.
The #HK_HkPacket_t.MissingDataCtr will advance
The #HK_HkTlm_Payload_t.MissingDataCtr will advance
by one count (at most) and send one event (at most) for each
#HK_SEND_COMBINED_PKT_MID.

Expand All @@ -238,7 +238,7 @@
The HK memory pool is used to allocate the memory needed to store the output
packets. Each time a new copy table is processed, the memory for the output
packets is dynamically allocated from the memory pool. The memory pool handle is
sent down in #HK_HkPacket_t.
sent down in #HK_HkTlm_Payload_t.
It is possible to get statistics from the cFE ES application on the memory pool
used by this application. #CFE_ES_SEND_MEM_POOL_STATS_CC is
used to get statistics will need this memory pool handle as a command parameter.
Expand Down
4 changes: 2 additions & 2 deletions fsw/inc/hk_msgdefs.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
* \par Command Verification
* Successful execution of this command may be verified with the
* following telemetry:
* - #HK_HkPacket_t.CmdCounter will increment
* - #HK_HkTlm_Payload_t.CmdCounter will increment
* - The #HK_NOOP_CMD_EID informational event message will be generated
*
* \par Error Conditions
Expand All @@ -70,7 +70,7 @@
* \par Command Verification
* Successful execution of this command may be verified with the
* following telemetry:
* - #HK_HkPacket_t.CmdCounter will be reset
* - #HK_HkTlm_Payload_t.CmdCounter will be reset
* - The #HK_RESET_CNTRS_CMD_EID informational event message will
* be generated
*
Expand Down

0 comments on commit 745d539

Please sign in to comment.