Merge pull request 'PLOC SUPV HK parsing' (#231) from parse-ploc-supv-hk into main

Reviewed-on: #231

CHANGELOG.md

@@ -10,6 +10,35 @@ list yields a list of all related PRs for each release.
 
 # [unreleased]
 
+# [v5.4.3] 2023-08-15
+
+## Added
+
+- PLOC SUPV HK parsing.
+
+# [v5.4.2] 2023-08-15
+
+## Added
+
+- New NONE entry for PL PCDU submode enum.
+
+# [v5.4.1] 2023-08-15
+
+## Added
+
+- New event TLE_TOO_OLD
+
+## Changed
+
+ - PL Subsystem mode ID is int enum now.
+
+# [v5.4.0] 2023-08-15
+
+## Added
+
+- New enumeration for PL PCDU commanding.
+- Some new events
+
 # [v5.3.1] 2023-07-26
 
 ## Changed

eive_tmtc/__init__.py

@@ -1,12 +1,12 @@
-__version__ = "5.3.1"
+__version__ = "5.4.3"
 
 import logging
 from pathlib import Path
 
 SW_NAME = "eive-tmtc"
 VERSION_MAJOR = 5
-VERSION_MINOR = 3
-VERSION_REVISION = 1
+VERSION_MINOR = 4
+VERSION_REVISION = 3
 
 EIVE_TMTC_ROOT = Path(__file__).parent
 PACKAGE_ROOT = EIVE_TMTC_ROOT.parent

eive_tmtc/config/events.csv

@@ -94,6 +94,7 @@ Event ID (dec); Event ID (hex); Name; Severity; Description; File Path
 11205;0x2bc5;MEKF_AUTOMATIC_RESET;INFO;MEKF performed an automatic reset after detection of nonfinite values.;mission/acs/defs.h
 11206;0x2bc6;MEKF_INVALID_MODE_VIOLATION;HIGH;MEKF was not able to compute a solution during any pointing ACS mode for a prolonged time.;mission/acs/defs.h
 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
 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/tmtc/acs/acs_ctrl.py

@@ -66,6 +66,7 @@ class ActionId(enum.IntEnum):
     SOLAR_ARRAY_DEPLOYMENT_SUCCESSFUL = 0
     RESET_MEKF = 1
     RESTORE_MEKF_NONFINITE_RECOVERY = 2
+    UPDATE_TLE = 3
 
 
 CTRL_STRAT_DICT = {
@@ -90,6 +91,13 @@ CTRL_STRAT_DICT = {
     31: "PTG_RAW",
 }
 
+GPS_COURCE_DICT = {
+    0: "NONE",
+    1: "GPS",
+    2: "GPS_EXTRAPOLATED",
+    3: "SGP4",
+}
+
 
 class OpCodes:
     OFF = ["off"]
@@ -103,6 +111,7 @@ class OpCodes:
     SAFE_PTG = ["confirm_deployment"]
     RESET_MEKF = ["reset_mekf"]
     RESTORE_MEKF_NONFINITE_RECOVERY = ["restore_mekf_nonfinite_recovery"]
+    UPDATE_TLE = ["update_tle"]
     SET_PARAMETER_SCALAR = ["set_scalar_param"]
     SET_PARAMETER_VECTOR = ["set_vector_param"]
     SET_PARAMETER_MATRIX = ["set_matrix_param"]
@@ -153,6 +162,7 @@ class Info:
     SAFE_PTG = "Confirm deployment of both solar arrays"
     RESET_MEKF = "Reset the MEKF"
     RESTORE_MEKF_NONFINITE_RECOVERY = "Restore MEKF non-finite recovery"
+    UPDATE_TLE = "Update TLE"
     SET_PARAMETER_SCALAR = "Set Scalar Parameter"
     SET_PARAMETER_VECTOR = "Set Vector Parameter"
     SET_PARAMETER_MATRIX = "Set Matrix Parameter"
@@ -220,6 +230,7 @@ def acs_cmd_defs(defs: TmtcDefinitionWrapper):
         keys=OpCodes.RESTORE_MEKF_NONFINITE_RECOVERY,
         info=Info.RESTORE_MEKF_NONFINITE_RECOVERY,
     )
+    oce.add(keys=OpCodes.UPDATE_TLE, info=Info.UPDATE_TLE)
     oce.add(keys=OpCodes.SET_PARAMETER_SCALAR, info=Info.SET_PARAMETER_SCALAR)
     oce.add(keys=OpCodes.SET_PARAMETER_VECTOR, info=Info.SET_PARAMETER_VECTOR)
     oce.add(keys=OpCodes.SET_PARAMETER_MATRIX, info=Info.SET_PARAMETER_MATRIX)
@@ -308,6 +319,22 @@ def pack_acs_ctrl_command(p: ServiceProviderParams):  # noqa C901
         q.add_pus_tc(
             create_action_cmd(ACS_CONTROLLER, ActionId.RESTORE_MEKF_NONFINITE_RECOVERY)
         )
+    elif op_code in OpCodes.UPDATE_TLE:
+        q.add_log_cmd(f"{Info.UPDATE_TLE}")
+        while True:
+            line1 = input("Please input the first line of the TLE: ")
+            if len(line1) == 69:
+                break
+            else:
+                print("The line does not have the required length of 69 characters")
+        while True:
+            line2 = input("Please input the second line of the TLE: ")
+            if len(line2) == 69:
+                break
+            else:
+                print("The line does not have the required length of 69 characters")
+        tle = line1.encode() + line2.encode()
+        q.add_pus_tc(create_action_cmd(ACS_CONTROLLER, ActionId.UPDATE_TLE, tle))
     elif op_code in OpCodes.SET_PARAMETER_SCALAR:
         q.add_log_cmd(f"{Info.SET_PARAMETER_SCALAR}")
         set_acs_ctrl_param_scalar(q)
@@ -985,11 +1012,13 @@ def handle_gyr_data_processed(pw: PrintWrapper, hk_data: bytes):
 
 def handle_gps_data_processed(pw: PrintWrapper, hk_data: bytes):
     pw.dlog("Received GPS Processed Set")
+    fmt_source = "!B"
     fmt_scalar = "!d"
     fmt_vec = "!ddd"
+    inc_len_source = struct.calcsize(fmt_source)
     inc_len_scalar = struct.calcsize(fmt_scalar)
     inc_len_vec = struct.calcsize(fmt_vec)
-    if len(hk_data) < 2 * inc_len_scalar + 2 * inc_len_vec:
+    if len(hk_data) < 2 * inc_len_scalar + 2 * inc_len_vec + inc_len_source:
         pw.dlog("Received HK set too small")
         return
     current_idx = 0
@@ -1028,12 +1057,20 @@ def handle_gps_data_processed(pw: PrintWrapper, hk_data: bytes):
         )
     ]
     current_idx += inc_len_vec
