object stirng update

Reviewed-on: #163

CHANGELOG.md

@@ -10,6 +10,17 @@ list yields a list of all related PRs for each release.
 
 # [unreleased]
 
+## Changed
+
+- ACS mode changes: The ACS CTRL submodes are now modes. DETUBMLE is now submode of SAFE mode.
+
+# [v2.17.3] 2023-03-09
+
+## Fixed
+
+- Fixed the heater object ID names completely. Also,
+  the HPA heater is now the Syrlinks heater.
+
 # [v2.17.2] 2023-03-07
 
 - Updated CSVs

eive_tmtc/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.17.2"
+__version__ = "2.17.3"
 
 import logging
 from pathlib import Path
@@ -6,7 +6,7 @@ from pathlib import Path
 SW_NAME = "eive-tmtc"
 VERSION_MAJOR = 2
 VERSION_MINOR = 17
-VERSION_REVISION = 2
+VERSION_REVISION = 3
 
 EIVE_TMTC_ROOT = Path(__file__).parent
 PACKAGE_ROOT = EIVE_TMTC_ROOT.parent

eive_tmtc/config/object_ids.py

@@ -71,14 +71,14 @@ PLOC_MPSOC_ID = bytes([0x44, 0x33, 0x00, 0x15])
 PL_PCDU_ID = bytes([0x44, 0x30, 0x00, 0x00])
 
 # Other
-HEATER_0_OBC_BRD = bytes([0x60, 0x00, 0x00, 0x00])
-HEATER_1_PLOC_PROC_BRD = bytes([0x60, 0x00, 0x00, 0x01])
+HEATER_0_PLOC_PROC_BRD = bytes([0x60, 0x00, 0x00, 0x00])
+HEATER_1_PCDU_BRD = bytes([0x60, 0x00, 0x00, 0x01])
 HEATER_2_ACS_BRD = bytes([0x60, 0x00, 0x00, 0x02])
-HEATER_3_PCDU_BRD = bytes([0x60, 0x00, 0x00, 0x03])
+HEATER_3_OBC_BRD = bytes([0x60, 0x00, 0x00, 0x03])
 HEATER_4_CAMERA = bytes([0x60, 0x00, 0x00, 0x04])
 HEATER_5_STR = bytes([0x60, 0x00, 0x00, 0x05])
 HEATER_6_DRO = bytes([0x60, 0x00, 0x00, 0x06])
-HEATER_7_HPA = bytes([0x60, 0x00, 0x00, 0x07])
+HEATER_7_SYRLINKS = bytes([0x60, 0x00, 0x00, 0x07])
 
 # RTDs
 RTD_0_PLOC_HSPD = bytes([0x44, 0x42, 0x00, 0x16])

eive_tmtc/config/objects.csv

@@ -135,7 +135,7 @@
 0x60000004;HEATER_4_CAMERA
 0x60000005;HEATER_5_STR
 0x60000006;HEATER_6_DRO
-0x60000007;HEATER_7_HPA
+0x60000007;HEATER_7_SYRLINKS
 0x73000001;ACS_BOARD_ASS
 0x73000002;SUS_BOARD_ASS
 0x73000003;TCS_BOARD_ASS

eive_tmtc/pus_tm/hk_handling.py

