add better assy names, group legacy object IDs

Reviewed-on: #156

CHANGELOG.md

@@ -10,6 +10,29 @@ list yields a list of all related PRs for each release.
 
 # [unreleased]
 
+# [v2.17.1] 2023-03-07
+
+## Added
+
+- `MGT_ASSEMBLY` object ID
+
+# [v2.17.0] 2023-03-07
+
+## Added
+
+- Health set and health announce commands
+- Camera Switcher, Syrlinks Assembly, IMTQ assembly and Star Tracker assembly object IDs added
+
+## Changed
+
+- Breaking typo fix in TMP1075 `SetId`
+
+# [v2.16.4] 2023-03-04
+
+## Added
+
+- Some more IMTQ commands
+
 # [v2.16.3] 2023-03-03
 
 ## Added

eive_tmtc/__init__.py

@@ -1,12 +1,12 @@
-__version__ = "2.16.3"
+__version__ = "2.17.1"
 
 import logging
 from pathlib import Path
 
 SW_NAME = "eive-tmtc"
 VERSION_MAJOR = 2
-VERSION_MINOR = 16
-VERSION_REVISION = 3
+VERSION_MINOR = 17
+VERSION_REVISION = 1
 
 EIVE_TMTC_ROOT = Path(__file__).parent
 PACKAGE_ROOT = EIVE_TMTC_ROOT.parent

eive_tmtc/config/object_ids.py

@@ -132,10 +132,21 @@ PL_SUBSYSTEM_ID = bytes([0x73, 0x01, 0x00, 0x02])
 TCS_SUBSYSTEM_ID = bytes([0x73, 0x01, 0x00, 0x03])
 COM_SUBSYSTEM_ID = bytes([0x73, 0x01, 0x00, 0x04])
 
+# Legacy names, kept for backwards compatibility
 ACS_BOARD_ASS_ID = bytes([0x73, 0x00, 0x00, 0x01])
-SUS_BOARD_ASS_ID = bytes([0x73, 0x00, 0x00, 0x02])
 TCS_BOARD_ASS_ID = bytes([0x73, 0x00, 0x00, 0x03])
+SUS_BOARD_ASS_ID = bytes([0x73, 0x00, 0x00, 0x02])
+IMTQ_ASSEMBLY = bytes([0x73, 0x00, 0x00, 0x08])
+
+ACS_BOARD_ASSEMBLY = bytes([0x73, 0x00, 0x00, 0x01])
+SUS_BOARD_ASSEMBLY = bytes([0x73, 0x00, 0x00, 0x02])
+TCS_BOARD_ASSEMBLY = bytes([0x73, 0x00, 0x00, 0x03])
 RW_ASSEMBLY = bytes([0x73, 0x00, 0x00, 0x04])
+CAM_SWITCHER = bytes([0x73, 0x00, 0x00, 0x06])
+SYRLINKS_ASSEMBLY = bytes([0x73, 0x00, 0x00, 0x07])
+# To be removed soon..
+MGT_ASSEMBLY = bytes([0x73, 0x00, 0x00, 0x08])
+STR_ASSEMBLY = bytes([0x73, 0x00, 0x00, 0x09])
 
 # Controllers
 TCS_CONTROLLER = bytes([0x43, 0x40, 0x00, 0x01])

eive_tmtc/config/objects.csv

@@ -142,6 +142,7 @@
 0x73000004;RW_ASSY
 0x73000006;CAM_SWITCHER
 0x73000007;SYRLINKS_ASSY
+0x73000008;IMTQ_ASSY
 0x73000100;TM_FUNNEL
 0x73000101;PUS_TM_FUNNEL
 0x73000102;CFDP_TM_FUNNEL

eive_tmtc/tmtc/acs/imtq.py

@@ -41,7 +41,8 @@ class OpCode:
     NORMAL = "normal"
     OFF = "off"
     SET_DIPOLE = "set_dipole"
-    REQUEST_ENG_HK_NO_TORQUE = "hk_os_eng_hk"
+    REQUEST_ENG_HK_NO_TORQUE = "hk_os_eng_hk_no_torque"
+    REQUEST_ENG_HK_WITH_TORQUE = "hk_os_eng_hk_with_torque"
     REQUEST_MGM_RAW_NO_TORQUE = "hk_os_mgm_raw_no_torque"
     ENABLE_MGM_RAW_NO_TORQUE = "enb_mgm_raw_no_torque"
     DISABLE_MGM_RAW_NO_TORQUE = "dis_mgm_raw_no_torque"
