Merge pull request 'Add Xiphos WDT commands' (#241) from add-xiphos-wdt-handling into main

Reviewed-on: #241

CHANGELOG.md

@@ -10,6 +10,18 @@ list yields a list of all related PRs for each release.
 
 # [unreleased]
 
+# [v5.8.0] 2023-10-11
+
+## Added
+
+- Xiphos WDT enable and disable command.
+
+# [v5.7.1] 2023-10-11
+
+## Added
+
+- SCEX normal command
+
 # [v5.7.0] 2023-10-10
 
 - `tmtccmd` v6.0.0

eive_tmtc/config/definitions.py

@@ -78,3 +78,4 @@ class CustomServiceList(str, enum.Enum):
     SYSTEM = "system"
     PWR_CTRL = "pwr_ctrl"
     EPS_SS = "eps_subsystem"
+    XIPHOS_WDT = "xiphos_wdt"

eive_tmtc/config/object_ids.py

@@ -159,6 +159,7 @@ TCS_CONTROLLER = bytes([0x43, 0x40, 0x00, 0x01])
 ACS_CONTROLLER = bytes([0x43, 0x00, 0x00, 0x02])
 CORE_CONTROLLER_ID = bytes([0x43, 0x00, 0x00, 0x03])
 PWR_CONTROLLER = bytes([0x43, 0x00, 0x00, 0x04])
+XIPHOS_WDT_ID = bytes([0x43, 0x00, 0x00, 0x07])
 
 MISC_TM_STORE = bytes([0x73, 0x02, 0x00, 0x01])
 OK_TM_STORE = bytes([0x73, 0x02, 0x00, 0x02])

eive_tmtc/config/objects.csv

@@ -3,6 +3,7 @@
 0x43000003;CORE_CONTROLLER
 0x43000004;POWER_CONTROLLER
 0x43000006;GLOBAL_JSON_CFG
+0x43000007;XIPHOS_WDT
 0x43400001;THERMAL_CONTROLLER
 0x44120006;MGM_0_LIS3_HANDLER
 0x44120010;GYRO_0_ADIS_HANDLER

eive_tmtc/pus_tc/procedure_packer.py

@@ -35,6 +35,7 @@ from eive_tmtc.tmtc.core import pack_core_commands
 from eive_tmtc.tmtc.acs.star_tracker import pack_star_tracker_commands
 from eive_tmtc.tmtc.com.syrlinks_handler import pack_syrlinks_command
 from eive_tmtc.tmtc.com.pdec_handler import pack_pdec_handler_test
+from eive_tmtc.tmtc.wdt import pack_wdt_commands
 from eive_tmtc.tmtc.acs.acs_board import pack_acs_command
 from eive_tmtc.config.definitions import CustomServiceList
 from eive_tmtc.config.object_ids import (
@@ -205,6 +206,8 @@ def handle_default_procedure(  # noqa C901: Complexity okay here.
                 queue_helper=queue_helper,
             )
         )
+    if service == CustomServiceList.XIPHOS_WDT.value:
+        return pack_wdt_commands(queue_helper, op_code)
     if not route_to_registered_service_handlers(
         service,
         ServiceProviderParams(

eive_tmtc/tmtc/__init__.py

@@ -6,3 +6,4 @@ from .health import add_health_cmd_defs
 from .system import add_system_cmd_defs
 from .tm_store import add_persistent_tm_store_cmd_defs
 from .tcs import add_tmp_sens_cmds
+from .wdt import add_xiphos_wdt_defs

eive_tmtc/tmtc/payload/scex.py

@@ -26,8 +26,11 @@ class OpCode:
     ALL_CELLS_CMD = "allcells"
     FRAM = "fram"
 
+    ON = "on"
     SWITCH_ON = "on"
-    SWITCH_OFF = "off"
+    OFF = "off"
+    SWITCH_OFF = OFF
+    NORMAL = "normal"
 
 
 class ActionId(enum.IntEnum):
@@ -53,6 +56,7 @@ class Info:
 
     SWITCH_ON = "Switch Scex on"
     SWITCH_OFF = "Switch Scex off"
+    NORMAL = "Switch SCEX to normal mode"
 
 
 @tmtc_definitions_provider
@@ -66,8 +70,9 @@ def add_scex_cmds(defs: TmtcDefinitionWrapper):
 
     oce.add(keys=OpCode.ALL_CELLS_CMD, info=Info.ALL_CELLS_CMD)
     oce.add(keys=OpCode.FRAM, info=Info.FRAM)
-    oce.add(keys=OpCode.SWITCH_ON, info=Info.SWITCH_ON)
-    oce.add(keys=OpCode.SWITCH_OFF, info=Info.SWITCH_OFF)
+    oce.add(keys=OpCode.ON, info=Info.SWITCH_ON)
+    oce.add(keys=OpCode.OFF, info=Info.SWITCH_OFF)
+    oce.add(keys=OpCode.NORMAL, info=Info.NORMAL)
 
     defs.add_service(
         name=CustomServiceList.SCEX.value, info="SCEX Device", op_code_entry=oce
@@ -78,7 +83,7 @@ def add_scex_cmds(defs: TmtcDefinitionWrapper):
 def pack_scex_cmds(p: ServiceProviderParams):  # noqa C901
     op_code = p.op_code
     q = p.queue_helper
-    if op_code == OpCode.SWITCH_ON:
+    if op_code == OpCode.ON:
         q.add_log_cmd(Info.SWITCH_ON)
         q.add_pus_tc(
             PusTelecommand(
@@ -87,7 +92,16 @@ def pack_scex_cmds(p: ServiceProviderParams):  # noqa C901
                 app_data=pack_mode_data(SCEX_HANDLER_ID, Mode.ON, 0),
             )
         )
-    if op_code == OpCode.SWITCH_OFF:
+    if op_code == OpCode.NORMAL:
+        q.add_log_cmd(Info.NORMAL)
+        q.add_pus_tc(
+            PusTelecommand(
+                service=200,
+                subservice=Subservice.TC_MODE_COMMAND,
+                app_data=pack_mode_data(SCEX_HANDLER_ID, Mode.NORMAL, 0),
+            )
+        )
+    if op_code == OpCode.OFF:
         q.add_log_cmd(Info.SWITCH_OFF)
         q.add_pus_tc(
             PusTelecommand(

eive_tmtc/tmtc/wdt.py

@@ -0,0 +1,43 @@
+import enum
+from tmtccmd.config.tmtc import (
+    OpCodeEntry,
+    TmtcDefinitionWrapper,
+    tmtc_definitions_provider,
+)
+from tmtccmd.pus.s8_fsfw_funccmd import create_action_cmd
+from tmtccmd.tc import DefaultPusQueueHelper
+
+from eive_tmtc.config.definitions import CustomServiceList
+from eive_tmtc.config.object_ids import XIPHOS_WDT_ID
+
+
+class OpCode:
+    ENABLE = "enable"
+    DISABLE = "disable"
+
+
+class Info:
+    ENABLE = "Enable WDT"
+    DISABLE = "Disable WDT"
+
+
+class ActionId(enum.IntEnum):
+    ENABLE = 0
+    DISABLE = 1
+
+
+def pack_wdt_commands(q: DefaultPusQueueHelper, op_code: str):
+    if op_code == OpCode.ENABLE:
+        q.add_pus_tc(create_action_cmd(XIPHOS_WDT_ID, ActionId.ENABLE))
+    if op_code == OpCode.DISABLE:
+        q.add_pus_tc(create_action_cmd(XIPHOS_WDT_ID, ActionId.DISABLE))
+
+
+@tmtc_definitions_provider
+def add_xiphos_wdt_defs(defs: TmtcDefinitionWrapper):
+    oce = OpCodeEntry()
+    oce.add(keys=OpCode.ENABLE, info=Info.ENABLE)
+    oce.add(keys=OpCode.DISABLE, info=Info.DISABLE)
+    defs.add_service(
+        CustomServiceList.XIPHOS_WDT, info="Xiphos Watchdog Timer", op_code_entry=oce
+    )

pyproject.toml

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