Fix #2175, Apply consistent naming to common Event IDs

docs/cFS_IdentifierNamingConvention.md

@@ -114,6 +114,24 @@ Some general rules/recommendations to follow for cFS identifiers:
     __NOTE__: a sufficient number of terms must always be used in order to ensure uniqueness
     and avoid ambiguity.
 
+8.  Event IDs in cFE (and across the other cFS components/apps) should be capitalized and use  
+    a consistent abbreviated naming pattern in the following order:  
+    <APPLICATION\_NAME>\_<EVENT>\_<EVENT\_TYPE>\_<EID>  
+    <br>
+    For example:
+    | Event ID | Application | Command/Event Description | Event Type | Event ID Suffix |
+    | :---:   | :---: | :---: | :---: | :---: |
+    | CFE_EVS_NOOP_INF_EID | CFE Event Service | NOOP Command | Informational | Event ID |
+    | HS_CR_PIPE_ERR_EID | Health & Safety | Create Pipe Error | Error | Event ID |
+
+    Common events should be named consistently across applications for ease of recognition.  
+    <br>
+    Common command/event descriptions include:  
+    \_MID\_ERR\_EID: Invalid Message ID Received  
+    \_NOOP\_INF\_EID: No-op Command Success  
+    \_INIT\_INF\_EID: Applicaiton Initialization Success  
+    \_RESET\_INF\_EID: Reset Command Counters Command Success  
+
 
 ## Applicability to Actions / Commands
 

docs/src/cfe_es.dox

@@ -728,7 +728,7 @@
   message length embedded within the header (from `CFE_MSG_GetSize()`) matches the expected
   length of that message, based on the size of the C structure defining that command.
   If there is any discrepancy between the expected and actual message size, ES will generate
-  the #CFE_ES_LEN_ERR_EID event, increment the command error counter (\ES_CMDEC), and the
+  the #CFE_ES_CMD_LEN_ERR_EID event, increment the command error counter (\ES_CMDEC), and the
   command will _not_ be accepted for processing.
 
   The following is a list of commands that are processed by the cFE Executive Services Task.

docs/src/cfe_evs.dox

@@ -492,7 +492,7 @@
 **  message length embedded within the header (from `CFE_MSG_GetSize()`) matches the expected
 **  length of that message, based on the size of the C structure defining that command.
 **  If there is any discrepancy between the expected and actual message size, EVS will generate
-**  the #CFE_EVS_LEN_ERR_EID event, increment the command error counter (\EVS_CMDEC), and the
+**  the #CFE_EVS_CMD_LEN_ERR_EID event, increment the command error counter (\EVS_CMDEC), and the
 **  command will _not_ be accepted for processing.
 **
 **  The following is a list of commands that are processed by the cFE Event Services Task.

docs/src/cfe_sb.dox

@@ -530,7 +530,7 @@
 **  message length embedded within the header (from `CFE_MSG_GetSize()`) matches the expected
 **  length of that message, based on the size of the C structure defining that command.
 **  If there is any discrepancy between the expected and actual message size, SB will generate
-**  the #CFE_SB_LEN_ERR_EID event, increment the command error counter (\SB_CMDEC), and the
+**  the #CFE_SB_CMD_LEN_ERR_EID event, increment the command error counter (\SB_CMDEC), and the
 **  command will _not_ be accepted for processing.
 **
 **  The following is a list of commands that are processed by the cFE Software Bus Task.

docs/src/cfe_tbl.dox

@@ -377,7 +377,7 @@
 **  message length embedded within the header (from `CFE_MSG_GetSize()`) matches the expected
 **  length of that message, based on the size of the C structure defining that command.
 **  If there is any discrepancy between the expected and actual message size, TBL will generate
-**  the #CFE_TBL_LEN_ERR_EID event, increment the command error counter (\TBL_CMDEC), and the
+**  the #CFE_TBL_CMD_LEN_ERR_EID event, increment the command error counter (\TBL_CMDEC), and the
 **  command will _not_ be accepted for processing.
 **
 **  The following is a list of commands that are processed by the cFE Table Services Task.

docs/src/cfe_time.dox

@@ -706,7 +706,7 @@
 **  message length embedded within the header (from `CFE_MSG_GetSize()`) matches the expected
 **  length of that message, based on the size of the C structure defining that command.
 **  If there is any discrepancy between the expected and actual message size, TIME will generate
-**  the #CFE_TIME_LEN_ERR_EID event, increment the command error counter (\TIME_CMDEC), and the
+**  the #CFE_TIME_CMD_LEN_ERR_EID event, increment the command error counter (\TIME_CMDEC), and the
 **  command will _not_ be accepted for processing.
 **
 **  The following is a list of commands that are processed by the cFE Time Services Task.

modules/es/eds/cfe_es.xml

@@ -822,7 +822,7 @@
 
           Evidence of failure may be found in the following telemetry:
           - \b \c \ES_CMDEC - command error counter will increment
-          - the #CFE_ES_LEN_ERR_EID error event message will be generated
+          - the #CFE_ES_CMD_LEN_ERR_EID error event message will be generated
 
           \par  Criticality
           None