@@ -50,6 +51,8 @@ class OpCode:
     DISABLE_MGM_RAW_WITH_TORQUE = "dis_mgm_raw_with_torque"
     ENABLE_ENG_HK_NO_TORQUE = "enb_eng_hk_no_torque"
     DISABLE_ENG_HK_NO_TORQUE = "dis_eng_hk_no_torque"
+    ENABLE_ENG_HK_WITH_TORQUE = "enb_eng_hk_with_torque"
+    DISABLE_ENG_HK_WITH_TORQUE = "dis_eng_hk_with_torque"
     POS_X_SELF_TEST = "self_test_pos_x"
     NEG_X_SELF_TEST = "self_test_neg_x"
     POS_Y_SELF_TEST = "self_test_pos_y"
@@ -96,6 +99,14 @@ def add_imtq_cmds(defs: TmtcDefinitionWrapper):
     oce.add(OpCode.ON, "Mode On")
     oce.add(OpCode.NORMAL, "Mode Normal")
     oce.add(OpCode.REQUEST_ENG_HK_NO_TORQUE, "Request Engineering HK One Shot")
+    oce.add(
+        OpCode.REQUEST_ENG_HK_WITH_TORQUE,
+        "Request Engineering HK One Shot during Torque",
+    )
+    oce.add(OpCode.ENABLE_ENG_HK_NO_TORQUE, "Enable ENG HK not torque")
+    oce.add(OpCode.ENABLE_ENG_HK_WITH_TORQUE, "Enable ENG HK with torque")
+    oce.add(OpCode.DISABLE_ENG_HK_NO_TORQUE, "Disable ENG HK not torque")
+    oce.add(OpCode.DISABLE_ENG_HK_WITH_TORQUE, "Disable ENG HK with torque")
     oce.add(
         OpCode.REQUEST_MGM_RAW_NO_TORQUE, "Request MGM Raw Without Torque HK One Shot"
     )
@@ -250,8 +261,35 @@ def pack_imtq_test_into(object_id: ObjectIdU32, q: DefaultPusQueueHelper, op_cod
                 True, make_sid(object_id.as_bytes, ImtqSetId.ENG_HK_NO_TORQUE)
             )
         )
+    if op_code == OpCode.REQUEST_ENG_HK_WITH_TORQUE:
+        q.add_log_cmd("IMTQ: Get engineering hk set with torque")
+        q.add_pus_tc(
+            create_request_one_diag_command(
+                sid=make_sid(
+                    object_id=object_id.as_bytes,
+                    set_id=ImtqSetId.ENG_HK_SET_WITH_TORQUE,
+                )
+            )
+        )
+    if op_code == OpCode.ENABLE_ENG_HK_WITH_TORQUE:
+        q.add_log_cmd("IMTQ: Enable ENG HK with torque")
+        interval = float(input("Please enter collection interval in seconds: "))
+        cmds = create_enable_periodic_hk_command_with_interval(
+            diag=True,
+            sid=make_sid(object_id.as_bytes, ImtqSetId.ENG_HK_SET_WITH_TORQUE),
+            interval_seconds=interval,
+        )
+        for cmd in cmds:
+            q.add_pus_tc(cmd)
+    if op_code == OpCode.DISABLE_ENG_HK_WITH_TORQUE:
+        q.add_log_cmd("IMTQ: Disable ENG HK with Torque")
+        q.add_pus_tc(
+            create_disable_periodic_hk_command(
+                True, make_sid(object_id.as_bytes, ImtqSetId.ENG_HK_SET_WITH_TORQUE)
+            )
+        )
     if op_code == OpCode.REQUEST_ENG_HK_NO_TORQUE:
-        q.add_log_cmd("IMTQ: Get engineering hk set")
+        q.add_log_cmd("IMTQ: Get engineering hk set (no torque)")
         q.add_pus_tc(
             generate_one_diag_command(
                 sid=make_sid(
@@ -392,19 +430,15 @@ def handle_imtq_hk(printer: FsfwTmTcPrinter, hk_data: bytes, set_id: int):
     if (set_id >= ImtqSetId.POSITIVE_X_TEST) and (set_id <= ImtqSetId.NEGATIVE_Z_TEST):
         return handle_self_test_data(printer, hk_data)
     elif set_id == ImtqSetId.ENG_HK_NO_TORQUE:
-        _LOGGER.info("Found engineering HK without torque")
-        return handle_eng_set(printer, hk_data)
+        return handle_eng_set(printer, hk_data, False)
     elif set_id == ImtqSetId.ENG_HK_SET_WITH_TORQUE:
-        _LOGGER.info("Found engineering HK during torque")
-        return handle_eng_set(printer, hk_data)
+        return handle_eng_set(printer, hk_data, True)
     elif set_id == ImtqSetId.CAL_MTM_SET:
         return handle_calibrated_mtm_measurement(printer, hk_data)
     elif set_id == ImtqSetId.RAW_MTM_NO_TORQUE:
-        _LOGGER.info("Found raw MTM measurement without torque")
-        return handle_raw_mtm_measurement(printer, hk_data)
+        return handle_raw_mtm_measurement(printer, hk_data, False)
     elif set_id == ImtqSetId.RAW_MTM_WITH_TORQUE:
-        _LOGGER.info("Found raw MTM measurement during torque")
-        return handle_raw_mtm_measurement(printer, hk_data)
+        return handle_raw_mtm_measurement(printer, hk_data, True)
     elif set_id == ImtqSetId.STATUS_SET:
         return handle_status_set(printer, hk_data)
     else:
@@ -449,8 +483,9 @@ def unpack_eng_hk(hk_data: bytes) -> List:
     return content_list
 
 
-def handle_eng_set(printer: FsfwTmTcPrinter, hk_data: bytes):
+def handle_eng_set(printer: FsfwTmTcPrinter, hk_data: bytes, torque_on: bool):
     pw = PrintWrapper(printer)
+    pw.dlog(f"Found engineering HK. Torque Status: {torque_on}")
     content_list = unpack_eng_hk(hk_data)
     validity_buffer = hk_data[32:]
 
@@ -491,8 +526,11 @@ def handle_calibrated_mtm_measurement(printer: FsfwTmTcPrinter, hk_data: bytes):
     printer.print_validity_buffer(validity_buffer=validity_buffer, num_vars=num_of_vars)
 
 
-def handle_raw_mtm_measurement(printer: FsfwTmTcPrinter, hk_data: bytes):
+def handle_raw_mtm_measurement(
+    printer: FsfwTmTcPrinter, hk_data: bytes, torque_status: bool
+):
     pw = PrintWrapper(printer)
+    pw.dlog(f"Found raw MTM measurement. Torque Status: {torque_status}")
     header_list = [
         "Raw MTM X [nT]",
         "Raw MTM Y [nT]",

eive_tmtc/tmtc/health.py

@@ -1,4 +1,7 @@
+import struct
+
 from eive_tmtc.config.definitions import CustomServiceList
+from eive_tmtc.tmtc.obj_prompt import prompt_object
 from spacepackets.ecss import PusTelecommand
 from tmtccmd.config.tmtc import (
     tmtc_definitions_provider,
@@ -6,33 +9,58 @@ from tmtccmd.config.tmtc import (
     OpCodeEntry,
 )
 from tmtccmd.tc import service_provider
-from tmtccmd.pus.s201_fsfw_health import Subservice
+from tmtccmd.pus.s201_fsfw_health import Subservice, FsfwHealth
 from tmtccmd.tc.decorator import ServiceProviderParams
 
 
 class OpCode:
+    SET_HEALTH = "set_health"
     ANNOUNCE_HEALTH_ALL = "read_health_all"
     ANNOUNCE_HEALTH = "read_health"
 
 
 class Info:
+    SET_HEALTH = "Set health of specific object"
     ANNOUNCE_HEALTH_ALL = "Read all health states"
     ANNOUNCE_HEALTH = "Read health state of one object"
 
 
+def prompt_health() -> FsfwHealth:
+    for item in FsfwHealth:
+        print(f"{item}: {item.name}")
+    health_idx = int(input("Please enter health by index: "))
+    return FsfwHealth(health_idx)
+
+
 @service_provider(CustomServiceList.HEALTH)
 def pack_test_command(p: ServiceProviderParams):
     o = p.op_code
     q = p.queue_helper
-    if o == OpCode.ANNOUNCE_HEALTH:
-        raise NotImplementedError()
+    if o == OpCode.SET_HEALTH:
+        app_data = bytearray(prompt_object())
+        health = prompt_health()
+        app_data.append(health)
+        q.add_log_cmd(Info.SET_HEALTH)
+        q.add_pus_tc(
+            PusTelecommand(
+                service=201, subservice=Subservice.TC_SET_HEALTH, app_data=app_data
+            )
+        )
+    elif o == OpCode.ANNOUNCE_HEALTH:
+        app_data = bytearray(prompt_object())
+        q.add_log_cmd(Info.ANNOUNCE_HEALTH)
+        q.add_pus_tc(
+            PusTelecommand(
+                service=201, subservice=Subservice.TC_ANNOUNCE_HEALTH, app_data=app_data
+            )
+        )
     elif o == OpCode.ANNOUNCE_HEALTH_ALL:
         q.add_log_cmd(Info.ANNOUNCE_HEALTH_ALL)
         q.add_pus_tc(
             PusTelecommand(service=201, subservice=Subservice.TC_ANNOUNCE_HEALTH_ALL)
         )
-        return
-    raise ValueError(f"unknown op code {o} for service {CustomServiceList.HEALTH}")
+    else:
+        raise ValueError(f"unknown op code {o} for service {CustomServiceList.HEALTH}")
 
 
 @tmtc_definitions_provider
@@ -40,4 +68,5 @@ def add_health_cmd_defs(defs: TmtcDefinitionWrapper):
     oce = OpCodeEntry()
     oce.add(OpCode.ANNOUNCE_HEALTH_ALL, Info.ANNOUNCE_HEALTH_ALL)
     oce.add(OpCode.ANNOUNCE_HEALTH, Info.ANNOUNCE_HEALTH)
+    oce.add(OpCode.SET_HEALTH, Info.SET_HEALTH)
     defs.add_service(CustomServiceList.HEALTH, info="Health Service", op_code_entry=oce)

eive_tmtc/tmtc/obj_prompt.py

@@ -0,0 +1,43 @@
+from eive_tmtc.config.object_ids import (
+    ACS_SUBSYSTEM_ID,
+    ACS_CONTROLLER,
+    IMTQ_HANDLER_ID,
+    GYRO_0_ADIS_HANDLER_ID,
+    GYRO_1_L3G_HANDLER_ID,
+    ACS_BOARD_ASS_ID,
+    RW_ASSEMBLY,
+    SUS_BOARD_ASS_ID,
+)
+
+SUBSYSTEM_DICT = {
+    0: "acs",
+    1: "tcs",
+    2: "com",
+}
+
+ACS_OBJ_DICT = {
+    0: ("Subsystem", ACS_SUBSYSTEM_ID),
+    1: ("SUS Assembly", SUS_BOARD_ASS_ID),
+    2: ("ACS Board Assembly", ACS_BOARD_ASS_ID),
+    3: ("RW Assembly", RW_ASSEMBLY),
+    4: ("iMTQ MGT", IMTQ_HANDLER_ID),
+    5: ("GYR 0 ADIS", GYRO_0_ADIS_HANDLER_ID),
+    6: ("GYR 1 L3G", GYRO_1_L3G_HANDLER_ID)
+}
+
+
+def prompt_object() -> bytes:
+    for k, v in SUBSYSTEM_DICT.items():
+        print(f"{k}: {v}")
+    subsystem_key = int(input("Please specify target subsystem by key: "))
+    subsystem = SUBSYSTEM_DICT[subsystem_key]
+    if subsystem is None:
+        raise ValueError("invalid key")
+    if subsystem == "acs":
+        for k, v in ACS_OBJ_DICT.items():
+            print(f"{k}: {v[0]}")
+        obj_key = int(input("Please specify target object by key: "))
+        acs_obj = ACS_OBJ_DICT[obj_key]
+        if acs_obj is None:
+            raise ValueError("invalid key")
+        return acs_obj[1]

eive_tmtc/tmtc/tcs/tmp1075.py

@@ -40,7 +40,7 @@ class Tmp1075ActionId(enum.IntEnum):
 
 
 class SetId:
-    TMEPERATURE = 1
+    TEMPERATURE = 1
 
 
 def pack_tmp1075_test_into(
@@ -64,7 +64,7 @@ def pack_tmp1075_test_into(
         q.add_pus_tc(PusTelecommand(service=200, subservice=1, app_data=mode_data))
     if op_code == OpCode.HK:
         q.add_log_cmd("TMP1075: Request One-Shot HK")
-        q.add_pus_tc(create_request_one_hk_command(make_sid(obyt, SetId.TMEPERATURE)))
+        q.add_pus_tc(create_request_one_hk_command(make_sid(obyt, SetId.TEMPERATURE)))
     return q