+    source = struct.unpack(
+        fmt_source, hk_data[current_idx : current_idx + inc_len_source]
+    )[0]
+    current_idx += inc_len_source
+    if GPS_COURCE_DICT.get(source) is not None:
+        pw.dlog(f"GPS Source: {GPS_COURCE_DICT[source]}")
+    else:
+        pw.dlog(f"'GPS Source (key unknown)': {source}")
     pw.dlog(f"GPS Latitude: {lat} [deg]")
     pw.dlog(f"GPS Longitude: {long} [deg]")
     pw.dlog(f"GPS Altitude: {alt} [m]")
     pw.dlog(f"GPS Position: {pos} [m]")
     pw.dlog(f"GPS Velocity: {velo} [m/s]")
-    FsfwTmTcPrinter.get_validity_buffer(hk_data[current_idx:], num_vars=5)
+    FsfwTmTcPrinter.get_validity_buffer(hk_data[current_idx:], num_vars=6)
 
 
 def handle_mekf_data(pw: PrintWrapper, hk_data: bytes):

eive_tmtc/tmtc/acs/gps.py

@@ -19,9 +19,11 @@ from tmtccmd.fsfw.tmtc_printer import FsfwTmTcPrinter
 
 _LOGGER = logging.getLogger(__name__)
 
+
 class GpsInfo:
     MAX_SATELLITES = 30
 
+
 class OpCode:
     OFF = "off"
     ON = "on"
@@ -70,7 +72,9 @@ def add_gps_cmds(defs: TmtcDefinitionWrapper):
     )
 
 
-def pack_gps_command(object_id: bytes, q: DefaultPusQueueHelper, op_code: str):
+def pack_gps_command(  # noqa: C901
+    object_id: bytes, q: DefaultPusQueueHelper, op_code: str
+):  # noqa: C901
     if op_code in OpCode.RESET_GNSS:
         # TODO: This needs to be re-implemented
         _LOGGER.warning("Reset pin handling needs to be re-implemented")