@@ -863,7 +863,7 @@
 
           Evidence of failure may be found in the following telemetry:
           - \b \c \ES_CMDEC - command error counter will increment
-          - the #CFE_ES_LEN_ERR_EID error event message will be generated
+          - the #CFE_ES_CMD_LEN_ERR_EID error event message will be generated
 
           \par  Criticality
 

modules/es/fsw/inc/cfe_es_events.h

@@ -269,7 +269,7 @@
  *
  *  Invalid command code for message ID #CFE_ES_CMD_MID received on the ES message pipe.
  */
-#define CFE_ES_CC1_ERR_EID 22
+#define CFE_ES_CC_ERR_EID 22
 
 /**
  * \brief ES Invalid Command Length Event ID
@@ -280,7 +280,7 @@
  *
  *  Invalid length for the command code in message ID #CFE_ES_CMD_MID received on the ES message pipe.
  */
-#define CFE_ES_LEN_ERR_EID 23
+#define CFE_ES_CMD_LEN_ERR_EID 23
 
 /**
  * \brief ES Restart Command Invalid Restart Type Event ID

modules/es/fsw/inc/cfe_es_msg.h

@@ -73,7 +73,7 @@
 **
 **       Evidence of failure may be found in the following telemetry:
 **       - \b \c \ES_CMDEC - command error counter will increment
-**       - the #CFE_ES_LEN_ERR_EID error event message will be generated
+**       - the #CFE_ES_CMD_LEN_ERR_EID error event message will be generated
 **
 **  \par Criticality
 **       None

modules/es/ut-coverage/es_UT.c

@@ -3217,7 +3217,7 @@ void TestTask(void)
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_CLEAR_ER_LOG_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test resetting and setting the max for the processor reset count */
     ES_ResetUnitTest();
@@ -3332,22 +3332,22 @@ void TestTask(void)
     /* Test the command pipe message process with an invalid command */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, sizeof(CmdBuf.NoopCmd), UT_TPID_CFE_ES_CMD_INVALID_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_CC1_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CC_ERR_EID);
 
     /* Test sending a no-op command with an invalid command length */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_NOOP_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a reset counters command with an invalid command length */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_RESET_COUNTERS_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a cFE restart command with an invalid command length */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_RESTART_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test cFE restart with a power on reset */
     ES_ResetUnitTest();
@@ -3361,7 +3361,7 @@ void TestTask(void)
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_START_APP_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test start application command with a processor restart on application
      * exception
@@ -3386,63 +3386,63 @@ void TestTask(void)
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_STOP_APP_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a restart application command with an invalid command
      * length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_RESTART_APP_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a reload application command with an invalid command
      * length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_RELOAD_APP_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a write request for a single application with an
      * invalid command length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_QUERY_ONE_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a write request for all applications with an
      * invalid command length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_QUERY_ALL_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a write request for all tasks with an
      * invalid command length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_QUERY_ALL_TASKS_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a request to clear the system log with an
      * invalid command length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_CLEAR_SYSLOG_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a request to overwrite the system log with an
      * invalid command length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_OVER_WRITE_SYSLOG_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a request to write the system log with an
      * invalid command length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_WRITE_SYSLOG_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test successful overwriting of the system log using overwrite mode */
     ES_ResetUnitTest();
@@ -3457,35 +3457,35 @@ void TestTask(void)
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_WRITE_ER_LOG_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a request to reset the processor reset count with an
      * invalid command length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_RESET_PR_COUNT_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a request to set the maximum processor reset count with
      * an invalid command length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_SET_MAX_PR_COUNT_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a request to delete the CDS with an invalid command
      * length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_DELETE_CDS_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test sending a telemetry pool statistics retrieval command with an
      * invalid command length
      */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_SEND_MEM_POOL_STATS_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test successful dump of CDS to file using a specified dump file name */
     ES_ResetUnitTest();
@@ -3502,7 +3502,7 @@ void TestTask(void)
     /* Dump CDS command with invalid length */
     ES_ResetUnitTest();
     UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_DUMP_CDS_REGISTRY_CC);
-    CFE_UtAssert_EVENTSENT(CFE_ES_LEN_ERR_EID);
+    CFE_UtAssert_EVENTSENT(CFE_ES_CMD_LEN_ERR_EID);
 
     /* Test error when sending Build Info event */
     ES_ResetUnitTest();

modules/evs/eds/cfe_evs.xml

@@ -344,7 +344,7 @@
           \par  Command Verification
           Successful execution of this command may be verified with the following telemetry:
           - \b \c \EVS_CMDPC - command execution counter will increment
-          - The #CFE_EVS_NOOP_EID informational event message will be generated
+          - The #CFE_EVS_NOOP_INF_EID informational event message will be generated
 
           \par  Error Conditions
           There are no error conditions for this command. If the Event
@@ -379,7 +379,7 @@
           the following telemetry:
           - \b \c \EVS_CMDPC - command execution counter will
           increment
-          - The #CFE_EVS_RSTCNT_EID debug event message will be
+          - The #CFE_EVS_RESET_INF_EID debug event message will be
           generated
 
           \par  Error Conditions

