cleaned up event handling code a bit

Reviewed-on: #271

CHANGELOG.md

@@ -10,6 +10,12 @@ list yields a list of all related PRs for each release.
 
 # [unreleased]
 
+# [v5.13.0] 2024-01-30
+
+## Added
+
+- Added new parameter commands for PLOC MPSoC to skip SUPV commanding.
+
 # [v5.12.1] 2023-12-13
 
 ## Added

eive_tmtc/config/events.csv

@@ -88,7 +88,7 @@ Event ID (dec); Event ID (hex); Name; Severity; Description; File Path
 10804;0x2a34;FILENAME_TOO_LARGE_ERROR;LOW;P1: Transaction step ID, P2: 0 for source file name, 1 for dest file name;fsfw/src/fsfw/cfdp/handler/defs.h
 10805;0x2a35;HANDLING_CFDP_REQUEST_FAILED;LOW;CFDP request handling failed. P2: Returncode.;fsfw/src/fsfw/cfdp/handler/defs.h
 11200;0x2bc0;SAFE_RATE_VIOLATION;MEDIUM;The limits for the rotation in safe mode were violated.;mission/acs/defs.h
-11201;0x2bc1;SAFE_RATE_RECOVERY;MEDIUM;The system has recovered from a safe rate rotation violation.;mission/acs/defs.h
+11201;0x2bc1;RATE_RECOVERY;MEDIUM;The system has recovered from a rate rotation violation.;mission/acs/defs.h
 11202;0x2bc2;MULTIPLE_RW_INVALID;HIGH;Multiple RWs are invalid, uncommandable and therefore higher ACS modes cannot be maintained.;mission/acs/defs.h
 11203;0x2bc3;MEKF_INVALID_INFO;INFO;MEKF was not able to compute a solution. P1: MEKF state on exit;mission/acs/defs.h
 11204;0x2bc4;MEKF_RECOVERY;INFO;MEKF is able to compute a solution again.;mission/acs/defs.h
@@ -97,6 +97,7 @@ Event ID (dec); Event ID (hex); Name; Severity; Description; File Path
 11207;0x2bc7;SAFE_MODE_CONTROLLER_FAILURE;HIGH;The ACS safe mode controller was not able to compute a solution and has failed. P1: Missing information about magnetic field, P2: Missing information about rotational rate;mission/acs/defs.h
 11208;0x2bc8;TLE_TOO_OLD;INFO;The TLE for the SGP4 Propagator has become too old.;mission/acs/defs.h
 11209;0x2bc9;TLE_FILE_READ_FAILED;LOW;The TLE could not be read from the filesystem.;mission/acs/defs.h
+11210;0x2bca;PTG_RATE_VIOLATION;MEDIUM;The limits for the rotation in pointing mode were violated.;mission/acs/defs.h
 11300;0x2c24;SWITCH_CMD_SENT;INFO;Indicates that a FSFW object requested setting a switch P1: 1 if on was requested, 0 for off | P2: Switch Index;mission/power/defs.h
 11301;0x2c25;SWITCH_HAS_CHANGED;INFO;Indicated that a switch state has changed P1: New switch state, 1 for on, 0 for off | P2: Switch Index;mission/power/defs.h
 11302;0x2c26;SWITCHING_Q7S_DENIED;MEDIUM;No description;mission/power/defs.h

eive_tmtc/config/returnvalues.csv

@@ -454,6 +454,12 @@ Full ID (hex); Name; Description; Unique ID; Subsytem Name; File Path
 0x5208;IMTQ_CmdErrUnknown;No description;8;IMTQ_HANDLER;mission/acs/imtqHelpers.h
 0x5209;IMTQ_StartupCfgError;No description;9;IMTQ_HANDLER;mission/acs/imtqHelpers.h
 0x520a;IMTQ_UnexpectedSelfTestReply;The status reply to a self test command was received but no self test command has been sent. This should normally never happen.;10;IMTQ_HANDLER;mission/acs/imtqHelpers.h