@@ -80,34 +84,52 @@ def pack_gps_command(object_id: bytes, q: DefaultPusQueueHelper, op_code: str):
             raise ValueError("invalid interval")
         q.add_log_cmd(f"GPS: {Info.ENABLE_CORE_HK}")
         cmds = create_enable_periodic_hk_command_with_interval(
-            diag=False, sid=make_sid(object_id=object_id, set_id=SetId.CORE_HK), interval_seconds=interval
+            diag=False,
+            sid=make_sid(object_id=object_id, set_id=SetId.CORE_HK),
+            interval_seconds=interval,
         )
         for cmd in cmds:
             q.add_pus_tc(cmd)
     if op_code in OpCode.DISABLE_CORE_HK:
         q.add_log_cmd(f"gps: {Info.DISABLE_CORE_HK}")
-        q.add_pus_tc(create_disable_periodic_hk_command(diag=False, sid=make_sid(object_id=object_id,
-                                                                                 set_id=SetId.CORE_HK)))
+        q.add_pus_tc(
+            create_disable_periodic_hk_command(
+                diag=False, sid=make_sid(object_id=object_id, set_id=SetId.CORE_HK)
+            )
+        )
     if op_code in OpCode.REQ_CORE_HK:
         q.add_log_cmd(f"GPS: {Info.REQ_CORE_HK}")
-        q.add_pus_tc(create_request_one_hk_command(sid=make_sid(object_id=object_id, set_id=SetId.CORE_HK)))
+        q.add_pus_tc(
+            create_request_one_hk_command(
+                sid=make_sid(object_id=object_id, set_id=SetId.CORE_HK)
+            )
+        )
     if op_code in OpCode.ENABLE_SKYVIEW_HK:
         interval = float(input("Please specify interval in floating point seconds: "))
         if interval <= 0:
             raise ValueError("invalid interval")
         q.add_log_cmd(f"GPS: {Info.ENABLE_SKYVIEW_HK}")
         cmds = create_enable_periodic_hk_command_with_interval(
-            diag=False, sid=make_sid(object_id=object_id, set_id=SetId.SKYVIEW_HK), interval_seconds=interval
+            diag=False,
+            sid=make_sid(object_id=object_id, set_id=SetId.SKYVIEW_HK),
+            interval_seconds=interval,
         )
         for cmd in cmds:
             q.add_pus_tc(cmd)
     if op_code in OpCode.DISABLE_SKYVIEW_HK:
         q.add_log_cmd(f"gps: {Info.DISABLE_SKYVIEW_HK}")
-        q.add_pus_tc(create_disable_periodic_hk_command(diag=False, sid=make_sid(object_id=object_id,
-                                                                                 set_id=SetId.SKYVIEW_HK)))
+        q.add_pus_tc(
+            create_disable_periodic_hk_command(
+                diag=False, sid=make_sid(object_id=object_id, set_id=SetId.SKYVIEW_HK)
+            )
+        )
     if op_code in OpCode.REQ_SKYVIEW_HK:
         q.add_log_cmd(f"GPS: {Info.REQ_SKYVIEW_HK}")
-        q.add_pus_tc(create_request_one_hk_command(sid=make_sid(object_id=object_id, set_id=SetId.SKYVIEW_HK)))
+        q.add_pus_tc(
+            create_request_one_hk_command(
+                sid=make_sid(object_id=object_id, set_id=SetId.SKYVIEW_HK)
+            )
+        )
     if op_code in OpCode.ON:
         q.add_log_cmd(f"GPS: {Info.ON}")
         q.add_pus_tc(create_mode_command(object_id, Mode.ON, 0))
