changelog bump

Reviewed-on: #138
Reviewed-by: Robin Müller <muellerr@irs.uni-stuttgart.de>

.flake8

@@ -0,0 +1,17 @@
+[flake8]
+max-line-length = 100
+ignore = D203, W503
+per-file-ignores =
+	*/__init__.py: F401
+exclude =
+	.git,
+	__pycache__,
+	docs/conf.py,
+	old,
+	build,
+	dist,
+	venv
+max-complexity = 10
+extend-ignore =
+    # See https://github.com/PyCQA/pycodestyle/issues/373
+    E203,

CHANGELOG.md

@@ -10,6 +10,29 @@ list yields a list of all related PRs for each release.
 
 # [unreleased]
 
+# [v2.15.1] 2023-02-23
+
+- Actually use `tmtccmd` 4.1 in requirements.
+- Remove `setup.cfg` completely
+
+# [v2.15.0] 2023-02-23
+
+tmtccmd version v4.1.1
+
+## Changed
+
+- Moved to `pyproject.toml` package file
+
+## Fixed
+
+- Correction in `tmtccmd` dependency, added missing function
+
+# [v2.14.0] 2023-02-22
+
+## Changed
+
+- Generated CSV files for PDEC handler
+
 # [v2.13.0] 2023-02-21
 
 tmtccmd version 4.0.0

eive_tmtc/__init__.py

@@ -1,12 +1,12 @@
-__version__ = "2.13.0"
+__version__ = "2.15.1"
 
 import logging
 from pathlib import Path
 
 SW_NAME = "eive-tmtc"
 VERSION_MAJOR = 2
-VERSION_MINOR = 13
-VERSION_REVISION = 0
+VERSION_MINOR = 15
+VERSION_REVISION = 1
 
 EIVE_TMTC_ROOT = Path(__file__).parent
 PACKAGE_ROOT = EIVE_TMTC_ROOT.parent

eive_tmtc/config/definitions.py

@@ -36,6 +36,7 @@ class CustomServiceList(str, enum.Enum):
     POWER = "power"
     ACU = "acu"
     ACS = "acs"
+    GYRO = "gyro"
     COM_SS = "com"
     BPX_BATTERY = "bpx"
     HEATER = "heater"

eive_tmtc/config/events.csv

@@ -145,8 +145,9 @@ Event ID (dec); Event ID (hex); Name; Severity; Description; File Path
 12404;0x3074;BIT_LOCK_PDEC;INFO;Bit lock detected (data valid);linux/ipcore/PdecHandler.h
 12405;0x3075;LOST_CARRIER_LOCK_PDEC;INFO;Lost carrier lock;linux/ipcore/PdecHandler.h
 12406;0x3076;LOST_BIT_LOCK_PDEC;INFO;Lost bit lock;linux/ipcore/PdecHandler.h
-12407;0x3077;POLL_SYSCALL_ERROR_PDEC;MEDIUM;No description;linux/ipcore/PdecHandler.h
-12408;0x3078;WRITE_SYSCALL_ERROR_PDEC;MEDIUM;No description;linux/ipcore/PdecHandler.h
+12407;0x3077;TOO_MANY_IRQS;MEDIUM;Too many IRQs over the time window of one second. P1: Allowed TCs;linux/ipcore/PdecHandler.h
+12408;0x3078;POLL_SYSCALL_ERROR_PDEC;MEDIUM;No description;linux/ipcore/PdecHandler.h
+12409;0x3079;WRITE_SYSCALL_ERROR_PDEC;MEDIUM;No description;linux/ipcore/PdecHandler.h
 12500;0x30d4;IMAGE_UPLOAD_FAILED;LOW;Image upload failed;linux/devices/startracker/StrHelper.h
 12501;0x30d5;IMAGE_DOWNLOAD_FAILED;LOW;Image download failed;linux/devices/startracker/StrHelper.h
 12502;0x30d6;IMAGE_UPLOAD_SUCCESSFUL;LOW;Uploading image to star tracker was successfulop;linux/devices/startracker/StrHelper.h