modules/evs/fsw/inc/cfe_evs_events.h

@@ -39,7 +39,7 @@
  *
  *  \link #CFE_EVS_NOOP_CC EVS NO-OP command \endlink success.
  */
-#define CFE_EVS_NOOP_EID 0
+#define CFE_EVS_NOOP_INF_EID 0
 
 /**
  * \brief EVS Initialization Event ID
@@ -50,7 +50,7 @@
  *
  *  Event Services Task initialization complete.
  */
-#define CFE_EVS_STARTUP_EID 1
+#define CFE_EVS_INIT_INF_EID 1
 
 /**
  * \brief EVS Write Event Log Command File Write Entry Failed Event ID
@@ -85,7 +85,7 @@
  *
  *  Invalid message ID received on the EVS message pipe.
  */
-#define CFE_EVS_ERR_MSGID_EID 5
+#define CFE_EVS_MID_ERR_EID 5
 
 /**
  * \brief EVS Command Event Not Registered For Filtering Event ID
@@ -188,7 +188,7 @@
  *
  *  Invalid command code for message ID #CFE_EVS_CMD_MID received on the EVS message pipe.
  */
-#define CFE_EVS_ERR_CC_EID 15
+#define CFE_EVS_CC_ERR_EID 15
 
 /**
  * \brief EVS Reset Counters Command Success Event ID
@@ -199,7 +199,7 @@
  *
  *  \link #CFE_EVS_RESET_COUNTERS_CC EVS Reset Counters Command \endlink success.
  */
-#define CFE_EVS_RSTCNT_EID 16
+#define CFE_EVS_RESET_INF_EID 16
 
 /**
  * \brief EVS Set Filter Command Success Event ID
@@ -465,7 +465,7 @@
  *
  *  Invalid length for the command code in message ID #CFE_EVS_CMD_MID received on the EVS message pipe.
  */
-#define CFE_EVS_LEN_ERR_EID 43
+#define CFE_EVS_CMD_LEN_ERR_EID 43
 
 /**
  * \brief EVS Events Squelched Error Event ID

modules/evs/fsw/inc/cfe_evs_msg.h

@@ -60,7 +60,7 @@
 **       following telemetry:
 **       - \b \c \EVS_CMDPC - command execution counter will
 **         increment
-**       - The #CFE_EVS_NOOP_EID informational event message will
+**       - The #CFE_EVS_NOOP_INF_EID informational event message will
 **         be generated
 **
 **  \par Error Conditions
@@ -96,7 +96,7 @@
 **         will be reset to 0
 **       - \b \c \EVS_CMDEC - command error counter
 **         will be reset to 0
-**       - The #CFE_EVS_RSTCNT_EID debug event message will be
+**       - The #CFE_EVS_RESET_INF_EID debug event message will be
 **         generated
 **
 **  \par Error Conditions

modules/evs/fsw/src/cfe_evs_task.c

@@ -302,7 +302,7 @@ int32 CFE_EVS_TaskInit(void)
 
     /* Write the AppID to the global location, now that the rest of initialization is done */
     CFE_EVS_Global.EVS_AppID = AppID;
-    EVS_SendEvent(CFE_EVS_STARTUP_EID, CFE_EVS_EventType_INFORMATION, "cFE EVS Initialized: %s", CFE_VERSION_STRING);
+    EVS_SendEvent(CFE_EVS_INIT_INF_EID, CFE_EVS_EventType_INFORMATION, "cFE EVS Initialized: %s", CFE_VERSION_STRING);
 
     return CFE_SUCCESS;
 }
@@ -315,7 +315,7 @@ int32 CFE_EVS_TaskInit(void)
  *-----------------------------------------------------------------*/
 int32 CFE_EVS_NoopCmd(const CFE_EVS_NoopCmd_t *data)
 {
-    EVS_SendEvent(CFE_EVS_NOOP_EID, CFE_EVS_EventType_INFORMATION, "No-op Cmd Rcvd: %s", CFE_VERSION_STRING);
+    EVS_SendEvent(CFE_EVS_NOOP_INF_EID, CFE_EVS_EventType_INFORMATION, "No-op Cmd Rcvd: %s", CFE_VERSION_STRING);
     return CFE_SUCCESS;
 }
 
@@ -399,7 +399,7 @@ int32 CFE_EVS_ResetCountersCmd(const CFE_EVS_ResetCountersCmd_t *data)
     CFE_EVS_Global.EVS_TlmPkt.Payload.MessageTruncCounter    = 0;
     CFE_EVS_Global.EVS_TlmPkt.Payload.UnregisteredAppCounter = 0;
 
-    EVS_SendEvent(CFE_EVS_RSTCNT_EID, CFE_EVS_EventType_DEBUG, "Reset Counters Command Received");
+    EVS_SendEvent(CFE_EVS_RESET_INF_EID, CFE_EVS_EventType_DEBUG, "Reset Counters Command Received");
 
     /* NOTE: Historically the reset counters command does _NOT_ increment the command counter */