+0x53a0;RWHA_InvalidSpeed;Action Message with invalid speed was received. Valid speeds must be in the range of [-65000, 1000] or [1000, 65000];160;RW_HANDLER;mission/acs/RwHandler.h
+0x53a1;RWHA_InvalidRampTime;Action Message with invalid ramp time was received.;161;RW_HANDLER;mission/acs/RwHandler.h
+0x53a2;RWHA_SetSpeedCommandInvalidLength;Received set speed command has invalid length. Should be 6.;162;RW_HANDLER;mission/acs/RwHandler.h
+0x53a3;RWHA_ExecutionFailed;Command execution failed;163;RW_HANDLER;mission/acs/RwHandler.h
+0x53a4;RWHA_CrcError;Reaction wheel reply has invalid crc;164;RW_HANDLER;mission/acs/RwHandler.h
+0x53a5;RWHA_ValueNotRead;No description;165;RW_HANDLER;mission/acs/RwHandler.h
 0x53b0;RWHA_SpiWriteFailure;No description;176;RW_HANDLER;mission/acs/rwHelpers.h
 0x53b1;RWHA_SpiReadFailure;Used by the spi send function to tell a failing read call;177;RW_HANDLER;mission/acs/rwHelpers.h
 0x53b2;RWHA_MissingStartSign;Can be used by the HDLC decoding mechanism to inform about a missing start sign 0x7E;178;RW_HANDLER;mission/acs/rwHelpers.h
@@ -499,12 +505,8 @@ Full ID (hex); Name; Description; Unique ID; Subsytem Name; File Path
 0x58a1;PLSPVhLP_ProcessTerminated;Process has been terminated by command;161;PLOC_SUPV_HELPER;linux/payload/PlocSupvUartMan.h
 0x58a2;PLSPVhLP_PathNotExists;Received command with invalid pathname;162;PLOC_SUPV_HELPER;linux/payload/PlocSupvUartMan.h
 0x58a3;PLSPVhLP_EventBufferReplyInvalidApid;Expected event buffer TM but received space packet with other APID;163;PLOC_SUPV_HELPER;linux/payload/PlocSupvUartMan.h
-0x59a0;SUSS_InvalidSpeed;Action Message with invalid speed was received. Valid speeds must be in the range of [-65000, 1000] or [1000, 65000];160;SUS_HANDLER;mission/acs/RwHandler.h
-0x59a1;SUSS_InvalidRampTime;Action Message with invalid ramp time was received.;161;SUS_HANDLER;mission/acs/RwHandler.h
-0x59a2;SUSS_SetSpeedCommandInvalidLength;Received set speed command has invalid length. Should be 6.;162;SUS_HANDLER;mission/acs/RwHandler.h
-0x59a3;SUSS_ExecutionFailed;Command execution failed;163;SUS_HANDLER;mission/acs/RwHandler.h
-0x59a4;SUSS_CrcError;Reaction wheel reply has invalid crc;164;SUS_HANDLER;mission/acs/RwHandler.h
-0x59a5;SUSS_ValueNotRead;No description;165;SUS_HANDLER;mission/acs/RwHandler.h
+0x59a0;SUSS_ErrorUnlockMutex;No description;160;SUS_HANDLER;mission/acs/archive/LegacySusHandler.h
+0x59a1;SUSS_ErrorLockMutex;No description;161;SUS_HANDLER;mission/acs/archive/LegacySusHandler.h
 0x5aa0;IPCI_PapbBusy;No description;160;CCSDS_IP_CORE_BRIDGE;linux/ipcore/PapbVcInterface.h
 0x5ba0;PTME_UnknownVcId;No description;160;PTME;linux/ipcore/Ptme.h
 0x5d01;STRHLP_SdNotMounted;SD card specified in path string not mounted;1;STR_HELPER;linux/acs/StrComHandler.h