@@ -166,6 +166,8 @@ def handle_regular_hk_print(
         return handle_thermal_controller_hk_data(
             object_id=object_id, printer=printer, set_id=set_id, hk_data=hk_data
         )
+    elif objb == obj_ids.STAR_TRACKER_ID:
+        return handle_str_hk_data(set_id=set_id, hk_data=hk_data, printer=printer)
     elif objb == obj_ids.PLOC_SUPV_ID:
         return handle_supv_hk_data(set_id=set_id, hk_data=hk_data, printer=printer)
     elif objb == obj_ids.ACS_CONTROLLER:

eive_tmtc/tmtc/acs/acs_ctrl.py

@@ -8,6 +8,7 @@ from typing import Tuple
 from eive_tmtc.config.definitions import CustomServiceList
 from eive_tmtc.config.object_ids import ACS_CONTROLLER
 from eive_tmtc.pus_tm.defs import PrintWrapper
+from eive_tmtc.tmtc.acs.defs import AcsMode, SafeSubmode
 from tmtccmd.config.tmtc import (
     tmtc_definitions_provider,
     TmtcDefinitionWrapper,
@@ -55,17 +56,6 @@ class SetId(enum.IntEnum):
     ACTUATOR_CMD_DATA = 9
 
 
-class Submode(enum.IntEnum):
-    OFF = 0
-    SAFE = 10
-    DETUMBLE = 11
-    IDLE = 12
-    PTG_NADIR = 13
-    PTG_TARGET = 14
-    PTG_TARGET_GS = 15
-    PTG_INERTIAL = 16
-
-
 class ActionId(enum.IntEnum):
     SOLAR_ARRAY_DEPLOYMENT_SUCCESSFUL = 0
     RESET_MEKF = 1
@@ -73,13 +63,13 @@ class ActionId(enum.IntEnum):
 
 class OpCodes:
     OFF = ["off"]
-    SAFE = ["normal_safe"]
-    DTBL = ["normal_detumble"]
-    IDLE = ["normal_idle"]
-    NADIR = ["normal_nadir"]
-    TARGET = ["normal_target"]
-    GS = ["normal_gs"]
-    INERTIAL = ["normal_inertial"]
+    SAFE = ["safe"]
+    DTBL = ["safe_detumble"]
+    IDLE = ["ptg_idle"]
+    NADIR = ["ptg_nadir"]
+    TARGET = ["ptg_target"]
+    GS = ["ptg_target_gs"]
+    INERTIAL = ["ptg_inertial"]
     SAFE_PTG = ["confirm_deployment"]
     RESET_MEKF = ["reset_mekf"]
     SET_PARAMETER_SCALAR = ["set_scalar_param"]
@@ -119,9 +109,9 @@ class OpCodes:
 
 class Info:
     OFF = "Switch ACS CTRL off"
-    SAFE = "Switch ACS CTRL normal - safe"
-    DTBL = "Switch ACS CTRL normal - detumble"
-    IDLE = "Switch ACS CTRL normal - idle"
+    SAFE = "Switch ACS CTRL - safe"
+    DTBL = "Switch ACS CTRL - safe with detumble submode"
+    IDLE = "Switch ACS CTRL - pointing idle"
     NADIR = "Switch ACS CTRL normal - pointing nadir"
     TARGET = "Switch ACS CTRL normal - pointing target"
     GS = "Switch ACS CTRL normal - pointing target groundstation"
@@ -235,29 +225,29 @@ def pack_acs_ctrl_command(p: ServiceProviderParams):
         q.add_pus_tc(pack_mode_command(ACS_CONTROLLER, Mode.OFF, 0))
     elif op_code in OpCodes.SAFE:
         q.add_log_cmd(f"{Info.SAFE}")
-        q.add_pus_tc(pack_mode_command(ACS_CONTROLLER, Mode.NORMAL, Submode.SAFE))
+        q.add_pus_tc(
+            pack_mode_command(ACS_CONTROLLER, AcsMode.SAFE, SafeSubmode.DEFAULT)
+        )
     elif op_code in OpCodes.DTBL:
         q.add_log_cmd(f"{Info.DTBL}")
-        q.add_pus_tc(pack_mode_command(ACS_CONTROLLER, Mode.NORMAL, Submode.DETUMBLE))
+        q.add_pus_tc(
+            pack_mode_command(ACS_CONTROLLER, AcsMode.SAFE, SafeSubmode.DETUMBLE)
+        )
     elif op_code in OpCodes.IDLE:
         q.add_log_cmd(f"{Info.IDLE}")
-        q.add_pus_tc(pack_mode_command(ACS_CONTROLLER, Mode.NORMAL, Submode.IDLE))
+        q.add_pus_tc(pack_mode_command(ACS_CONTROLLER, AcsMode.IDLE, 0))
     elif op_code in OpCodes.NADIR:
         q.add_log_cmd(f"{Info.NADIR}")
-        q.add_pus_tc(pack_mode_command(ACS_CONTROLLER, Mode.NORMAL, Submode.PTG_NADIR))
+        q.add_pus_tc(pack_mode_command(ACS_CONTROLLER, AcsMode.PTG_NADIR, 0))
     elif op_code in OpCodes.TARGET:
         q.add_log_cmd(f"{Info.TARGET}")
-        q.add_pus_tc(pack_mode_command(ACS_CONTROLLER, Mode.NORMAL, Submode.PTG_TARGET))
+        q.add_pus_tc(pack_mode_command(ACS_CONTROLLER, AcsMode.PTG_TARGET, 0))
     elif op_code in OpCodes.GS:
         q.add_log_cmd(f"{Info.GS}")
-        q.add_pus_tc(
-            pack_mode_command(ACS_CONTROLLER, Mode.NORMAL, Submode.PTG_TARGET_GS)
-        )
+        q.add_pus_tc(pack_mode_command(ACS_CONTROLLER, AcsMode.PTG_TARGET_GS, 0))
     elif op_code in OpCodes.INERTIAL:
         q.add_log_cmd(f"{Info.INERTIAL}")
-        q.add_pus_tc(
-            pack_mode_command(ACS_CONTROLLER, Mode.NORMAL, Submode.PTG_INERTIAL)
-        )
+        q.add_pus_tc(pack_mode_command(ACS_CONTROLLER, AcsMode.PTG_INERTIAL, 0))
     elif op_code in OpCodes.SAFE_PTG:
         q.add_log_cmd(f"{Info.SAFE_PTG}")
         q.add_pus_tc(

eive_tmtc/tmtc/acs/defs.py

@@ -0,0 +1,16 @@
+import enum
+
+
+class AcsMode(enum.IntEnum):
+    OFF = 0
+    SAFE = 10
+    IDLE = 11
+    PTG_NADIR = 12
+    PTG_TARGET = 13
+    PTG_TARGET_GS = 14
+    PTG_INERTIAL = 15
+
+
+class SafeSubmode(enum.IntEnum):
+    DEFAULT = 0
+    DETUMBLE = 1

eive_tmtc/tmtc/acs/imtq.py

@@ -439,6 +439,8 @@ def handle_imtq_hk(printer: FsfwTmTcPrinter, hk_data: bytes, set_id: int):
         return handle_raw_mtm_measurement(printer, hk_data, False)
     elif set_id == ImtqSetId.RAW_MTM_WITH_TORQUE:
         return handle_raw_mtm_measurement(printer, hk_data, True)
+    elif set_id == ImtqSetId.DIPOLES:
+        return handle_dipole_set(printer, hk_data)
     elif set_id == ImtqSetId.STATUS_SET:
         return handle_status_set(printer, hk_data)
     else:
@@ -455,6 +457,21 @@ def unpack_status_set(hk_data: bytes) -> List:
     return [status_mode, status_error, status_conf, status_uptime]
 
 
+def handle_dipole_set(printer: FsfwTmTcPrinter, hk_data: bytes):
+    pw = PrintWrapper(printer)
+    pw.dlog("Received iMTQ dipole set")
+    fmt_str = "!hhhH"
+    fmt_len = struct.calcsize(fmt_str)
+    (dipole_x, dipole_y, dipole_z, current_torque_duration) = struct.unpack(
+        fmt_str, hk_data[0:8]
+    )
+    pw.dlog(f"Dipole X: {dipole_x}")
+    pw.dlog(f"Dipole Y: {dipole_y}")
+    pw.dlog(f"Dipole Z: {dipole_z}")
+    pw.dlog(f"Current torque duration: {current_torque_duration}")
+    pw.printer.print_validity_buffer(hk_data[fmt_len:], 2)
+
+
 def unpack_eng_hk(hk_data: bytes) -> List:
     digital_voltage = struct.unpack("!H", hk_data[0:2])[0]
     analog_voltage = struct.unpack("!H", hk_data[2:4])[0]

eive_tmtc/tmtc/acs/star_tracker.py

@@ -5,20 +5,21 @@
 @author J. Meier
 @date   14.08.2021
 """
+import datetime
 import enum
 import logging
 import struct
 
 from eive_tmtc.config.definitions import CustomServiceList
+from eive_tmtc.pus_tm.defs import PrintWrapper
+from eive_tmtc.utility.input_helper import InputHelper
 from spacepackets.ecss.tc import PusTelecommand
 from tmtccmd.config import TmtcDefinitionWrapper, OpCodeEntry
 from tmtccmd.config.tmtc import tmtc_definitions_provider
-from tmtccmd.tc.pus_200_fsfw_mode import pack_mode_data, Mode
-
 from tmtccmd.tc import DefaultPusQueueHelper
+from tmtccmd.tc.pus_200_fsfw_mode import pack_mode_data, Mode
 from tmtccmd.util import ObjectIdU32
-from eive_tmtc.utility.input_helper import InputHelper
-
+from tmtccmd.util.tmtc_printer import FsfwTmTcPrinter
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -677,6 +678,89 @@ def get_upload_image() -> str:
     return image
 
 
+def handle_str_hk_data(set_id: int, hk_data: bytes, printer: FsfwTmTcPrinter):
+    pw = PrintWrapper(printer)
+    pw.dlog(f"Received STR HK set with set ID {set_id}")
+    if set_id == SetId.SOLUTION:
+        handle_solution_set(hk_data, pw)
+    else:
+        _LOGGER.warning(f"HK parsing for Star Tracker set ID {set_id} unimplemented")
+
+
+def handle_solution_set(hk_data: bytes, pw: PrintWrapper):
+    pw.dlog("Received solution set")
+    ticks_time_fmt = "!IQ"
+    current_idx = 0
+    fmt_len = struct.calcsize(ticks_time_fmt)
+    (ticks, unix_time) = struct.unpack(
+        ticks_time_fmt, hk_data[current_idx : current_idx + fmt_len]
+    )
+    unix_as_dt = datetime.datetime.fromtimestamp(unix_time, tz=datetime.timezone.utc)
+    pw.dlog(f"Ticks: {ticks} | UNIX time: {unix_time}")
+    pw.dlog(f"UNIX as datetime: {unix_as_dt}")
+    current_idx += fmt_len
+    calib_quaternions_fmt = "!ffff"
+    fmt_len = struct.calcsize(calib_quaternions_fmt)
+    (calib_q_w, calib_q_x, calib_q_y, calib_q_z) = struct.unpack(
+        calib_quaternions_fmt, hk_data[current_idx : current_idx + fmt_len]
+    )
+    pw.dlog("Calibrated Quaternions")
+    pw.dlog(f"Quaternion w: {calib_q_w}")
+    pw.dlog(f"Quaternion x: {calib_q_x}")
+    pw.dlog(f"Quaternion y: {calib_q_y}")
+    pw.dlog(f"Quaternion z: {calib_q_z}")
+    current_idx += fmt_len
+    track_fmt = "!fffff"
+    fmt_len = struct.calcsize(track_fmt)
+    (track_confidence, track_q_w, track_q_x, track_q_y, track_q_z) = struct.unpack(
+        track_fmt, hk_data[current_idx : current_idx + fmt_len]
+    )
+    pw.dlog(f"Track Confidence: {track_confidence}")
+    pw.dlog(f"Track QW: {track_q_w}")
+    pw.dlog(f"Track QX: {track_q_x}")
+    pw.dlog(f"Track QY: {track_q_y}")
+    pw.dlog(f"Track QZ: {track_q_z}")
+    current_idx += fmt_len
+    track_removed = hk_data[current_idx]
+    pw.dlog(f"Number of stars removed from tracking solution: {track_removed}")
+    current_idx += 1
+    stars_centroided = hk_data[current_idx]
+    pw.dlog(f"Centroided stars: {stars_centroided}")
+    current_idx += 1
+    stars_matched_database = hk_data[current_idx]
+    pw.dlog(f"Stars matched: {stars_matched_database}")
+    current_idx += 1
+    # Result of LISA: Lost in space algorithm
+    lisa_fmt = "!fffffB"
+    fmt_len = struct.calcsize(track_fmt)
+    (
+        lisa_q_w,
+        lisa_q_x,
+        lisa_q_y,
+        lisa_q_z,
+        lisa_percentage_close_stars,
+        lisa_number_close_stars,
+    ) = struct.unpack(lisa_fmt, hk_data[current_idx : current_idx + fmt_len])
+    pw.dlog(f"LISA QW: {lisa_q_w}")
+    pw.dlog(f"LISA QX: {lisa_q_x}")
+    pw.dlog(f"LISA QY: {lisa_q_y}")
+    pw.dlog(f"LISA QZ: {lisa_q_z}")
+    pw.dlog(
+        f"Percentage of close stars in LISA solution: {lisa_percentage_close_stars}"
+    )
+    pw.dlog(f"Number of close stars in LISA solution: {lisa_number_close_stars}")
+    current_idx += fmt_len
+    is_trusworthy = hk_data[current_idx]
+    pw.dlog(f"Trustworthy solution: {is_trusworthy}")
+    current_idx += 1
+    stable_count = struct.unpack("!I", hk_data[current_idx : current_idx + 4])
+    pw.dlog(f"Stable count: {stable_count}")
+    current_idx += 4
+    solution_strategy = hk_data[current_idx]
+    pw.dlog(f"Solution strategy: {solution_strategy}")
+    pw.printer.print_validity_buffer(hk_data[current_idx:], 23)
+
+
 @tmtc_definitions_provider
 def add_str_cmds(defs: TmtcDefinitionWrapper):
     oce = OpCodeEntry()

eive_tmtc/tmtc/acs/subsystem.py

@@ -1,6 +1,7 @@
 import enum
 from typing import Tuple, Dict
 
+from eive_tmtc.tmtc.acs.defs import AcsMode, SafeSubmode
 from spacepackets.ecss import PusTelecommand
 from eive_tmtc.tmtc.common import pack_mode_cmd_with_info
 from eive_tmtc.config.object_ids import ACS_SUBSYSTEM_ID
@@ -27,17 +28,6 @@ class OpCode(str, enum.Enum):
     REPORT_ALL_MODES = "all_modes"
 
 
-class AcsMode(enum.IntEnum):
-    OFF = 0
-    SAFE = 10
-    DETUMBLE = 11
-    IDLE = 12
-    PTG_TARGET_NADIR = 13
-    PTG_TARGET = 14
-    PTG_TARGET_GS = 15
-    PTG_TARGET_INERTIAL = 16
-
-
 class Info(str, enum.Enum):
     OFF = "Off Command"
     SAFE = "Safe Mode Command"
@@ -50,15 +40,15 @@ class Info(str, enum.Enum):
     REPORT_ALL_MODES = "Report All Modes Recursively"
 
 
-HANDLER_LIST: Dict[str, Tuple[int, str]] = {
-    OpCode.OFF: (AcsMode.OFF, Info.OFF),
-    OpCode.SAFE: (AcsMode.SAFE, Info.SAFE),
-    OpCode.DETUMBLE: (AcsMode.DETUMBLE, Info.DETUMBLE),
-    OpCode.IDLE: (AcsMode.IDLE, Info.IDLE),
-    OpCode.PTG_TARGET: (AcsMode.PTG_TARGET, Info.PTG_TARGET),
-    OpCode.PTG_TARGET_GS: (AcsMode.PTG_TARGET_GS, Info.PTG_TARGET_GS),
-    OpCode.PTG_TARGET_NADIR: (AcsMode.PTG_TARGET_NADIR, Info.PTG_TARGET_NADIR),
-    OpCode.PTG_TARGET_INERTIAL: (AcsMode.PTG_TARGET_INERTIAL, Info.PTG_TARGET_INERTIAL),
+HANDLER_LIST: Dict[str, Tuple[int, int, str]] = {
+    OpCode.OFF: (AcsMode.OFF, 0, Info.OFF),
+    OpCode.SAFE: (AcsMode.SAFE, SafeSubmode.DEFAULT, Info.SAFE),
+    OpCode.DETUMBLE: (AcsMode.SAFE, SafeSubmode.DETUMBLE, Info.DETUMBLE),
+    OpCode.IDLE: (AcsMode.IDLE, 0, Info.IDLE),
+    OpCode.PTG_TARGET: (AcsMode.PTG_TARGET, 0, Info.PTG_TARGET),
+    OpCode.PTG_TARGET_GS: (AcsMode.PTG_TARGET_GS, 0, Info.PTG_TARGET_GS),
+    OpCode.PTG_TARGET_NADIR: (AcsMode.PTG_NADIR, 0, Info.PTG_TARGET_NADIR),
+    OpCode.PTG_TARGET_INERTIAL: (AcsMode.PTG_INERTIAL, 0, Info.PTG_TARGET_INERTIAL),
 }
 
 
@@ -81,9 +71,9 @@ def build_acs_subsystem_cmd(p: ServiceProviderParams):
         return
     pack_mode_cmd_with_info(
         object_id=ACS_SUBSYSTEM_ID,
-        info=f"{info_prefix}: {mode_info_tup[1]}",
-        submode=0,
+        info=f"{info_prefix}: {mode_info_tup[2]}",
         mode=mode_info_tup[0],
+        submode=mode_info_tup[1],
         q=q,
     )
 
@@ -91,7 +81,7 @@ def build_acs_subsystem_cmd(p: ServiceProviderParams):
 @tmtc_definitions_provider
 def add_acs_subsystem_cmds(defs: TmtcDefinitionWrapper):
     oce = OpCodeEntry()
-    for op_code, (_, info) in HANDLER_LIST.items():
+    for op_code, (_, _, info) in HANDLER_LIST.items():
         oce.add(op_code, info)
     oce.add(OpCode.REPORT_ALL_MODES, Info.REPORT_ALL_MODES)
     defs.add_service(CustomServiceList.ACS_SS, "ACS Subsystem", oce)

eive_tmtc/tmtc/tcs/heater.py

@@ -21,26 +21,26 @@ from spacepackets.ecss.tc import PusTelecommand
 
 
 class Heater(enum.IntEnum):
-    HEATER_0_OBC_BRD = 0
-    HEATER_1_PLOC_PROC_BRD = 1
+    HEATER_0_PLOC_PROC_BRD = 0
+    HEATER_1_PCDU_BRD = 1
     HEATER_2_ACS_BRD = 2
-    HEATER_3_PCDU_PDU = 3
+    HEATER_3_OBC_BRD = 3
     HEATER_4_CAMERA = 4
     HEATER_5_STR = 5
     HEATER_6_DRO = 6
-    HEATER_7_HPA = 7
+    HEATER_7_SYRLINKS = 7
     NUMBER_OF_SWITCHES = 8
 
 
 HEATER_LOCATION = [
-    "OBC Board",
     "PLOC Processing Board",
-    "ACS Board",
     "PCDU PDU",
+    "ACS Board",
+    "OBC Board",
     "Camera",
     "Startracker",
     "DRO",
-    "HPA",
+    "Syrlinks",
 ]
 
 
@@ -135,25 +135,25 @@ def pack_heater_cmds(object_id: bytearray, op_code: str, q: DefaultPusQueueHelpe
 
 def heater_idx_to_obj(heater: int) -> ObjectIdU32:
     from eive_tmtc.config.object_ids import (
-        HEATER_0_OBC_BRD,
-        HEATER_1_PLOC_PROC_BRD,
+        HEATER_0_PLOC_PROC_BRD,
+        HEATER_1_PCDU_BRD,
         HEATER_2_ACS_BRD,
-        HEATER_3_PCDU_BRD,
+        HEATER_3_OBC_BRD,
         HEATER_4_CAMERA,
         HEATER_5_STR,
         HEATER_6_DRO,
-        HEATER_7_HPA,
+        HEATER_7_SYRLINKS,
     )
 
     obj_id_array = [
-        HEATER_0_OBC_BRD,
-        HEATER_1_PLOC_PROC_BRD,
+        HEATER_0_PLOC_PROC_BRD,
+        HEATER_1_PCDU_BRD,
         HEATER_2_ACS_BRD,
-        HEATER_3_PCDU_BRD,
+        HEATER_3_OBC_BRD,
         HEATER_4_CAMERA,
         HEATER_5_STR,
         HEATER_6_DRO,
-        HEATER_7_HPA,
+        HEATER_7_SYRLINKS,
     ]
     obj_dict = get_object_ids()
     obj_id_obj = obj_dict.get(obj_id_array[heater])