@@ -131,7 +153,7 @@ def handle_gps_data(
 
 
 def handle_core_data(pw: PrintWrapper, hk_data: bytes):
-    if len(hk_data) < 4*8+4+2+8:
+    if len(hk_data) < 4 * 8 + 4 + 2 + 8:
         pw.dlog(
             f"GPS Core dataset with size {len(hk_data)} does not have expected size"
             f" of {4*8+4+2+8} bytes"
@@ -177,7 +199,7 @@ def handle_core_data(pw: PrintWrapper, hk_data: bytes):
 
 
 def handle_skyview_data(pw: PrintWrapper, hk_data: bytes):
-    data_length = 8+GpsInfo.MAX_SATELLITES*(8+3*2+1)
+    data_length = 8 + GpsInfo.MAX_SATELLITES * (8 + 3 * 2 + 1)
     if len(hk_data) < data_length:
         pw.dlog(
             f"GPS Skyview dataset with size {len(hk_data)} does not have expected size"
@@ -193,24 +215,46 @@ def handle_skyview_data(pw: PrintWrapper, hk_data: bytes):
     inc_len_int16 = struct.calcsize(fmt_str_int16)
     inc_len_double = struct.calcsize(fmt_str_double)
     inc_len_uint8 = struct.calcsize(fmt_str_uint8)
-    unix = struct.unpack(fmt_str_unix, hk_data[current_idx: current_idx + inc_len_unix])
+    unix = struct.unpack(
+        fmt_str_unix, hk_data[current_idx : current_idx + inc_len_unix]
+    )
     current_idx += inc_len_unix
-    prn_id = struct.unpack(fmt_str_int16, hk_data[current_idx: current_idx + inc_len_int16])
+    prn_id = struct.unpack(
+        fmt_str_int16, hk_data[current_idx : current_idx + inc_len_int16]
+    )
     current_idx += inc_len_int16
-    azimuth = struct.unpack(fmt_str_int16, hk_data[current_idx: current_idx + inc_len_int16])
+    azimuth = struct.unpack(
+        fmt_str_int16, hk_data[current_idx : current_idx + inc_len_int16]
+    )
     current_idx += inc_len_int16
-    elevation = struct.unpack(fmt_str_int16, hk_data[current_idx: current_idx + inc_len_int16])
+    elevation = struct.unpack(
+        fmt_str_int16, hk_data[current_idx : current_idx + inc_len_int16]
+    )
     current_idx += inc_len_int16
-    signal_to_noise = struct.unpack(fmt_str_double, hk_data[current_idx: current_idx + inc_len_double])
+    signal_to_noise = struct.unpack(
+        fmt_str_double, hk_data[current_idx : current_idx + inc_len_double]
+    )
     current_idx += inc_len_double
-    used = struct.unpack(fmt_str_uint8, hk_data[current_idx: current_idx + inc_len_uint8])
+    used = struct.unpack(
+        fmt_str_uint8, hk_data[current_idx : current_idx + inc_len_uint8]
+    )
     current_idx += inc_len_uint8
     pw.dlog(f"Skyview Time: {unix} unix-sec")
-    pw.dlog("{:<8} {:<8} {:<8} {:<8} {:<8}".format('PRN_ID', 'AZ [°]', 'EL [°]', 'S2N [dBW]', 'USED'))
+    pw.dlog(
+        "{:<8} {:<8} {:<8} {:<8} {:<8}".format(
+            "PRN_ID", "AZ [°]", "EL [°]", "S2N [dBW]", "USED"
+        )
+    )
     for idx in range(GpsInfo.MAX_SATELLITES):
-        pw.dlog("{:<8} {:<8} {:<8} {:<8} {:<8}".format(prn_id[idx], azimuth[idx], elevation[idx], signal_to_noise[idx],
-                                                       used[idx]))
+        pw.dlog(
+            "{:<8} {:<8} {:<8} {:<8} {:<8}".format(
+                prn_id[idx],
+                azimuth[idx],
+                elevation[idx],
+                signal_to_noise[idx],
+                used[idx],
+            )
+        )
     FsfwTmTcPrinter.get_validity_buffer(
         validity_buffer=hk_data[current_idx:], num_vars=6
     )
-

eive_tmtc/tmtc/payload/ploc_supervisor.py

@@ -722,10 +722,42 @@ def get_event_buffer_path() -> str:
     return file
 
 
+class SocState(enum.IntEnum):
+    OFF = 0
+    BOOTING = 1
+    OPERATIONAL = 2
+    SHUTDOWN = 3
+
+
 def handle_supv_hk_data(set_id: int, hk_data: bytes, pw: PrintWrapper):
     current_idx = 0
     if set_id == SetIds.HK_REPORT:
-        pass
+        fmt_str = "!IIIQIIIIIBBBB"
+        inc_len = struct.calcsize(fmt_str)
+        (
+            temp_ps,
+            temp_pl,
+            temp_sup,
+            uptime,
+            cpu_load,
+            avail_heap,
+            num_tcs,
+            num_tms,
+            soc_state,
+            nvm_0_1_state,
+            nvm_3_state,
+            mission_io_state,
+            fmc_state,
+        ) = struct.unpack(fmt_str, hk_data[:inc_len])
+        pw.dlog(f"Temp PS {temp_ps} C | Temp PL {temp_pl} C | Temp SUP {temp_sup} C")
+        pw.dlog(f"Uptime {uptime} | CPU Load {cpu_load} | Avail Heap {avail_heap}")
+        pw.dlog(f"Number TCs {num_tcs} | Number TMs {num_tms}")
+        pw.dlog(f"SOC state {SocState(soc_state)}")
+        pw.dlog(f"NVM 01 State {nvm_0_1_state}")
+        pw.dlog(f"NVM 3 State {nvm_3_state}")
+        pw.dlog(f"Mission IO state {mission_io_state}")
+        pw.dlog(f"FMC state {fmc_state}")
+        pw.dlog(FsfwTmTcPrinter.get_validity_buffer(hk_data[inc_len:], 13))
     elif set_id == SetIds.BOOT_STATUS_REPORT:
         fmt_str = "!BBIIBBBBBB"
         inc_len = struct.calcsize(fmt_str)

eive_tmtc/tmtc/payload/subsystem.py

@@ -12,7 +12,7 @@ from tmtccmd.tc.decorator import ServiceProviderParams
 from tmtccmd.tc.pus_200_fsfw_mode import Subservice as ModeSubservice
 
 
-class ModeId:
+class ModeId(enum.IntEnum):
     OFF = 0
     SUPV_ONLY = 10
     MPSOC_STREAM = 11

eive_tmtc/tmtc/power/plpcdu.py

@@ -85,6 +85,40 @@ class NormalSubmodesMask(enum.IntEnum):
     HPA_ON = 5
 
 
+class SubmodeForNormalMode(enum.IntEnum):
+    NONE = 0
+    SSR_ON = 1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON
+    DRO_ON = 1 << NormalSubmodesMask.DRO_ON | (
+        1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON
+    )
+    X8_ON = (
+        1 << NormalSubmodesMask.DRO_ON
+        | (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
+        | (1 << NormalSubmodesMask.X8_ON)
+    )
+    TX_ON = (
+        1 << NormalSubmodesMask.DRO_ON
+        | (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
+        | (1 << NormalSubmodesMask.X8_ON)
+        | (1 << NormalSubmodesMask.TX_ON)
+    )
+    MPA_ON = (
+        1 << NormalSubmodesMask.DRO_ON
+        | (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
+        | (1 << NormalSubmodesMask.X8_ON)
+        | (1 << NormalSubmodesMask.TX_ON)
+        | (1 << NormalSubmodesMask.MPA_ON)
+    )
+    HPA_ON = (
+        1 << NormalSubmodesMask.DRO_ON
+        | (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
+        | (1 << NormalSubmodesMask.X8_ON)
+        | (1 << NormalSubmodesMask.TX_ON)
+        | (1 << NormalSubmodesMask.MPA_ON)
+        | (1 << NormalSubmodesMask.HPA_ON)
+    )
+
+
 class ParamIds(enum.IntEnum):
     NEG_V_LOWER_BOUND = 0
     NEG_V_UPPER_BOUND = 1
@@ -383,41 +417,17 @@ def request_wait_time() -> Optional[float]:
 
 def submode_mask_to_submode(on_tgt: NormalSubmodesMask) -> int:
     if on_tgt == NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON:
-        return 1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON
+        return SubmodeForNormalMode.SSR_ON
     if on_tgt == NormalSubmodesMask.DRO_ON:
-        return 1 << NormalSubmodesMask.DRO_ON | (
-            1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON
-        )
+        return SubmodeForNormalMode.DRO_ON
     if on_tgt == NormalSubmodesMask.X8_ON:
-        return (
-            1 << NormalSubmodesMask.DRO_ON
-            | (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
-            | (1 << NormalSubmodesMask.X8_ON)
-        )
+        return SubmodeForNormalMode.X8_ON
     if on_tgt == NormalSubmodesMask.TX_ON:
-        return (
-            1 << NormalSubmodesMask.DRO_ON
-            | (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
-            | (1 << NormalSubmodesMask.X8_ON)
-            | (1 << NormalSubmodesMask.TX_ON)
-        )
+        return SubmodeForNormalMode.TX_ON
     if on_tgt == NormalSubmodesMask.MPA_ON:
-        return (
-            1 << NormalSubmodesMask.DRO_ON
-            | (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
-            | (1 << NormalSubmodesMask.X8_ON)
-            | (1 << NormalSubmodesMask.TX_ON)
-            | (1 << NormalSubmodesMask.MPA_ON)
-        )
+        return SubmodeForNormalMode.MPA_ON
     if on_tgt == NormalSubmodesMask.HPA_ON:
-        return (
-            1 << NormalSubmodesMask.DRO_ON
-            | (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
-            | (1 << NormalSubmodesMask.X8_ON)
-            | (1 << NormalSubmodesMask.TX_ON)
-            | (1 << NormalSubmodesMask.MPA_ON)
-            | (1 << NormalSubmodesMask.HPA_ON)
-        )
+        return SubmodeForNormalMode.HPA_ON
 
 
 def pack_wait_time_cmd(q: DefaultPusQueueHelper, param_id: int, print_str: str):