@@ -593,9 +595,11 @@ Full ID (hex); Name; Description; Unique ID; Subsytem Name; File Path
 0x69b5;SPVRTVIF_SupvHelperExecuting;Supervisor helper task ist currently executing a command (wait until helper tas has finished or interrupt by sending the terminate command);181;SUPV_RETURN_VALUES_IF;linux/payload/plocSupvDefs.h
 0x69c0;SPVRTVIF_BufTooSmall;No description;192;SUPV_RETURN_VALUES_IF;linux/payload/plocSupvDefs.h
 0x69c1;SPVRTVIF_NoReplyTimeout;No description;193;SUPV_RETURN_VALUES_IF;linux/payload/plocSupvDefs.h
-0x6a00;ACSCTRL_FileDeletionFailed;File deletion failed and at least one file is still existent.;0;ACS_CTRL;mission/controller/AcsController.h
-0x6a01;ACSCTRL_WriteFileFailed;Writing the TLE to the file has failed.;1;ACS_CTRL;mission/controller/AcsController.h
-0x6a02;ACSCTRL_ReadFileFailed;Reading the TLE to the file has failed.;2;ACS_CTRL;mission/controller/AcsController.h
+0x6aa0;ACSCTRL_FileDeletionFailed;File deletion failed and at least one file is still existent.;160;ACS_CTRL;mission/controller/controllerdefinitions/AcsCtrlDefinitions.h
+0x6aa1;ACSCTRL_WriteFileFailed;Writing the TLE to the file has failed.;161;ACS_CTRL;mission/controller/controllerdefinitions/AcsCtrlDefinitions.h
+0x6aa2;ACSCTRL_ReadFileFailed;Reading the TLE to the file has failed.;162;ACS_CTRL;mission/controller/controllerdefinitions/AcsCtrlDefinitions.h
+0x6aa3;ACSCTRL_SingleRwUnavailable;A single RW has failed.;163;ACS_CTRL;mission/controller/controllerdefinitions/AcsCtrlDefinitions.h
+0x6aa4;ACSCTRL_MultipleRwUnavailable;Multiple RWs have failed.;164;ACS_CTRL;mission/controller/controllerdefinitions/AcsCtrlDefinitions.h
 0x6b02;ACSMEKF_MekfUninitialized;No description;2;ACS_MEKF;mission/controller/acs/MultiplicativeKalmanFilter.h
 0x6b03;ACSMEKF_MekfNoGyrData;No description;3;ACS_MEKF;mission/controller/acs/MultiplicativeKalmanFilter.h
 0x6b04;ACSMEKF_MekfNoModelVectors;No description;4;ACS_MEKF;mission/controller/acs/MultiplicativeKalmanFilter.h

eive_tmtc/pus_tm/event_handler.py

@@ -1,26 +1,24 @@
-import logging
 import datetime
+import logging
 import sys
 
+from spacepackets.ccsds.time import CdsShortTimestamp
+from tmtccmd.fsfw import EventInfo
+from tmtccmd.pus.s5_fsfw_event import EventDefinition, Service5Tm
+from tmtccmd.pus.s200_fsfw_mode import Mode
+from tmtccmd.pus.s201_fsfw_health import FsfwHealth
+
 from eive_tmtc.config.events import get_event_dict
 from eive_tmtc.config.object_ids import get_object_ids
 from eive_tmtc.pus_tm.defs import PrintWrapper
 from eive_tmtc.pus_tm.verification_handler import generic_retval_printout
 from eive_tmtc.tmtc.acs.subsystem import AcsMode
-from eive_tmtc.tmtc.core import SdState, SdCardSelect
-from tmtccmd.pus.s200_fsfw_mode import Mode
-from tmtccmd.pus.s201_fsfw_health import FsfwHealth
-
-from tmtccmd.pus.s5_fsfw_event import Service5Tm
-from tmtccmd.fsfw import EventInfo
-from spacepackets.ccsds.time import CdsShortTimestamp
+from eive_tmtc.tmtc.core import SdCardSelect, SdState
 
 _LOGGER = logging.getLogger(__name__)
 
 