eive_tmtc/pus_tc/procedure_packer.py

@@ -3,6 +3,7 @@
 import logging
 from typing import cast
 
+from eive_tmtc.tmtc.acs.gyros import handle_gyr_cmd
 from eive_tmtc.tmtc.power.power import pack_power_commands
 from eive_tmtc.tmtc.tcs.rtd import pack_rtd_commands
 from eive_tmtc.tmtc.payload.scex import pack_scex_cmds
@@ -177,6 +178,8 @@ def handle_default_procedure(
         return pack_syrlinks_command(
             object_id=object_id, q=queue_helper, op_code=op_code
         )
+    if service == CustomServiceList.GYRO.value:
+        return handle_gyr_cmd(q=queue_helper, op_code=op_code)
     if service == CustomServiceList.PROCEDURE.value:
         return pack_proc_commands(q=queue_helper, op_code=op_code)
     if service == CustomServiceList.PL_PCDU.value:

eive_tmtc/tmtc/acs/__init__.py

@@ -0,0 +1 @@
+from .gyros import add_gyr_cmd_defs

eive_tmtc/tmtc/acs/gyros.py

@@ -1,13 +1,34 @@
 import enum
+import logging
 import struct
 
-import eive_tmtc.config.object_ids as obj_ids
+from tmtccmd.tc import DefaultPusQueueHelper
 
+import eive_tmtc.config.object_ids as obj_ids
+from tmtccmd.tc.pus_3_fsfw_hk import create_request_one_hk_command, make_sid
+from tmtccmd.config.tmtc import (
+    tmtc_definitions_provider,
+    OpCodeEntry,
+    TmtcDefinitionWrapper,
+)
+from eive_tmtc.config.object_ids import (
+    GYRO_0_ADIS_HANDLER_ID,
+    GYRO_1_L3G_HANDLER_ID,
+    GYRO_2_ADIS_HANDLER_ID,
+    GYRO_3_L3G_HANDLER_ID,
+)
+from eive_tmtc.config.definitions import CustomServiceList
 from eive_tmtc.pus_tm.defs import PrintWrapper
+
 from tmtccmd.util import ObjectIdU32
 from tmtccmd.util.tmtc_printer import FsfwTmTcPrinter
 
 
+class OpCode:
+    CORE_HK = "core_hk"
+    CFG_HK = "cfg_hk"
+
+
 class AdisGyroSetId(enum.IntEnum):
     CORE_HK = 0
     CFG_HK = 1
@@ -17,6 +38,50 @@ class L3gGyroSetId(enum.IntEnum):
     CORE_HK = 0
 
 
+class GyrSel(enum.IntEnum):
+    GYR_0_ADIS = 0
+    GYR_1_L3G = 1
+    GYR_2_ADIS = 2
+    GYR_3_L3G = 3
+
+
+GYR_SEL_DICT = {
+    GyrSel.GYR_0_ADIS: ("GYRO_0_ADIS", GYRO_0_ADIS_HANDLER_ID),
+    GyrSel.GYR_1_L3G: ("GYRO_1_L3G", GYRO_1_L3G_HANDLER_ID),
+    GyrSel.GYR_2_ADIS: ("GYRO_2_ADIS", GYRO_2_ADIS_HANDLER_ID),
+    GyrSel.GYR_3_L3G: ("GYRO_3_L3G", GYRO_3_L3G_HANDLER_ID),
+}
+
+
+def handle_gyr_cmd(q: DefaultPusQueueHelper, op_code: str):
+    print("Please select the Gyro Device")
+    for (k, v) in GYR_SEL_DICT.items():
+        print(f"{k}: {v[0]}")
+    sel_idx = int(input("Select gyro device by index: "))
+    gyr_info = GYR_SEL_DICT[GyrSel(sel_idx)]
+    gyr_obj_id = gyr_info[1]
+    is_adis = False
+    if sel_idx == GyrSel.GYR_0_ADIS or sel_idx == GyrSel.GYR_2_ADIS:
+        is_adis = True
+        core_hk_id = AdisGyroSetId.CORE_HK
+    else:
+        core_hk_id = L3gGyroSetId.CORE_HK
+    if op_code == OpCode.CORE_HK:
+        q.add_log_cmd(f"Gyro  {gyr_info[0]} Core HK")
+        q.add_pus_tc(create_request_one_hk_command(make_sid(gyr_obj_id, core_hk_id)))
+    elif op_code == OpCode.CFG_HK:
+        if not is_adis:
+            raise ValueError("No config HK for L3 device")
+        q.add_log_cmd(f"Gyro {gyr_info[0]} CFG HK")
+        q.add_pus_tc(
+            create_request_one_hk_command(make_sid(gyr_obj_id, AdisGyroSetId.CFG_HK))
+        )
+    else:
+        logging.getLogger(__name__).warning(
+            f"invalid op code {op_code} for gyro command"
+        )
+
+
 def handle_gyros_hk_data(
     object_id: ObjectIdU32, printer: FsfwTmTcPrinter, set_id: int, hk_data: bytes
 ):
@@ -43,24 +108,36 @@ def handle_adis_gyro_hk(
         pw = PrintWrapper(printer)
         fmt_str = "!ddddddf"
         inc_len = struct.calcsize(fmt_str)
-        (angVelocX, angVelocY, angVelocZ, accelX, accelY, accelZ, temp) = struct.unpack(
-            fmt_str, hk_data[0 : 0 + inc_len]
-        )
+        (
+            ang_veloc_x,
+            ang_veloc_y,
+            ang_veloc_z,
+            accel_x,
+            accel_y,
+            accel_z,
+            temp,
+        ) = struct.unpack(fmt_str, hk_data[0 : 0 + inc_len])
         pw.dlog(f"Received ADIS1650X Gyro HK data from object {object_id}")
         pw.dlog(
-            f"Angular Velocities (degrees per second): X {angVelocX} | "
-            f"Y {angVelocY} | Z {angVelocZ}"
+            f"Angular Velocities (degrees per second): X {ang_veloc_x} | "
+            f"Y {ang_veloc_y} | Z {ang_veloc_z}"
         )
-        pw.dlog(f"Acceleration (m/s^2): X {accelX} | Y {accelY} | Z {accelZ}")
+        pw.dlog(f"Acceleration (m/s^2): X {accel_x} | Y {accel_y} | Z {accel_z}")
         pw.dlog(f"Temperature {temp} C")
     if set_id == AdisGyroSetId.CFG_HK:
         pw = PrintWrapper(printer)
-        fmt_str = "!HBHH"
+        fmt_str = "!HBHHH"
         inc_len = struct.calcsize(fmt_str)
-        (diag_stat_reg, filter_setting, msc_ctrl_reg, dec_rate_reg) = struct.unpack(
-            fmt_str, hk_data[0 : 0 + inc_len]
-        )
+        print(len(hk_data))
+        (
+            diag_stat_reg,
+            filter_setting,
+            range_mdl,
+            msc_ctrl_reg,
+            dec_rate_reg,
+        ) = struct.unpack(fmt_str, hk_data[0 : 0 + inc_len])
         pw.dlog(f"Diagnostic Status Register {diag_stat_reg:#018b}")
+        pw.dlog(f"Range MDL {range_mdl}")
         pw.dlog(f"Filter Settings {filter_setting:#010b}")
         pw.dlog(f"Miscellaneous Control Register {msc_ctrl_reg:#018b}")
         pw.dlog(f"Decimation Rate {dec_rate_reg:#06x}")
@@ -82,3 +159,11 @@ def handle_l3g_gyro_hk(
             f"Y {angVelocY} | Z {angVelocZ}"
         )
         pw.dlog(f"Temperature {temp} °C")
+
+
+@tmtc_definitions_provider
+def add_gyr_cmd_defs(defs: TmtcDefinitionWrapper):
+    oce = OpCodeEntry()
+    oce.add(keys=OpCode.CORE_HK, info="Request Core HK")
+    oce.add(keys=OpCode.CFG_HK, info="Request CFG HK")
+    defs.add_service(CustomServiceList.GYRO, info="Gyro", op_code_entry=oce)

eive_tmtc/tmtc/acs/mgms.py

@@ -57,7 +57,7 @@ def handle_mgm_rm3100_hk_data(
         fmt_str = f"!fff"
         inc_len = struct.calcsize(fmt_str)
         (field_x, field_y, field_z) = struct.unpack(fmt_str, hk_data[0 : 0 + inc_len])
-        pw.dlog(f"Received MGM LIS3 from object {object_id}")
+        pw.dlog(f"Received MGM RM3100 from object {object_id}")
         pw.dlog(
             f"Field strengths in micro Tesla X {field_x} | Y {field_y} | Z {field_z}"
         )

eive_tmtc/tmtc/com/subsystem.py

@@ -21,9 +21,12 @@ from tmtccmd.tc.pus_20_fsfw_param import (
     pack_scalar_u8_parameter_app_data,
 )
 
+from tmtccmd.pus.s20_fsfw_param import create_scalar_u32_parameter
+
 
 class ParameterId(enum.IntEnum):
     DATARATE = 0
+    TRANSMITTER_TIMEOUT = 1
 
 
 class Submode(enum.IntEnum):
@@ -42,6 +45,7 @@ class OpCode:
     TX_AND_RX_CARRIER_WAVE = "rx_and_tx_carrier_wave"
     UPDATE_DEFAULT_DATARATE_LOW = "update_default_rate_low"
     UPDATE_DEFAULT_DATARATE_HIGH = "update_default_rate_high"
+    CHANGE_TRANSMITTER_TIMEOUT = "change_transmitter_timeout"
     READ_MODE = "read_mode"
     ANNOUNCE_MODE = "announce_mode"
     ANNOUNCE_MODE_RECURSIVE = "announce_mode_recursive"
@@ -55,6 +59,7 @@ class Info:
     TX_AND_RX_CARRIER_WAVE = "Syrlinks with TX carrier wave"
     UPDATE_DEFAULT_DATARATE_LOW = "Configure default low datarate (BPSK modulation)"
     UPDATE_DEFAULT_DATARATE_HIGH = "Configure default high datarate (0QPSK modulation)"
+    CHANGE_TRANSMITTER_TIMEOUT = "Changes the transmitter timeout"
     READ_MODE = "Read Mode"
     ANNOUNCE_MODE = "Announce Mode"
     ANNOUNCE_MODE_RECURSIVE = "Announce mode recursively"
@@ -112,6 +117,19 @@ def build_com_subsystem_cmd(p: ServiceProviderParams):
         q.add_pus_tc(
             create_mode_command(COM_SUBSYSTEM_ID, Submode.RX_AND_TX_CARRIER_WAVE, 0)
         )
+    elif o == OpCode.CHANGE_TRANSMITTER_TIMEOUT:
+        timeout = int(input("Specify timeout to set [ms]: "))
+        q.add_log_cmd(Info.CHANGE_TRANSMITTER_TIMEOUT)
+        q.add_pus_tc(
+            create_load_param_cmd(
+                create_scalar_u32_parameter(
+                    COM_SUBSYSTEM_ID,
+                    0,
+                    ParameterId.TRANSMITTER_TIMEOUT,
+                    timeout,
+                ).pack()
+            )
+        )
     elif o == OpCode.READ_MODE:
         q.add_log_cmd(Info.READ_MODE)
         q.add_pus_tc(create_read_mode_command(COM_SUBSYSTEM_ID))
@@ -132,6 +150,7 @@ def add_com_subsystem_cmds(defs: TmtcDefinitionWrapper):
     oce.add(OpCode.TX_AND_RX_DEF_RATE, Info.TX_AND_RX_DEF_DATARATE)
     oce.add(OpCode.UPDATE_DEFAULT_DATARATE_LOW, Info.UPDATE_DEFAULT_DATARATE_LOW)
     oce.add(OpCode.UPDATE_DEFAULT_DATARATE_HIGH, Info.UPDATE_DEFAULT_DATARATE_HIGH)
+    oce.add(OpCode.CHANGE_TRANSMITTER_TIMEOUT, Info.CHANGE_TRANSMITTER_TIMEOUT)
     oce.add(OpCode.READ_MODE, Info.READ_MODE)
     oce.add(OpCode.ANNOUNCE_MODE, Info.ANNOUNCE_MODE)
     oce.add(OpCode.ANNOUNCE_MODE_RECURSIVE, Info.ANNOUNCE_MODE_RECURSIVE)

eive_tmtc/tmtc/tcs/tm.py

@@ -61,7 +61,9 @@ def handle_thermal_controller_hk_data(
         pw = PrintWrapper(printer)
         pw.dlog("Received device temperature data")
         fmt_str = "!fhhhhiiiifffhffffffffffffff"
+        fmt_len = struct.calcsize(fmt_str)
         tm_data = struct.unpack(fmt_str, hk_data[:98])
+        valid_list = validity_buffer_list(hk_data[fmt_len:], 25)
         parsed_data = {
             "Q7S_TEMPERATURE": tm_data[0],
             "BATTERY_TEMPERATURE_1": tm_data[1],
@@ -76,9 +78,7 @@ def handle_thermal_controller_hk_data(
             "SYRLINKS_POWER_AMPLIFIER_TEMPERATURE": tm_data[10],
             "SYRLINKS_BASEBAND_BOARD_TEMPERATURE": tm_data[11],
             "MGT_TEMPERATURE": tm_data[12],
-            "ACU_TEMPERATURE_1": tm_data[13],
-            "ACU_TEMPERATURE_2": tm_data[14],
-            "ACU_TEMPERATURE_3": tm_data[15],
+            "ACU_TEMPERATURES": (tm_data[13], tm_data[14], tm_data[15]),
             "PDU1_TEMPERATURE": tm_data[16],
             "PDU2_TEMPERATURE": tm_data[17],
             "P60DOCK_TEMPERATURE_1": tm_data[18],
@@ -87,18 +87,19 @@ def handle_thermal_controller_hk_data(
             "GYRO_1_TEMPERATURE": tm_data[21],
             "GYRO_2_TEMPERATURE": tm_data[22],
             "GYRO_3_TEMPERATURE": tm_data[23],
-            "MGM_0_TEMPERATURE": tm_data[24],
-            "MGM_1_TEMPERATURE": tm_data[25],
+            "MGM_0_LIS3_TEMPERATURE": tm_data[24],
+            "MGM_2_LIS3_TEMPERATURE": tm_data[25],
             "ADC_PL_PCDU_TEMPERATURE": tm_data[26],
         }
-        printer.file_logger.info(str(parsed_data))
-        pp = pprint.PrettyPrinter(depth=4)
-        pp.pprint(parsed_data)
+        for idx, (k, v) in enumerate(parsed_data.items()):
+            print(f"{str(k).ljust(30)}: Valid: {valid_list[idx]}, Value: {v}")
     elif set_id == CtrlSetId.SUS_TEMP_SENSORS:
         pw = PrintWrapper(printer)
         pw.dlog("Received SUS temperature data")
-        fmt_str = "!ffffffffffffffffff"
-        tm_data = struct.unpack(fmt_str, hk_data[: 4 * 18])
+        fmt_str = "!ffffffffffff"
+        fmt_len = struct.calcsize(fmt_str)
+        tm_data = struct.unpack(fmt_str, hk_data[: 12 * 4])
+        valid_list = validity_buffer_list(hk_data[fmt_len:], 12)
         parsed_data = {
             "SUS_0": tm_data[0],
             "SUS_1": tm_data[1],
@@ -113,9 +114,8 @@ def handle_thermal_controller_hk_data(
             "SUS_10": tm_data[10],
             "SUS_11": tm_data[11],
         }
-        printer.file_logger.info(str(parsed_data))
-        pp = pprint.PrettyPrinter(depth=4)
-        pp.pprint(parsed_data)
+        for idx, (k, v) in enumerate(parsed_data.items()):
+            print(f"{str(k).ljust(30)}: Valid: {valid_list[idx]}, Value: {v}")
     elif set_id == CtrlSetId.HEATER_INFO:
         print("Heater Switch States")
         for i in range(8):

pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "eive-tmtc"
+description = "TMTC Commander EIVE"
+readme = "README.md"
+dynamic = ["version"]
+requires-python = ">=3.10"
+license = {text = "Apache-2.0"}
+authors = [
+    {name = "Robin Mueller", email = "muellerr@irs.uni-stuttgart.de"},
+    {name = "Jakob Meier", email = "meierj@irs.uni-stuttgart.de"},
+]
+keywords = ["eive", "space", "communication", "commanding"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Operating System :: POSIX",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Topic :: Communications",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Scientific/Engineering"
+]
+dependencies = [
+	"tmtccmd ~= 4.1",
+	"python-dateutil ~= 2.8",
+	# tmtccmd @ git+https://github.com/robamu-org/tmtccmd@<gitRev>#egg=tmtccmd
+]
+
+[project.urls]
+"Homepage" = "https://egit.irs.uni-stuttgart.de/eive/eive-tmtc"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = {attr = "eive_tmtc.__version__"}
+
+# Auto-Discovery is problematic for some reason, so use custom-discovery
+[tool.setuptools.packages]
+find = {}

setup.cfg

@@ -1,54 +0,0 @@
-[metadata]
-name = eive-tmtc
-description = TMTC Commander EIVE
-version = attr: eive_tmtc.__version__
-long_description = file: README.md
-long_description_content_type = text/markdown
-license = Apache-2.0
-author = Robin Mueller, Jakob Meier
-author_email = muellerr@irs.uni-stuttgart.de
-platform = any
-
-url = https://egit.irs.uni-stuttgart.de/eive/eive-tmtc
-classifiers =
-	Development Status :: 5 - Production/Stable
-	Intended Audience :: Developers
-	License :: OSI Approved :: Apache Software License
-	Natural Language :: English
-	Operating System :: POSIX
-	Operating System :: Microsoft :: Windows
-	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3.8
-	Programming Language :: Python :: 3.9
-	Topic :: Communications
-	Topic :: Software Development :: Libraries
-	Topic :: Software Development :: Libraries :: Python Modules
-	Topic :: Scientific/Engineering
-
-[options]
-install_requires =
-	tmtccmd ~= 4.0
-	python-dateutil ~= 2.8
-	# tmtccmd @ git+https://github.com/robamu-org/tmtccmd@<gitRev>#egg=tmtccmd
-packages = find:
-python_requires = >=3.10
-include_package_data = True
-
-[options.extras_require]
-mib =
-
-[flake8]
-max-line-length = 100
-ignore = D203, W503
-exclude =
-	.git,
-	__pycache__,
-	docs/conf.py,
-	old,
-	build,
-	dist,
-	venv
-max-complexity = 10
-extend-ignore =
-    # See https://github.com/PyCQA/pycodestyle/issues/373
-    E203,