-def handle_event_packet(  # noqa C901: Complexity okay here
-    raw_tm: bytes, pw: PrintWrapper
-):  # noqa C901: Complexity okay here
+def handle_event_packet(raw_tm: bytes, pw: PrintWrapper):
     tm = Service5Tm.unpack(data=raw_tm, time_reader=CdsShortTimestamp.empty())
     event_dict = get_event_dict()
     event_def = tm.event_definition
@@ -36,16 +34,30 @@ def handle_event_packet(  # noqa C901: Complexity okay here
         obj_name = event_def.reporter_id.hex(sep=",")
     else:
         obj_name = obj_id_obj.name
+    assert tm.time_provider is not None
     generic_event_string = (
         f"Object {obj_name} generated Event {info.name} (ID: {event_def.event_id:#04x})"
         f" at {tm.time_provider.as_date_time()}"
     )
     _LOGGER.info(generic_event_string)
-    pw.file_logger.info(
-        f"{datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')}:"
-        f" {generic_event_string}"
-    )
-    specific_handler = False
+    if pw.file_logger is not None:
+        pw.file_logger.info(
+            f"{datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')}:"
+            f" {generic_event_string}"
+        )
+    specific_handler = handle_specific_events(pw, obj_name, info, event_def)
+    if not specific_handler:
+        additional_event_info = (
+            f"Additional info: {info.info} | P1: {event_def.param1} | "
+            f"P2: {event_def.param2}"
+        )
+        pw.dlog(additional_event_info)
+
+
+def handle_specific_events(
+    pw: PrintWrapper, obj_name: str, info: EventInfo, event_def: EventDefinition
+) -> bool:
+    specific_handler = True
     if info.name == "MODE_TRANSITION_FAILED":
         reason = generic_retval_printout(event_def.param1)
         for string in reason:
@@ -151,12 +163,4 @@ def handle_event_packet(  # noqa C901: Complexity okay here
         mode = event_def.param1
         submode = event_def.param2
         pw.dlog(f"Mode Number {mode}, Submode: {submode}")
-    if not specific_handler:
-        additional_event_info = (
-            f"Additional info: {info.info} | P1: {event_def.param1} | "
-            f"P2: {event_def.param2}"
-        )
-        pw.dlog(additional_event_info)
-    if not specific_handler:
-        # printer.handle_long_tm_print(packet_if=tm.pus_tm, info_if=tm.pus_tm)
-        pass
+    return specific_handler

eive_tmtc/tmtc/payload/ploc_mpsoc.py

@@ -24,6 +24,7 @@ from tmtccmd.tmtc import service_provider
 from tmtccmd.tmtc.decorator import ServiceProviderParams
 from eive_tmtc.utility.input_helper import InputHelper
 from tmtccmd.pus.s200_fsfw_mode import pack_mode_data, Mode
+from tmtccmd.pus.s20_fsfw_param import create_load_param_cmd, create_scalar_u8_parameter
 from tmtccmd.pus.s8_fsfw_action import create_action_cmd
 
 _LOGGER = logging.getLogger(__name__)
@@ -93,6 +94,10 @@ class ActionId(enum.IntEnum):
     TC_FLASH_READ_FULL_FILE = 30
 
 
+class ParamId(enum.IntEnum):
+    PLOC_SUPV_CMD_TO_ON = 1
+
+
 class OpCode:
     ON = "on"
     OFF = "off"
@@ -115,6 +120,8 @@ class OpCode:
     SIMPLEX_SEND_FILE = "simplex_send_file"
     DOWNLINK_DATA_MODULATE = "downlink_data_modulate"
     MODE_SNAPSHOT = "mode_snapshot"
+    ENABLE_PLOC_SUPV_COMMANDING_TO_ON = "enable_ploc_supv_cmd_to_on"
+    DISABLE_PLOC_SUPV_COMMANDING_TO_ON = "disable_ploc_supv_cmd_to_on"
 
 
 class Info:
@@ -137,6 +144,10 @@ class Info:
     FLASH_GET_DIR_CONTENT = "Get flash directory content on MPSoC"
     DOWNLINK_DATA_MODULATE = "Downlink data modulate"
     MODE_SNAPSHOT = "Mode Snapshot"
+    ENABLE_PLOC_SUPV_COMMANDING_TO_ON = "Enable PLOC SUPV commanding when switching ON"
+    DISABLE_PLOC_SUPV_COMMANDING_TO_ON = (
+        "Disable PLOC SUPV commanding when switching ON"
+    )
 
 
 class MemAddresses(enum.IntEnum):
@@ -171,6 +182,13 @@ def add_ploc_mpsoc_cmds(defs: TmtcDefinitionWrapper):
     oce.add(OpCode.SIMPLEX_SEND_FILE, Info.SIMPLEX_SEND_FILE)
     oce.add(OpCode.DOWNLINK_DATA_MODULATE, Info.DOWNLINK_DATA_MODULATE)
     oce.add(OpCode.MODE_SNAPSHOT, Info.MODE_SNAPSHOT)
+    oce.add(
+        OpCode.ENABLE_PLOC_SUPV_COMMANDING_TO_ON, Info.ENABLE_PLOC_SUPV_COMMANDING_TO_ON
+    )
+    oce.add(
+        OpCode.DISABLE_PLOC_SUPV_COMMANDING_TO_ON,
+        Info.DISABLE_PLOC_SUPV_COMMANDING_TO_ON,
+    )
     defs.add_service(CustomServiceList.PLOC_MPSOC.value, "Ploc MPSoC", oce)
 
 
@@ -179,6 +197,7 @@ def pack_ploc_mpsoc_commands(  # noqa C901
     p: ServiceProviderParams,
 ):  # noqa C901: Complexity okay here.
     object_id = get_object_ids().get(PLOC_MPSOC_ID)
+    assert object_id is not None
     q = p.queue_helper
     prefix = "PLOC MPSoC"
     op_code = p.op_code
@@ -313,6 +332,24 @@ def pack_ploc_mpsoc_commands(  # noqa C901
         q.add_log_cmd("PLOC MPSoC: Mode snapshot")
         data = object_id.as_bytes + struct.pack("!I", ActionId.TC_MODE_SNAPSHOT)
         q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=data))
+    if op_code == OpCode.ENABLE_PLOC_SUPV_COMMANDING_TO_ON:
+        q.add_log_cmd(Info.ENABLE_PLOC_SUPV_COMMANDING_TO_ON)
+        q.add_pus_tc(
+            create_load_param_cmd(
+                create_scalar_u8_parameter(
+                    object_id.as_bytes, 0, ParamId.PLOC_SUPV_CMD_TO_ON, 0
+                )
+            )
+        )
+    if op_code == OpCode.DISABLE_PLOC_SUPV_COMMANDING_TO_ON:
+        q.add_log_cmd(Info.DISABLE_PLOC_SUPV_COMMANDING_TO_ON)
+        q.add_pus_tc(
+            create_load_param_cmd(
+                create_scalar_u8_parameter(
+                    object_id.as_bytes, 0, ParamId.PLOC_SUPV_CMD_TO_ON, 1
+                )
+            )
+        )
 
 
 def generate_write_mem_command(

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "eive-tmtc"
 description = "TMTC Commander EIVE"
 readme = "README.md"
-version = "5.12.1"
+version = "5.13.0"
 requires-python = ">=3.10"
 license = {text = "Apache-2.0"}
 authors = [