Merge pull request 'Update to v1.6.1' (#5) from develop into master

Reviewed-on: eive/eive_tmtc#5

.gitignore

@@ -4,4 +4,12 @@ log
 .idea/*
 !.idea/runConfigurations
 
-*.json
+*.json
+
+/Lib
+/Scripts
+/pyvenv.cfg
+/bin
+/lib
+/lib64
+/share

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "tmtc_core"]
-	path = tmtc_core
-	url = https://git.ksat-stuttgart.de/irs/eive/tmtc_core.git
+[submodule "tmtccmd"]
+	path = tmtccmd
+	url = https://github.com/rmspacefish/tmtccmd.git

.idea/runConfigurations/tmtcc_Listener_Mode_UDP.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="tmtcc Listener Mode UDP" type="PythonConfigurationType" factoryName="Python" folderName="UDP">
+  <configuration default="false" name="tmtcc Listener Mode UDP" type="PythonConfigurationType" factoryName="Python" folderName="PUS">
     <module name="tmtc" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtc_client_cli.py" />
-    <option name="PARAMETERS" value="-m 1 -c 2 --hk" />
+    <option name="PARAMETERS" value="-m listener --hk" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="false" />
     <option name="MODULE_MODE" value="false" />

.idea/runConfigurations/tmtcc_Service_17_UDP.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="tmtcc Service 17 UDP" type="PythonConfigurationType" factoryName="Python" folderName="UDP">
+  <configuration default="false" name="tmtcc Service 17 UDP" type="PythonConfigurationType" factoryName="Python" folderName="PUS">
     <module name="tmtc" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtc_client_cli.py" />
-    <option name="PARAMETERS" value="-m 3 -c 2 -s 17 -t 3" />
+    <option name="PARAMETERS" value="-s 17 -o 0 -t 3" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="true" />
     <option name="MODULE_MODE" value="false" />

.idea/runConfigurations/tmtcc_Service_200_UDP.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="tmtcc Service 200 UDP" type="PythonConfigurationType" factoryName="Python" folderName="UDP">
+  <configuration default="false" name="tmtcc Service 200 UDP" type="PythonConfigurationType" factoryName="Python" folderName="PUS">
     <module name="tmtc" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtc_client_cli.py" />
-    <option name="PARAMETERS" value="-m 3 -c 2 -s 200 -t 4" />
+    <option name="PARAMETERS" value="-s 200 -t 4" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="true" />
     <option name="MODULE_MODE" value="false" />

.idea/runConfigurations/tmtcc_Service_2_UDP.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="tmtcc Service 2 UDP" type="PythonConfigurationType" factoryName="Python" folderName="UDP">
+  <configuration default="false" name="tmtcc Service 2 UDP" type="PythonConfigurationType" factoryName="Python" folderName="PUS">
     <module name="tmtc" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtc_client_cli.py" />
-    <option name="PARAMETERS" value="-m 3 -c 2 -s 2 -t 4" />
+    <option name="PARAMETERS" value="-s 2 -t 4" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="false" />
     <option name="MODULE_MODE" value="false" />

.idea/runConfigurations/tmtcc_Service_3_UDP.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="tmtcc Service 3 UDP" type="PythonConfigurationType" factoryName="Python" folderName="UDP">
+  <configuration default="false" name="tmtcc Service 3 UDP" type="PythonConfigurationType" factoryName="Python" folderName="PUS">
     <module name="tmtc" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtc_client_cli.py" />
-    <option name="PARAMETERS" value="-m 3 -c 2 -s 3 -p --hk" />
+    <option name="PARAMETERS" value="-s 3 -p --hk" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="true" />
     <option name="MODULE_MODE" value="false" />

.idea/runConfigurations/tmtcc_Service_8_UDP.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="tmtcc Service 8 UDP" type="PythonConfigurationType" factoryName="Python" folderName="UDP">
+  <configuration default="false" name="tmtcc Service 8 UDP" type="PythonConfigurationType" factoryName="Python" folderName="PUS">
     <module name="tmtc" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtc_client_cli.py" />
-    <option name="PARAMETERS" value="-m 3 -c 2 -s 8 -t 8" />
+    <option name="PARAMETERS" value="-s 8 -t 8" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="true" />
     <option name="MODULE_MODE" value="false" />

.idea/runConfigurations/tmtcc_Single_Command_UDP.xml

@@ -1,24 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="tmtcc Single Command UDP" type="PythonConfigurationType" factoryName="Python" folderName="UDP">
-    <module name="tmtc" />
-    <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="PARENT_ENVS" value="true" />
-    <envs>
-      <env name="PYTHONUNBUFFERED" value="1" />
-    </envs>
-    <option name="SDK_HOME" value="" />
-    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
-    <option name="IS_MODULE_SDK" value="true" />
-    <option name="ADD_CONTENT_ROOTS" value="true" />
-    <option name="ADD_SOURCE_ROOTS" value="true" />
-    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
-    <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtc_core/tmtcc_runner.py" />
-    <option name="PARAMETERS" value="-m 2 -c 2 --boardIP=127.0.0.1" />
-    <option name="SHOW_COMMAND_LINE" value="false" />
-    <option name="EMULATE_TERMINAL" value="false" />
-    <option name="MODULE_MODE" value="false" />
-    <option name="REDIRECT_INPUT" value="false" />
-    <option name="INPUT_FILE" value="" />
-    <method v="2" />
-  </configuration>
-</component>

.idea/runConfigurations/tmtcclient_ACU_Test_UDP.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="tmtcclient ACU Test UDP" type="PythonConfigurationType" factoryName="Python" folderName="UDP">
+  <configuration default="false" name="tmtcclient ACU Test UDP" type="PythonConfigurationType" factoryName="Python" folderName="Devices">
     <module name="tmtc" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtc_client_cli.py" />
-    <option name="PARAMETERS" value="-m 3 -c 2 -s ACU --boardIP 192.168.133.10 --clientIP 192.168.133.4 -l" />
+    <option name="PARAMETERS" value="-s acu -l" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="true" />
     <option name="MODULE_MODE" value="false" />

.idea/runConfigurations/tmtcclient_P60_Dock_Test_UDP.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="tmtcclient P60 Dock Test UDP" type="PythonConfigurationType" factoryName="Python" folderName="UDP">
+  <configuration default="false" name="tmtcclient P60 Dock Test UDP" type="PythonConfigurationType" factoryName="Python" folderName="Devices">
     <module name="tmtc" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtc_client_cli.py" />
-    <option name="PARAMETERS" value="-m 3 -c 2 -s P60DOCK --boardIP 192.168.133.10 --clientIP 192.168.133.4 -l" />
+    <option name="PARAMETERS" value="-s p60dock -l" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="true" />
     <option name="MODULE_MODE" value="false" />

.idea/runConfigurations/tmtcclient_PDU1_Test_UDP.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="tmtcclient PDU1 Test UDP" type="PythonConfigurationType" factoryName="Python" folderName="UDP">
+  <configuration default="false" name="tmtcclient PDU1 Test UDP" type="PythonConfigurationType" factoryName="Python" folderName="Devices">
     <module name="tmtc" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtc_client_cli.py" />
-    <option name="PARAMETERS" value="-m 3 -c 2 -s PDU1 --boardIP 192.168.133.10 --clientIP 192.168.133.4 -l" />
+    <option name="PARAMETERS" value="-s pdu1 -l" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="true" />
     <option name="MODULE_MODE" value="false" />

.idea/runConfigurations/tmtcclient_PDU2_Test_UDP.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="tmtcclient PDU2 Test UDP" type="PythonConfigurationType" factoryName="Python" folderName="UDP">
+  <configuration default="false" name="tmtcclient PDU2 Test UDP" type="PythonConfigurationType" factoryName="Python" folderName="Devices">
     <module name="tmtc" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
@@ -13,7 +13,7 @@
     <option name="ADD_SOURCE_ROOTS" value="true" />
     <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
     <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tmtc_client_cli.py" />
-    <option name="PARAMETERS" value="-m 3 -c 2 -s PDU2 --boardIP 192.168.133.10 --clientIP 192.168.133.4 -l -t 4" />
+    <option name="PARAMETERS" value="-s pdu2 -l -t 4" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="true" />
     <option name="MODULE_MODE" value="false" />

README.md

@@ -1,8 +1,46 @@
-### How to use this folder
+# TMTC Commander EIVE
 
-This folder contains template files to set up the TMTC commander 
-for a new mission or project. These files are the adaption
-point to customize the TMTC commander.
+# Set up virtual environment
+
+## Linux
+
+1. Create virtual environment
+
+```sh
+python3 -m venv .
+```
+
+2. Activate virtual environment
+
+```sh
+./Scripts/activate
+```
+
+3. Install `tmtccmd` for virtual environment. `-e` for interactive installation.
+
+```sh
+cd tmtccmd
+python3 -m pip install -e .[gui]
+```
+
+## Windows
+
+1. Create virtual environment
+
+```sh
+py -m venv .
+```
+
+2. Activate virtual environment
+
+```sh
+Scripts\activate.bat
+```
+
+3. Install `tmtccmd` for virtual environment. `-e` for interactive installation.
+
+```sh
+cd tmtccmd
+py -m pip install -e .[gui]
+```
 
-To do so, simply copy all folder inside the TMTC commander root. This
-step is also required because the TMTC commander core will load some modules.

config/custom_hooks.py

@@ -3,7 +3,7 @@
 @details    Template configuration file. Copy this folder to the TMTC commander root and adapt
             it to your needs.
 """
-from tmtc_core.pus_tc.tmtcc_pus_tc_base import PusTelecommand
+from tmtccmd.ecss.tc import PusTelecommand
 
 
 def command_preparation_hook() -> PusTelecommand:

config/custom_mode_op.py

@@ -0,0 +1,19 @@
+"""
+@brief      This file transfers control of custom mode handling to the user.
+@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
+            it to your needs.
+"""
+import enum
+
+from tmtccmd.core.backend import TmTcHandler
+from tmtccmd.utility.logger import get_logger
+
+LOGGER = get_logger()
+
+
+class CustomModeList(enum.IntEnum):
+    pass
+
+
+def custom_mode_operation(tmtc_backend: TmTcHandler, mode: int):
+    pass

config/definitions.py

@@ -0,0 +1,25 @@
+"""
+@brief      This file transfers control of the custom definitions like modes to the user.
+@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
+            it to your needs.
+"""
+
+import enum
+
+
+PUS_APID = 0x65
+
+
+class CustomServiceList(enum.Enum):
+    TEST_DEVICE = "test",
+    P60DOCK = "p60dock"
+    PDU1 = "pdu1"
+    PDU2 = "pdu2"
+    ACU = "acu"
+    TMP1075_1 = "tmp1075_1"
+    TMP1075_2 = "tmp1075_2"
+    HEATER = "heater"
+    IMTQ = "imtq"
+    PLOC = "ploc"
+    PCDU = "pcdu",
+    SA_DEPLYOMENT = "sa_depl"

config/globals_config.py

@@ -0,0 +1,36 @@
+"""
+@brief      This file transfers definitions of global variables to the user.
+@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
+            it to your needs.
+"""
+
+import enum
+import argparse
+
+
+# All globals can be added here and will be part of a globals dictionary.
+from config.definitions import CustomServiceList, PUS_APID
+from config.custom_mode_op import CustomModeList
+from tmtccmd.config.definitions import CoreComInterfaces
+from tmtccmd.config.globals import set_default_globals_pre_args_parsing, \
+    set_default_globals_post_args_parsing
+from tmtccmd.utility.logger import get_logger
+
+LOGGER = get_logger()
+
+
+class CustomGlobalIds(enum.Enum):
+    from enum import auto
+    pass
+
+
+def set_globals_pre_args_parsing(gui: bool = False):
+    set_default_globals_pre_args_parsing(
+        gui=gui, apid=PUS_APID, com_if_id=CoreComInterfaces.TCPIP_UDP.value)
+
+
+def add_globals_post_args_parsing(args: argparse.Namespace, json_cfg_path: str):
+    set_default_globals_post_args_parsing(
+        args=args, custom_services_list=[CustomServiceList],
+        custom_modes_list=[CustomModeList], json_cfg_path=json_cfg_path
+    )

config/hook_implementations.py

@@ -0,0 +1,136 @@
+import argparse
+from typing import Union, Dict, Tuple
+
+from tmtccmd.config.definitions import ServiceOpCodeDictT
+from tmtccmd.pus_tm.service_3_base import Service3Base
+from tmtccmd.ecss.tm import PusTelemetry
+from tmtccmd.pus_tc.definitions import TcQueueT
+from tmtccmd.com_if.com_interface_base import CommunicationInterface
+from tmtccmd.core.backend import TmTcHandler
+from tmtccmd.config.hook import TmTcHookBase
+from tmtccmd.utility.tmtc_printer import TmTcPrinter
+from tmtccmd.config.globals import OpCodeDictKeys
+
+from config.definitions import CustomServiceList
+
+
+class EiveHookObject(TmTcHookBase):
+
+    def get_service_op_code_dictionary(self) -> ServiceOpCodeDictT:
+        from tmtccmd.config.globals import get_default_service_op_code_dict
+        service_op_code_dict = get_default_service_op_code_dict()
+        op_code_dict_srv_acu = {
+            "0": ("ACU Tests", {OpCodeDictKeys.TIMEOUT: 2.0}),
+        }
+        service_acu_tuple = ("ACU Devices", op_code_dict_srv_acu)
+
+        op_code_dict_srv_tmp1075 = {
+            "0": ("TMP1075 Tests", {OpCodeDictKeys.TIMEOUT: 2.2}),
+        }
+        service_tmp1075_1_tuple = ("TMP1075 1", op_code_dict_srv_tmp1075)
+        service_tmp1075_2_tuple = ("TMP1075 2", op_code_dict_srv_tmp1075)
+
+        op_code_dict_srv_p60 = {
+            "0": ("P60 Tests", {OpCodeDictKeys.TIMEOUT: 2.0}),
+        }
+        service_p60_tuple = ("P60 Device", op_code_dict_srv_p60)
+
+        op_code_dict_srv_pdu1 = {
+            "0": ("PDU1 Tests", {OpCodeDictKeys.TIMEOUT: 2.0}),
+        }
+        service_pdu1_tuple = ("PDU1 Device", op_code_dict_srv_pdu1)
+
+        op_code_dict_srv_pdu2 = {
+            "0": ("PDU2 Tests", {OpCodeDictKeys.TIMEOUT: 2.0}),
+        }
+        service_pdu2_tuple = ("PDU2 Device", op_code_dict_srv_pdu2)
+
+        op_code_dict_srv_heater = {
+            "0": ("Heater Tests", {OpCodeDictKeys.TIMEOUT: 2.0}),
+        }
+        service_heater_tuple = ("Heater Device", op_code_dict_srv_heater)
+
+        op_code_dict_srv_imtq = {
+            "0": ("IMTQ Tests All", {OpCodeDictKeys.TIMEOUT: 2.0}),
+            "1": ("IMTQ perform pos X self test", {OpCodeDictKeys.TIMEOUT: 2.0}),
+            "2": ("IMTQ perform neg X self test", {OpCodeDictKeys.TIMEOUT: 2.0}),
+            "3": ("IMTQ perform pos Y self test", {OpCodeDictKeys.TIMEOUT: 2.0}),
+            "4": ("IMTQ perform neg Y self test", {OpCodeDictKeys.TIMEOUT: 2.0}),
+            "5": ("IMTQ perform pos Z self test", {OpCodeDictKeys.TIMEOUT: 2.0}),
+            "6": ("IMTQ perform neg Z self test", {OpCodeDictKeys.TIMEOUT: 2.0}),
+            "7": ("IMTQ command dipole", {OpCodeDictKeys.TIMEOUT: 2.0}),
+            "8": ("IMTQ get commanded dipole", {OpCodeDictKeys.TIMEOUT: 2.0}),
+        }
+        service_imtq_tuple = ("IMTQ Device", op_code_dict_srv_imtq)
+
+        service_op_code_dict[CustomServiceList.ACU.value] = service_acu_tuple
+        service_op_code_dict[CustomServiceList.TMP1075_1.value] = service_tmp1075_1_tuple
+        service_op_code_dict[CustomServiceList.TMP1075_2.value] = service_tmp1075_2_tuple
+        service_op_code_dict[CustomServiceList.P60DOCK.value] = service_p60_tuple
+        service_op_code_dict[CustomServiceList.PDU1.value] = service_pdu1_tuple
+        service_op_code_dict[CustomServiceList.PDU1.value] = service_pdu2_tuple
+        service_op_code_dict[CustomServiceList.PDU1.value] = service_pdu2_tuple
+        service_op_code_dict[CustomServiceList.HEATER.value] = service_heater_tuple
+        service_op_code_dict[CustomServiceList.IMTQ.value] = service_imtq_tuple
+        return service_op_code_dict
+
+    def get_json_config_file_path(self) -> str:
+        """
+        The user can specify a path and filename for the JSON configuration file by overriding this function.
+        :return:
+        """
+        return "config/tmtc_config.json"
+
+    def get_version(self) -> str:
+        from config.version import SW_NAME, VERSION_MAJOR, VERSION_MINOR, VERSION_SUBMINOR
+        return f"{SW_NAME} {VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_SUBMINOR}"
+
+    def add_globals_pre_args_parsing(self, gui: bool = False):
+        from config.globals_config import set_globals_pre_args_parsing
+        set_globals_pre_args_parsing(gui=gui)
+
+    def add_globals_post_args_parsing(self, args: argparse.Namespace):
+        from config.globals_config import add_globals_post_args_parsing
+        add_globals_post_args_parsing(args=args, json_cfg_path=self.get_json_config_file_path())
+
+    def assign_communication_interface(self, com_if_key: str, tmtc_printer: TmTcPrinter) -> \
+            Union[CommunicationInterface, None]:
+        from tmtccmd.config.com_if import create_communication_interface_default
+        return create_communication_interface_default(
+            com_if_key=com_if_key, tmtc_printer=tmtc_printer,
+            json_cfg_path=self.get_json_config_file_path()
+        )
+
+    def perform_mode_operation(self, tmtc_backend: TmTcHandler, mode: int):
+        from config.custom_mode_op import custom_mode_operation
+        custom_mode_operation(mode=mode, tmtc_backend=tmtc_backend)
+
+    def pack_service_queue(self, service: int, op_code: str, service_queue: TcQueueT):
+        from pus_tc.tc_packer_hook import pack_service_queue_user
+        pack_service_queue_user(service=service, op_code=op_code, service_queue=service_queue)
+
+    def tm_user_factory_hook(self, raw_tm_packet: bytearray) -> PusTelemetry:
+        from pus_tm.factory_hook import tm_user_factory_hook
+        return tm_user_factory_hook(raw_tm_packet=raw_tm_packet)
+
+    def get_object_ids(self) -> Dict[bytes, list]:
+        from config.object_ids import get_object_ids
+        return get_object_ids()
+
+    @staticmethod
+    def handle_service_8_telemetry(
+            object_id: bytes, action_id: int, custom_data: bytearray
+    ) -> Tuple[list, list]:
+        from pus_tm.service_8_hook import user_analyze_service_8_data
+        return user_analyze_service_8_data(
+            object_id=object_id, action_id=action_id, custom_data=custom_data
+        )
+
+    @staticmethod
+    def handle_service_3_housekeeping(
+        object_id: bytes, set_id: int, hk_data: bytearray, service3_packet: Service3Base
+    ) -> Tuple[list, list, bytearray, int]:
+        from pus_tm.hk_handling import handle_user_hk_packet
+        return handle_user_hk_packet(
+            object_id=object_id, set_id=set_id, hk_data=hk_data, service3_packet=service3_packet
+        )

config/object_ids.py

@@ -0,0 +1,38 @@
+"""
+@brief      This file transfers control of the object IDs to the user.
+@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
+            it to your needs.
+"""
+from typing import Dict
+
+PUS_SERVICE_17_ID = bytes([0x53, 0x00, 0x00, 0x17])
+TEST_DEVICE_ID = bytes([0x44, 0x00, 0xAF, 0xFE])
+P60_DOCK_HANDLER = bytes([0x44, 0x00, 0x00, 0x1])
+PDU_1_HANDLER_ID = bytes([0x44, 0x00, 0x00, 0x2])
+PDU_2_HANDLER_ID = bytes([0x44, 0x00, 0x00, 0x3])
+ACU_HANDLER_ID = bytes([0x44, 0x00, 0x00, 0x4])
+TMP_1075_1_HANDLER_ID = bytes([0x44, 0x00, 0x00, 0x5])
+TMP_1075_2_HANDLER_ID = bytes([0x44, 0x00, 0x00, 0x6])
+HEATER_ID = bytes([0x54, 0x00, 0x00, 0x1])
+PCDU_HANDLER_ID = bytes([0x44, 0x00, 0x10, 0x00])
+SOLAR_ARRAY_DEPLOYMENT_ID = bytes([0x44, 0x00, 0x10, 0x01])
+SYRLINKS_HANDLER = bytes([0x44, 0x00, 0x10, 0x02])
+IMTQ_HANDLER_ID = bytearray([0x44, 0x00, 0x00, 0x14])
+PLOC_ID = bytearray([0x44, 0x00, 0x00, 0x15])
+
+
+def get_object_ids() -> Dict[bytes, list]:
+    object_id_dict = ({
+         PUS_SERVICE_17_ID: "PUS Service 17",
+         TEST_DEVICE_ID: "Test Device",
+         P60_DOCK_HANDLER: "P60",
+         PDU_1_HANDLER_ID: "PCDU PDU1 Handler",
+         PDU_2_HANDLER_ID: "PCDU PDU2 Handler",
+         ACU_HANDLER_ID: "ACU Handler",
+         TMP_1075_1_HANDLER_ID: "TMP 1075 Handler 1",
+         TMP_1075_2_HANDLER_ID: "TMP 1075 Handler 2",
+         HEATER_ID: "Heater",
+         PCDU_HANDLER_ID: "PCDU",
+         SOLAR_ARRAY_DEPLOYMENT_ID: "Solar Array Deployment",
+    })
+    return object_id_dict

config/tmtcc_com_config.py

@@ -1,18 +0,0 @@
-"""
-@brief      This file transfers control of communication interface setup to the user.
-@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
-            it to your needs.
-"""
-from typing import Union
-
-from tmtc_core.com_if.tmtcc_com_interface_base import CommunicationInterface
-from tmtc_core.core.tmtc_core_definitions import ComInterfaces
-from tmtc_core.core.tmtcc_com_if_setup import create_communication_interface_default
-from tmtc_core.utility.tmtcc_tmtc_printer import TmTcPrinter
-
-
-def create_communication_interface_user(com_if: ComInterfaces, tmtc_printer: TmTcPrinter) -> \
-        Union[CommunicationInterface, None]:
-    return create_communication_interface_default(com_if, tmtc_printer)
-
-

config/tmtcc_definitions.py

@@ -1,50 +0,0 @@
-"""
-@brief      This file transfers control of the custom definitions like modes to the user.
-@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
-            it to your needs.
-"""
-
-import enum
-from enum import auto
-
-
-# Mode options, set by args parser
-class ModeList(enum.Enum):
-    Idle = 0
-    ListenerMode = 1
-    SingleCommandMode = 2
-    ServiceTestMode = 3
-    SoftwareTestMode = 4
-    PromptMode = 32
-
-
-class ServiceList(enum.Enum):
-    SERVICE_2 = 0
-    SERVICE_3 = auto()
-    SERVICE_5 = auto()
-    SERVICE_8 = auto()
-    SERVICE_9 = auto()
-    SERVICE_17 = auto()
-    SERVICE_20 = auto()
-    SERVICE_23 = auto()
-    SERVICE_200 = auto()
-    P60DOCK = auto()
-    PDU1 = auto()
-    PDU2 = auto()
-    ACU = auto()
-    TMP1075_1 = auto()
-    TMP1075_2 = auto()
-    HEATER = auto()
-    SA_DEPL = auto()
-
-
-class SerialConfig(enum.Enum):
-    SERIAL_PORT = auto()
-    SERIAL_BAUD_RATE = auto()
-    SERIAL_TIMEOUT = auto()
-    SERIAL_COMM_TYPE = auto()
-
-
-class EthernetConfig(enum.Enum):
-    SEND_ADDRESS = auto()
-    RECV_ADDRESS = auto()

config/tmtcc_globals.py

@@ -1,234 +0,0 @@
-"""
-@brief      This file transfers definitions of global variables to the user.
-@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
-            it to your needs.
-"""
-
-import enum
-import argparse
-
-
-# All globals can be added here and will be part of a globals dictionary.
-from config.tmtcc_definitions import ServiceList, ModeList
-
-from tmtc_core.com_if.tmtcc_serial_com_if import SerialCommunicationType
-from tmtc_core.com_if.tmtcc_serial_utilities import determine_com_port
-from tmtc_core.core.tmtc_core_definitions import ComInterfaces
-from tmtc_core.utility.tmtcc_logger import get_logger
-
-
-class GlobalIds(enum.Enum):
-    from enum import auto
-    # Generic parameters
-    APID = auto()
-    MODE = auto()
-    SERVICE = auto()
-    SERVICELIST = auto()
-    COM_IF = auto()
-    OP_CODE = auto()
-    TM_TIMEOUT = auto()
-
-    # Miscellaneous
-    DISPLAY_MODE = auto()
-    USE_LISTENER_AFTER_OP = auto()
-    PRINT_HK = auto()
-    PRINT_TM = auto()
-    PRINT_RAW_TM = auto()
-    PRINT_TO_FILE = auto()
-    RESEND_TC = auto()
-    TC_SEND_TIMEOUT_FACTOR = auto()
-
-    # Config dictionaries
-    USE_SERIAL = auto()
-    SERIAL_CONFIG = auto()
-    USE_ETHERNET = auto()
-    ETHERNET_CONFIG = auto()
-
-    # Object handles
-    PRETTY_PRINTER = auto()
-    TM_LISTENER_HANDLE = auto()
-    COM_INTERFACE_HANDLE = auto()
-    TMTC_PRINTER_HANDLE = auto()
-
-
-def add_globals_pre_args_parsing(gui: bool = False):
-    from tmtc_core.core.tmtcc_globals_manager import update_global
-    import pprint
-
-    update_global(GlobalIds.APID, 0x65)
-    update_global(GlobalIds.COM_IF, ComInterfaces.EthernetUDP)
-    update_global(GlobalIds.TC_SEND_TIMEOUT_FACTOR, 2)
-    update_global(GlobalIds.TM_TIMEOUT, 4)
-    update_global(GlobalIds.DISPLAY_MODE, "long")
-    update_global(GlobalIds.PRINT_TO_FILE, True)
-
-    update_global(GlobalIds.SERIAL_CONFIG, dict())
-    update_global(GlobalIds.ETHERNET_CONFIG, dict())
-    pp = pprint.PrettyPrinter()
-    update_global(GlobalIds.PRETTY_PRINTER, pp)
-    update_global(GlobalIds.TM_LISTENER_HANDLE, None)
-    update_global(GlobalIds.COM_INTERFACE_HANDLE, None)
-    update_global(GlobalIds.TMTC_PRINTER_HANDLE, None)
-    update_global(GlobalIds.PRINT_RAW_TM, False)
-    update_global(GlobalIds.RESEND_TC, False)
-
-    update_global(GlobalIds.OP_CODE, "0")
-    update_global(GlobalIds.MODE, ModeList.ListenerMode)
-
-    if gui:
-        set_up_ethernet_cfg()
-
-    servicelist = dict()
-    servicelist[ServiceList.SERVICE_2] = ["Service 2 Raw Commanding"]
-    servicelist[ServiceList.SERVICE_3] = ["Service 3 Housekeeping"]
-    servicelist[ServiceList.SERVICE_5] = ["Service 5 Event"]
-    servicelist[ServiceList.SERVICE_8] = ["Service 8 Functional Commanding"]
-    servicelist[ServiceList.SERVICE_9] = ["Service 9 Time"]
-    servicelist[ServiceList.SERVICE_17] = ["Service 17 Test"]
-    servicelist[ServiceList.SERVICE_20] = ["Service 20 Parameters"]
-    servicelist[ServiceList.SERVICE_23] = ["Service 23 File Management"]
-    servicelist[ServiceList.SERVICE_200] = ["Service 200 Mode Management"]
-    update_global(GlobalIds.SERVICE, ServiceList.SERVICE_17)
-    update_global(GlobalIds.SERVICELIST, servicelist)
-
-
-def add_globals_post_args_parsing(args: argparse.Namespace):
-    from tmtc_core.core.tmtcc_globals_manager import update_global
-    from config.tmtcc_definitions import ModeList
-    logger = get_logger()
-
-    mode_param = ModeList.ListenerMode
-    if 0 <= args.mode <= 6:
-        if args.mode == 0:
-            mode_param = ModeList.GUIMode
-        elif args.mode == 1:
-            mode_param = ModeList.ListenerMode
-        elif args.mode == 2:
-            mode_param = ModeList.SingleCommandMode
-        elif args.mode == 3:
-            mode_param = ModeList.ServiceTestMode
-        elif args.mode == 4:
-            mode_param = ModeList.SoftwareTestMode
-    update_global(GlobalIds.MODE, mode_param)
-
-    if args.com_if == ComInterfaces.EthernetUDP.value:
-        com_if = ComInterfaces.EthernetUDP
-    elif args.com_if == ComInterfaces.Serial.value:
-        com_if = ComInterfaces.Serial
-    elif args.com_if == ComInterfaces.Dummy.value:
-        com_if = ComInterfaces.Dummy
-    elif args.com_if == ComInterfaces.QEMU.value:
-        com_if = ComInterfaces.QEMU
-    else:
-        com_if = ComInterfaces.Serial
-    update_global(GlobalIds.COM_IF, com_if)
-
-    if args.short_display_mode:
-        display_mode_param = "short"
-    else:
-        display_mode_param = "long"
-    update_global(GlobalIds.DISPLAY_MODE, display_mode_param)
-
-    service = str(args.service).lower()
-    if service == "2":
-        service = ServiceList.SERVICE_2
-    elif service == "3":
-        service = ServiceList.SERVICE_3
-    elif service == "5":
-        service = ServiceList.SERVICE_5
-    elif service == "8":
-        service = ServiceList.SERVICE_8
-    elif service == "9":
-        service = ServiceList.SERVICE_9
-    elif service == "17":
-        service = ServiceList.SERVICE_17
-    elif service == "20":
-        service = ServiceList.SERVICE_20
-    elif service == "23":
-        service = ServiceList.SERVICE_23
-    elif service == "p60dock":
-        service = ServiceList.P60DOCK
-    elif service == "pdu1":
-        service = ServiceList.PDU1
-    elif service == "pdu2":
-        service = ServiceList.PDU2
-    elif service == "acu":
-        service = ServiceList.ACU
-    elif service == "tmp1075_1":
-        service = ServiceList.TMP1075_1
-    elif service == "tmp1075_2":
-        service = ServiceList.TMP1075_2
-    elif service == "heater":
-        service = ServiceList.HEATER
-    elif service == "sa_depl":
-        service = ServiceList.SA_DEPL
-    else:
-        logger.warning("Service not known! Setting standard service 17")
-        service = ServiceList.SERVICE_17
-
-    update_global(GlobalIds.SERVICE, service)
-
-    if args.op_code is None:
-        op_code = 0
-    else:
-        op_code = str(args.op_code).lower()
-    update_global(GlobalIds.OP_CODE, op_code)
-
-    update_global(GlobalIds.USE_LISTENER_AFTER_OP, args.listener)
-    update_global(GlobalIds.TM_TIMEOUT, args.tm_timeout)
-    update_global(GlobalIds.PRINT_HK, args.print_hk)
-    update_global(GlobalIds.PRINT_TM, args.print_tm)
-    update_global(GlobalIds.PRINT_RAW_TM, args.raw_data_print)
-    update_global(GlobalIds.PRINT_TO_FILE, args.print_log)
-    update_global(GlobalIds.RESEND_TC, args.resend_tc)
-    update_global(GlobalIds.TC_SEND_TIMEOUT_FACTOR, 3)
-
-    use_serial_cfg = False
-    if com_if == ComInterfaces.Serial or com_if == ComInterfaces.QEMU:
-        use_serial_cfg = True
-    if use_serial_cfg:
-        set_up_serial_cfg(com_if)
-
-    use_ethernet_cfg = False
-    if com_if == ComInterfaces.EthernetUDP:
-        use_ethernet_cfg = True
-    if use_ethernet_cfg:
-        # TODO: Port and IP address can also be passed as CLI parameters. Use them here if applicable
-        set_up_ethernet_cfg()
-
-
-def set_up_serial_cfg(com_if: ComInterfaces):
-    from tmtc_core.core.tmtcc_globals_manager import update_global
-    update_global(GlobalIds.USE_SERIAL, True)
-    from tmtc_core.core.tmtcc_globals_manager import get_global
-    from config.tmtcc_definitions import SerialConfig
-    serial_cfg_dict = get_global(GlobalIds.SERIAL_CONFIG)
-    if com_if == ComInterfaces.Serial:
-        com_port = determine_com_port()
-    else:
-        com_port = ""
-    serial_cfg_dict.update({SerialConfig.SERIAL_PORT: com_port})
-    serial_cfg_dict.update({SerialConfig.SERIAL_BAUD_RATE: 115200})
-    serial_cfg_dict.update({SerialConfig.SERIAL_TIMEOUT: 0.01})
-    serial_cfg_dict.update({SerialConfig.SERIAL_COMM_TYPE: SerialCommunicationType.DLE_ENCODING})
-    serial_cfg_dict.update({SerialConfig.SERIAL_FRAME_SIZE: 256})
-    serial_cfg_dict.update({SerialConfig.SERIAL_DLE_QUEUE_LEN: 25})
-    serial_cfg_dict.update({SerialConfig.SERIAL_DLE_MAX_FRAME_SIZE: 1024})
-    update_global(GlobalIds.SERIAL_CONFIG, serial_cfg_dict)
-
-
-def set_up_ethernet_cfg():
-    from tmtc_core.core.tmtcc_globals_manager import update_global
-    update_global(GlobalIds.USE_ETHERNET, True)
-    from tmtc_core.core.tmtcc_globals_manager import get_global
-    from config.tmtcc_definitions import EthernetConfig
-    from tmtc_core.com_if.tmtcc_ethernet_utilities import determine_ip_addresses
-    ethernet_cfg_dict = get_global(GlobalIds.ETHERNET_CONFIG)
-    # This will either load the addresses from a JSON file or prompt them from the user.
-    send_addr, rcv_addr = determine_ip_addresses()
-    ethernet_cfg_dict.update({EthernetConfig.SEND_ADDRESS: send_addr})
-    ethernet_cfg_dict.update({EthernetConfig.RECV_ADDRESS: rcv_addr})
-    update_global(GlobalIds.ETHERNET_CONFIG, ethernet_cfg_dict)
-
-
-

config/tmtcc_object_ids.py

@@ -1,41 +0,0 @@
-"""
-@brief      This file transfers control of the object IDs to the user.
-@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
-            it to your needs.
-"""
-
-import enum
-from typing import Dict
-
-
-class ObjectIds(enum.Enum):
-    from enum import auto
-    INVALID = auto()
-    PUS_SERVICE_17 = auto()
-    TEST_DEVICE = auto()
-    P60DOCK_HANDLER_ID = auto()
-    PDU1_HANDLER_ID = auto()
-    PDU2_HANDLER_ID = auto()
-    ACU_HANDLER_ID = auto()
-    TMP1075_1_HANDLER_ID = auto()
-    TMP1075_2_HANDLER_ID = auto()
-    HEATER = auto()
-    SOLAR_ARRAY_DEPLOYMENT_HANDLER = auto()
-
-
-def set_object_ids(object_id_dict: Dict[ObjectIds, bytearray]):
-    o_ids = ObjectIds
-    object_id_dict.update(
-        {o_ids.PUS_SERVICE_17: bytearray([0x53, 0x00, 0x00, 0x17]),
-         o_ids.TEST_DEVICE: bytearray([0x44, 0x00, 0xAF, 0xFE]),
-         o_ids.P60DOCK_HANDLER_ID: bytearray([0x44, 0x00, 0x00, 0x1]),
-         o_ids.PDU1_HANDLER_ID: bytearray([0x44, 0x00, 0x00, 0x2]),
-         o_ids.PDU2_HANDLER_ID: bytearray([0x44, 0x00, 0x00, 0x3]),
-         o_ids.ACU_HANDLER_ID: bytearray([0x44, 0x00, 0x00, 0x4]),
-         o_ids.TMP1075_1_HANDLER_ID: bytearray([0x44, 0x00, 0x00, 0x5]),
-         o_ids.TMP1075_2_HANDLER_ID: bytearray([0x44, 0x00, 0x00, 0x6]),
-         o_ids.HEATER: bytearray([0x54, 0x00, 0x00, 0x3]),
-         o_ids.SOLAR_ARRAY_DEPLOYMENT_HANDLER: bytearray([0x44, 0x00, 0x00, 0x8]),
-         o_ids.INVALID: bytearray([0xFF, 0xFF, 0xFF, 0xFF]),
-         }
-    )

config/tmtcc_user_mode_op.py

@@ -1,20 +0,0 @@
-"""
-@brief      This file transfers control of custom mode handling to the user.
-@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
-            it to your needs.
-"""
-import sys
-
-from config.tmtcc_definitions import ModeList
-from tmtc_core.core.tmtcc_backend import TmTcHandler
-from tmtc_core.utility.tmtcc_logger import get_logger
-
-LOGGER = get_logger()
-
-
-def perform_mode_operation_user(tmtc_backend: TmTcHandler, mode: ModeList):
-    """
-    Custom modes can be implemented here
-    """
-    LOGGER.error(f"Unknown mode {mode}, Configuration error !")
-    sys.exit()

config/tmtcc_version.py

@@ -1,8 +0,0 @@
-"""
-@brief      This file transfers control of versioning to the user.
-@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
-            it to your needs.
-"""
-SW_NAME = "eive"
-SW_VERSION = 1
-SW_SUBVERSION = 1

config/version.py

@@ -0,0 +1,4 @@
+SW_NAME = "eive"
+VERSION_MAJOR = 1
+VERSION_MINOR = 6
+VERSION_SUBMINOR = 1

gomspace/gomspace_pdu_definitions.py

@@ -6,6 +6,11 @@ class PDUConfigTable:
     out_en_1 = TableEntry(bytearray([0x00, 0x49]), TableEntry.uint8_size)
     out_en_2 = TableEntry(bytearray([0x00, 0x4A]), TableEntry.uint8_size)
     out_en_3 = TableEntry(bytearray([0x00, 0x4B]), TableEntry.uint8_size)
+    out_en_4 = TableEntry(bytearray([0x00, 0x4C]), TableEntry.uint8_size)
+    out_en_5 = TableEntry(bytearray([0x00, 0x4D]), TableEntry.uint8_size)
+    out_en_6 = TableEntry(bytearray([0x00, 0x4E]), TableEntry.uint8_size)
+    out_en_7 = TableEntry(bytearray([0x00, 0x4F]), TableEntry.uint8_size)
+    out_en_8 = TableEntry(bytearray([0x00, 0x50]), TableEntry.uint8_size)
     # When channel consumes more than cur_lu_lim, channel is turned of immediately
     cur_lu_lim_0 = TableEntry(bytearray([0x00, 0xB8]), TableEntry.uint16_size)
 

pus_tc/acu.py

@@ -6,13 +6,13 @@
 @date   21.12.2020
 """
 
-from tmtc_core.pus_tc.tmtcc_pus_tc_packer import TcQueueT
-from tmtc_core.pus_tc.tmtcc_pus_tc_base import PusTelecommand
-from tmtc_core.core.tmtc_core_definitions import QueueCommands
+from tmtccmd.pus_tc.packer import TcQueueT
+from tmtccmd.ecss.tc import PusTelecommand
+from tmtccmd.config.definitions import QueueCommands
 from gomspace.gomspace_common import *
-from pus_tc.tmtcc_tc_p60dock import P60DockConfigTable
-from config.tmtcc_object_ids import ObjectIds
-from tmtc_core.core.tmtcc_object_id_manager import get_object_id
+from pus_tc.p60dock import P60DockConfigTable
+
+from config.object_ids import P60_DOCK_HANDLER
 
 
 class ACUTestProcedure:
@@ -57,7 +57,7 @@ def pack_acu_test_into(object_id: bytearray, tc_queue: TcQueueT) -> TcQueueT:
     tc_queue.appendleft((QueueCommands.PRINT, "Testing ACU"))
 
     tc_queue.appendleft((QueueCommands.PRINT, "P60 Dock: Enabling ACU connected to X1 slot (channel 0)"))
-    p60dock_object_id = get_object_id(ObjectIds.P60DOCK_HANDLER_ID)
+    p60dock_object_id = P60_DOCK_HANDLER
     command = pack_set_param_command(p60dock_object_id, P60DockConfigTable.out_en_0.parameter_address,
                                      P60DockConfigTable.out_en_0.parameter_size, Channel.on)
     command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)

pus_tc/heater.py

@@ -5,9 +5,9 @@
 @author J. Meier
 @date   30.01.2021
 """
-from tmtc_core.core.tmtc_core_definitions import QueueCommands
-from tmtc_core.pus_tc.tmtcc_pus_tc_packer import TcQueueT
-from tmtc_core.pus_tc.tmtcc_pus_tc_base import PusTelecommand
+from tmtccmd.config.definitions import QueueCommands
+from tmtccmd.pus_tc.packer import TcQueueT
+from tmtccmd.ecss.tc import PusTelecommand
 
 
 class SwitchNumbers:
@@ -26,7 +26,7 @@ class ActionIds:
     SWITCH_HEATER = bytearray([0x0, 0x0, 0x0, 0x0])
 
 
-def pack_heater_test_into(object_id: bytearray, tc_queue: TcQueueT) -> TcQueueT:
+def pack_heater_test_into(object_id: bytearray, tc_queue: TcQueueT):
     tc_queue.appendleft((QueueCommands.PRINT, "Testing Heater Switching"))
 
     heater_number = int(input("Type number of heater to switch: "))

pus_tc/imtq.py

@@ -0,0 +1,196 @@
+# -*- coding: utf-8 -*-
+"""
+@file   imtq.py
+@brief  Tests for the ISIS IMTQ (Magnettorquer) device handler
+@author J. Meier
+@date   25.03.2021
+"""
+from tmtccmd.config.definitions import QueueCommands
+
+from tmtccmd.pus_tc.packer import TcQueueT
+from tmtccmd.ecss.tc import PusTelecommand
+from tmtccmd.pus_tc.service_3_housekeeping import make_sid, generate_one_hk_command
+
+
+class ImtqTestProcedure:
+    """
+    @brief  Use this class to define the tests to perform for the IMTQ Handler.
+    @details    Setting all to True will run all tests.
+                Setting all to False will only run the tests set to True.
+    """
+    all = False
+    command_dipole = False
+    get_commanded_dipole = False
+    positive_x_test = True
+    negative_x_test = False
+    positive_y_test = False
+    negative_y_test = False
+    positive_z_test = False
+    negative_z_test = False
+
+
+class ImtqSetIds:
+    ENG_HK_SET = 1
+    CAL_MTM_SET = 2
+    RAW_MTM_SET = 3
+    POSITIVE_X_TEST = 4
+    NEGATIVE_X_TEST = 5
+    POSITIVE_Y_TEST = 6
+    NEGATIVE_Y_TEST = 7
+    POSITIVE_Z_TEST = 8
+    NEGATIVE_Z_TEST = 9
+
+
+class ImtqActionIds:
+    start_actuation_dipole = bytearray([0x0, 0x0, 0x0, 0x02])
+    get_commanded_dipole = bytearray([0x0, 0x0, 0x0, 0x03])
+    perform_positive_x_test = bytearray([0x0, 0x0, 0x0, 0x07])
+    perform_negative_x_test = bytearray([0x0, 0x0, 0x0, 0x08])
+    perform_positive_y_test = bytearray([0x0, 0x0, 0x0, 0x09])
+    perform_negative_y_test = bytearray([0x0, 0x0, 0x0, 0x0A])
+    perform_positive_z_test = bytearray([0x0, 0x0, 0x0, 0x0B])
+    perform_negative_z_test = bytearray([0x0, 0x0, 0x0, 0x0C])
+    # Initiates the reading of the last performed self test. After sending this command the results can be downlinked
+    # via the housekeeping service by using the appropriate set ids listed above.
+    read_self_test_results = bytearray([0x0, 0x0, 0x0, 0x0D])
+
+
+def pack_imtq_test_into(object_id: bytearray, tc_queue: TcQueueT, op_code: str) -> TcQueueT:
+    tc_queue.appendleft(
+        (QueueCommands.PRINT,
+         "Testing ISIS IMTQ handler with object id: 0x" + object_id.hex())
+    )
+
+    if op_code == "0" or op_code == "1":
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Perform positive x self test"))
+        command = object_id + ImtqActionIds.perform_positive_x_test
+        command = PusTelecommand(service=8, subservice=128, ssc=22, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Initiate reading of positive x self test results"))
+        command = object_id + ImtqActionIds.read_self_test_results
+        command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Request dataset with positive x self test results"))
+        sid = make_sid(object_id, ImtqSetIds.POSITIVE_X_TEST)
+        command = generate_one_hk_command(sid, 24)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    if op_code == "0" or op_code == "2":
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Perform negative x self test"))
+        command = object_id + ImtqActionIds.perform_negative_x_test
+        command = PusTelecommand(service=8, subservice=128, ssc=25, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Initiate reading of negative x self test results"))
+        command = object_id + ImtqActionIds.read_self_test_results
+        command = PusTelecommand(service=8, subservice=128, ssc=26, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Request dataset with negative x self test results"))
+        sid = make_sid(object_id, ImtqSetIds.NEGATIVE_X_TEST)
+        command = generate_one_hk_command(sid, 27)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    if op_code == "0" or op_code == "3":
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Perform positive y self test"))
+        command = object_id + ImtqActionIds.perform_positive_y_test
+        command = PusTelecommand(service=8, subservice=128, ssc=28, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Initiate reading of positive y self test results"))
+        command = object_id + ImtqActionIds.read_self_test_results
+        command = PusTelecommand(service=8, subservice=128, ssc=29, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Request dataset with positive y self test results"))
+        sid = make_sid(object_id, ImtqSetIds.POSITIVE_Y_TEST)
+        command = generate_one_hk_command(sid, 30)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    if op_code == "0" or op_code == "4":
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Perform negative y self test"))
+        command = object_id + ImtqActionIds.perform_negative_y_test
+        command = PusTelecommand(service=8, subservice=128, ssc=31, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Initiate reading of negative y self test results"))
+        command = object_id + ImtqActionIds.read_self_test_results
+        command = PusTelecommand(service=8, subservice=128, ssc=32, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Request dataset with negative y self test results"))
+        sid = make_sid(object_id, ImtqSetIds.NEGATIVE_Y_TEST)
+        command = generate_one_hk_command(sid, 33)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    if op_code == "0" or op_code == "5":
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Perform positive z self test"))
+        command = object_id + ImtqActionIds.perform_positive_z_test
+        command = PusTelecommand(service=8, subservice=128, ssc=34, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Initiate reading of positive z self test results"))
+        command = object_id + ImtqActionIds.read_self_test_results
+        command = PusTelecommand(service=8, subservice=128, ssc=35, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Request dataset with positive z self test results"))
+        sid = make_sid(object_id, ImtqSetIds.POSITIVE_Y_TEST)
+        command = generate_one_hk_command(sid, 36)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    if op_code == "0" or op_code == "6":
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Perform negative z self test"))
+        command = object_id + ImtqActionIds.perform_negative_z_test
+        command = PusTelecommand(service=8, subservice=128, ssc=35, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Initiate reading of negative z self test results"))
+        command = object_id + ImtqActionIds.read_self_test_results
+        command = PusTelecommand(service=8, subservice=128, ssc=36, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Request dataset with negative z self test results"))
+        sid = make_sid(object_id, ImtqSetIds.NEGATIVE_Z_TEST)
+        command = generate_one_hk_command(sid, 37)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    if op_code == "0" or op_code == "7":
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Commanding dipole"))
+        x_dipole = 0
+        y_dipole = 0
+        z_dipole = 0
+        duration = 0    # ms
+        command = pack_dipole_command(object_id, x_dipole, y_dipole, z_dipole, duration)
+        command = PusTelecommand(service=8, subservice=128, ssc=20, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    if op_code == "0" or op_code == "8":
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Get commanded dipole"))
+        command = object_id + ImtqActionIds.get_commanded_dipole
+        command = PusTelecommand(service=8, subservice=128, ssc=21, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    return tc_queue
+
+
+def pack_dipole_command(object_id: bytearray, x_dipole: int, y_dipole: int, z_dipole: int, duration: int) -> bytearray:
+    """ This function packs the command causing the ISIS IMTQ to generate a dipole.
+    @param object_id    The object id of the gomspace device handler.
+    @param x_dipole   The dipole of the x coil in 10^-4*Am^2 (max. 2000)
+    @param y_dipole   The dipole of the y coil in 10^-4*Am^2 (max. 2000)
+    @param z_dipole   The dipole of the z coil in 10^-4*Am^2 (max. 2000)
+    @param duration  The duration in milliseconds the dipole will be generated by the coils.
+                     When set to 0, the dipole will be generated until a new dipole actuation
+                     command is sent.
+    """
+    action_id = ImtqActionIds.start_actuation_dipole
+    command = bytearray()
+    command = object_id + action_id
+    command.extend(x_dipole.to_bytes(length=2, byteorder='big'))
+    command.extend(y_dipole.to_bytes(length=2, byteorder='big'))
+    command.extend(z_dipole.to_bytes(length=2, byteorder='big'))
+    command.extend(duration.to_bytes(length=2, byteorder='big'))
+    return command

pus_tc/p60dock.py

@@ -5,9 +5,9 @@
 @author J. Meier
 @date   13.12.2020
 """
-from tmtc_core.core.tmtc_core_definitions import QueueCommands
-from tmtc_core.pus_tc.tmtcc_pus_tc_packer import TcQueueT
-from tmtc_core.pus_tc.tmtcc_pus_tc_base import PusTelecommand
+from tmtccmd.config.definitions import QueueCommands
+from tmtccmd.pus_tc.packer import TcQueueT
+from tmtccmd.ecss.tc import PusTelecommand
 from gomspace.gomspace_common import *
 
 

pus_tc/pdu1.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+"""
+@file   tmtcc_tc_pdu1.py
+@brief  PDU2 tests
+@author J. Meier
+@date   17.12.2020
+"""
+from tmtccmd.config.definitions import QueueCommands
+
+from tmtccmd.pus_tc.packer import TcQueueT
+from tmtccmd.ecss.tc import PusTelecommand
+from gomspace.gomspace_common import *
+from pus_tc.p60dock import P60DockConfigTable
+from gomspace.gomspace_pdu_definitions import *
+
+
+class PDU1TestProcedure:
+    """
+    @brief  Use this class to define the tests to perform for the PDU2.
+    @details    Setting all to True will run all tests.
+                Setting all to False will only run the tests set to True.
+    """
+    all = False
+    reboot = False
+    ping = False
+    read_temperature = False
+    turn_channel_2_on = False    # Star Tracker connected to this channel (5V)
+    turn_channel_2_off = False
+    turn_channel_3_on = False  # MTQ connected to this channel (5V)
+    turn_channel_3_off = True
+
+
+def pack_pdu1_test_into(
+        pdu1_object_id: bytearray, p60dock_object_id: bytearray, tc_queue: TcQueueT
+):
+    tc_queue.appendleft((QueueCommands.PRINT, "Testing PDU1"))
+
+    if PDU1TestProcedure.all or PDU1TestProcedure.ping:
+        tc_queue.appendleft((QueueCommands.PRINT, "PDU1: Ping Test"))
+        ping_data = bytearray([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
+        command = pack_ping_command(pdu1_object_id, ping_data)
+        command = PusTelecommand(service=8, subservice=128, ssc=22, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+    if PDU1TestProcedure.all or PDU1TestProcedure.read_temperature:
+        tc_queue.appendleft((QueueCommands.PRINT, "PDU1: Testing  temperature reading"))
+        command = pack_get_param_command(
+            pdu1_object_id, TableIds.hk, PDUHkTable.temperature.parameter_address,
+            PDUHkTable.temperature.parameter_size
+        )
+        command = PusTelecommand(service=8, subservice=128, ssc=24, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+    if PDU1TestProcedure.all or PDU1TestProcedure.turn_channel_2_on:
+        tc_queue.appendleft((QueueCommands.PRINT, "PDU1: Turn channel 2 on (Star Tracker)"))
+        command = pack_set_param_command(pdu1_object_id, PDUConfigTable.out_en_2.parameter_address,
+                                         PDUConfigTable.out_en_2.parameter_size, Channel.on)
+        command = PusTelecommand(service=8, subservice=128, ssc=30, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+    if PDU1TestProcedure.all or PDU1TestProcedure.turn_channel_2_off:
+        tc_queue.appendleft((QueueCommands.PRINT, "PDU1: Turn channel 2 off (Star Tracker)"))
+        command = pack_set_param_command(pdu1_object_id, PDUConfigTable.out_en_2.parameter_address,
+                                         PDUConfigTable.out_en_2.parameter_size, Channel.off)
+        command = PusTelecommand(service=8, subservice=128, ssc=31, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+    if PDU1TestProcedure.all or PDU1TestProcedure.turn_channel_3_on:
+        tc_queue.appendleft((QueueCommands.PRINT, "PDU1: Turn channel 3 on (MTQ)"))
+        command = pack_set_param_command(pdu1_object_id, PDUConfigTable.out_en_3.parameter_address,
+                                         PDUConfigTable.out_en_3.parameter_size, Channel.on)
+        command = PusTelecommand(service=8, subservice=128, ssc=32, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+    if PDU1TestProcedure.all or PDU1TestProcedure.turn_channel_3_off:
+        tc_queue.appendleft((QueueCommands.PRINT, "PDU1: Turn channel 3 off (MTQ)"))
+        command = pack_set_param_command(pdu1_object_id, PDUConfigTable.out_en_3.parameter_address,
+                                         PDUConfigTable.out_en_3.parameter_size, Channel.off)
+        command = PusTelecommand(service=8, subservice=128, ssc=33, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())

pus_tc/pdu2.py

@@ -5,12 +5,12 @@
 @author J. Meier
 @date   17.12.2020
 """
-from tmtc_core.core.tmtc_core_definitions import QueueCommands
-from tmtc_core.pus_tc.tmtcc_pus_tc_packer import TcQueueT
-from tmtc_core.pus_tc.tmtcc_pus_tc_base import PusTelecommand
+from tmtccmd.config.definitions import QueueCommands
+from tmtccmd.pus_tc.packer import TcQueueT
+from tmtccmd.ecss.tc import PusTelecommand
 from gomspace.gomspace_common import *
 from gomspace.gomspace_pdu_definitions import *
-from pus_tc.tmtcc_tc_p60dock import P60DockConfigTable
+from pus_tc.p60dock import P60DockConfigTable
 
 
 class PDU2TestProcedure:
@@ -27,7 +27,7 @@ class PDU2TestProcedure:
     channel_2_off = False  # Reaction wheels 5V
     read_temperature = True
     read_channel_2_state = False  # Reaction wheels 5V
-    read_cur_lu_lim_0 = False # OBC
+    read_cur_lu_lim_0 = False  # OBC
     channel_2_on = False  # Reaction wheels 5V
     invalid_table_id_test = False  # Test to check if software properly handles invalid table ids
     invalid_address_test = False  # Test to check if software properly handles invalid addresses
@@ -101,4 +101,5 @@ def pack_pdu2_test_into(pdu2_object_id: bytearray, p60dock_object_id: bytearray,
         command = pack_request_full_hk_table_command(pdu2_object_id)
         command = PusTelecommand(service=8, subservice=128, ssc=28, app_data=command)
         tc_queue.appendleft(command.pack_command_tuple())
+
     return tc_queue

pus_tc/ploc.py

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+"""
+@file   ploc.py
+@brief  TMP1075 tests
+@author J. Meier
+@date   06.01.2021
+"""
+import struct
+
+from tmtccmd.config.definitions import QueueCommands
+
+from tmtccmd.pus_tc.packer import TcQueueT
+from tmtccmd.ecss.tc import PusTelecommand
+
+
+class PlocTestProcedure:
+    """
+    @brief  Use this class to define the tests to perform for the PLOC.
+    @details    Setting all to True will run all tests.
+                Setting all to False will only run the tests set to True.
+    """
+    all = False
+    test_tc_mem_write = False
+    test_tc_mem_read = True
+
+
+class PlocActionIds:
+    tc_mem_write = bytearray([0x0, 0x0, 0x0, 0x1])
+    tc_mem_read = bytearray([0x0, 0x0, 0x0, 0x2])
+
+
+class PlocReplyIds:
+    tm_mem_read_report = 6
+
+
+def pack_ploc_test_into(object_id: bytearray, tc_queue: TcQueueT) -> TcQueueT:
+    tc_queue.appendleft(
+        (QueueCommands.PRINT,
+         "Testing PLOC Handler with object id: 0x" + object_id.hex())
+    )
+
+    if PlocTestProcedure.all or PlocTestProcedure.test_tc_mem_write:
+        tc_queue.appendleft((QueueCommands.PRINT, "PLOC: TC Mem Write Test"))
+        memory_address = int(input("PLOC Tc Mem Write: Type memory address: 0x"), 16)
+        memory_data = int(input("PLOC Tc Mem Write: Type memory data: 0x"), 16)
+        command = generate_write_mem_command(object_id, struct.pack('!I', memory_address), memory_data)
+        command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    if PlocTestProcedure.all or PlocTestProcedure.test_tc_mem_read:
+        tc_queue.appendleft((QueueCommands.PRINT, "PLOC: TC Mem Read Test"))
+        memory_address = int(input("PLOC Tc Mem Read: Type memory address: 0x"), 16)
+        command = object_id + PlocActionIds.tc_mem_read + struct.pack('!I', memory_address)
+        command = PusTelecommand(service=8, subservice=128, ssc=24, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    return tc_queue
+
+
+def generate_write_mem_command(object_id: bytearray, memory_address: bytearray, memory_data: int) -> bytearray:
+    """ This function generates the command to write to a memory address within the PLOC
+    @param object_id    The object id of the PlocHandler
+    @param memory_address   The PLOC memory address where to write to.
+    @param memory_data    The data to write to the memory address specified by the bytearray memory_address.
+    """
+    command = object_id + PlocActionIds.tc_mem_write + memory_address + struct.pack('!I', memory_data)
+    return command

pus_tc/service_200_mode.py

@@ -5,49 +5,38 @@
 @author R. Mueller
 @date   02.05.2020
 """
-from tmtc_core.core.tmtc_core_definitions import QueueCommands
-from tmtc_core.pus_tc.tmtcc_pus_tc_base import PusTelecommand
-from tmtc_core.pus_tc.tmtcc_pus_tc_packer import TcQueueT
-from tmtc_core.core.tmtcc_object_id_manager import get_object_id
-from config.tmtcc_object_ids import ObjectIds
-import struct
+from tmtccmd.config.definitions import QueueCommands
+from tmtccmd.ecss.tc import PusTelecommand
+from tmtccmd.pus_tc.packer import TcQueueT
+from tmtccmd.pus_tc.service_200_mode import pack_mode_data
+from config.object_ids import TEST_DEVICE_ID
 
-TEST_DEVICE_ID = get_object_id(ObjectIds.TEST_DEVICE)
+TEST_DEVICE_OBJ_ID = TEST_DEVICE_ID
 
 
 def pack_service200_test_into(tc_queue: TcQueueT) -> TcQueueT:
     tc_queue.appendleft((QueueCommands.PRINT, "Testing Service 200"))
     # Object ID: Dummy Device
-    object_id = TEST_DEVICE_ID
+    obj_id = TEST_DEVICE_OBJ_ID
     # Set On Mode
     tc_queue.appendleft((QueueCommands.PRINT, "Testing Service 200: Set Mode On"))
-    mode_data = pack_mode_data(object_id, 1, 0)
+    mode_data = pack_mode_data(obj_id, 1, 0)
     command = PusTelecommand(service=200, subservice=1, ssc=2000, app_data=mode_data)
     tc_queue.appendleft(command.pack_command_tuple())
     # Set Normal mode
     tc_queue.appendleft((QueueCommands.PRINT, "Testing Service 200: Set Mode Normal"))
-    mode_data = pack_mode_data(object_id, 2, 0)
+    mode_data = pack_mode_data(obj_id, 2, 0)
     command = PusTelecommand(service=200, subservice=1, ssc=2010, app_data=mode_data)
     tc_queue.appendleft(command.pack_command_tuple())
     # Set Raw Mode
     tc_queue.appendleft((QueueCommands.PRINT, "Testing Service 200: Set Mode Raw"))
-    mode_data = pack_mode_data(object_id, 3, 0)
+    mode_data = pack_mode_data(obj_id, 3, 0)
     command = PusTelecommand(service=200, subservice=1, ssc=2020, app_data=mode_data)
     tc_queue.appendleft(command.pack_command_tuple())
     # Set Off Mode
     tc_queue.appendleft((QueueCommands.PRINT, "Testing Service 200: Set Mode Off"))
-    mode_data = pack_mode_data(object_id, 0, 0)
+    mode_data = pack_mode_data(obj_id, 0, 0)
     command = PusTelecommand(service=200, subservice=1, ssc=2030, app_data=mode_data)
     tc_queue.appendleft(command.pack_command_tuple())
     tc_queue.appendleft((QueueCommands.EXPORT_LOG, "log/tmtc_log_service200.txt"))
     return tc_queue
-
-
-# Mode 0: Off, Mode 1: Mode On, Mode 2: Mode Normal, Mode 3: Mode Raw
-def pack_mode_data(object_id: bytearray, mode_: int, submode_: int) -> bytearray:
-    # Normal mode
-    mode = struct.pack(">I", mode_)
-    # Submode default
-    submode = struct.pack('B', submode_)
-    mode_data = object_id + mode + submode
-    return mode_data

pus_tc/solar_array_deployment.py

@@ -1,20 +1,20 @@
 # -*- coding: utf-8 -*-
 """
-@file   tmtcc_tc_solar_array_deployment.py
+@file   solar_array_deployment.py
 @brief  The test function in this file simply returns a command which triggers the solar array deployment.
 @author J. Meier
 @date   15.02.2021
 """
-from tmtc_core.core.tmtc_core_definitions import QueueCommands
-from tmtc_core.pus_tc.tmtcc_pus_tc_packer import TcQueueT
-from tmtc_core.pus_tc.tmtcc_pus_tc_base import PusTelecommand
+from tmtccmd.config.definitions import QueueCommands
+from tmtccmd.pus_tc.definitions import TcQueueT
+from tmtccmd.pus_tc.packer import PusTelecommand
 
 
 class ActionIds:
     DEPLOY_SOLAR_ARRAYS = bytearray([0x0, 0x0, 0x0, 0x5])
 
 
-def pack_solar_array_deployment_test_into(object_id: bytearray, tc_queue: TcQueueT) -> TcQueueT:
+def pack_solar_array_deployment_test_into(object_id: bytearray, tc_queue: TcQueueT):
     tc_queue.appendleft((QueueCommands.PRINT, "Testing S/A Deployment"))
 
     command = object_id + ActionIds.DEPLOY_SOLAR_ARRAYS

pus_tc/syrlinks_hk_handler.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+"""
+@file   syrlinks_hk_handler.py
+@brief  Syrlinks Hk Handler tests
+@author J. Meier
+@date   13.12.2020
+"""
+
+from tmtccmd.config.definitions import QueueCommands
+from tmtccmd.pus_tc.definitions import TcQueueT
+from tmtccmd.pus_tc.service_3_housekeeping import make_sid, generate_one_hk_command
+
+
+class SetIds:
+    RX_REGISTERS_DATASET = 1
+    TX_REGISTERS_DATASET = 2
+
+
+def pack_syrlinks_hk_handler_test_into(object_id: bytearray, tc_queue: TcQueueT):
+    tc_queue.appendleft((QueueCommands.PRINT, "Syrlinks: Get RX Registers"))
+    sid = make_sid(object_id, SetIds.RX_REGISTERS_DATASET)
+    command = generate_one_hk_command(sid, 200)
+    tc_queue.appendleft(command.pack_command_tuple())
+
+    tc_queue.appendleft((QueueCommands.PRINT, "Syrlinks: Get TX Registers"))
+    sid = make_sid(object_id, SetIds.TX_REGISTERS_DATASET)
+    command = generate_one_hk_command(sid, 201)
+    tc_queue.appendleft(command.pack_command_tuple())

pus_tc/tc_packer_hook.py

@@ -0,0 +1,81 @@
+"""
+@brief      This file transfers control of TC packing to the user
+@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
+            it to your needs.
+"""
+
+import os
+from collections import deque
+from typing import Union
+
+from tmtccmd.config.definitions import CoreServiceList
+from tmtccmd.utility.logger import get_logger
+from tmtccmd.pus_tc.definitions import TcQueueT
+from tmtccmd.pus_tc.service_5_event import pack_generic_service5_test_into
+from tmtccmd.pus_tc.service_17_test import pack_service17_ping_command
+
+from pus_tc.p60dock import pack_p60dock_test_into
+from pus_tc.pdu2 import pack_pdu2_test_into
+from pus_tc.pdu1 import pack_pdu1_test_into
+from pus_tc.acu import pack_acu_test_into
+from pus_tc.imtq import pack_imtq_test_into
+from pus_tc.tmp1075 import pack_tmp1075_test_into
+from pus_tc.ploc import pack_ploc_test_into
+from pus_tc.heater import pack_heater_test_into
+from config.definitions import CustomServiceList
+from config.object_ids import P60_DOCK_HANDLER, PDU_1_HANDLER_ID, PDU_2_HANDLER_ID, ACU_HANDLER_ID, \
+    TMP_1075_1_HANDLER_ID, TMP_1075_2_HANDLER_ID, HEATER_ID, IMTQ_HANDLER_ID, PLOC_ID
+
+
+LOGGER = get_logger()
+
+
+def pack_service_queue_user(service: Union[str, int], op_code: str, service_queue: TcQueueT):
+    if service == CoreServiceList.SERVICE_5.value:
+        return pack_generic_service5_test_into(tc_queue=service_queue)
+    if service == CoreServiceList.SERVICE_17.value:
+        return service_queue.appendleft(pack_service17_ping_command(ssc=1700).pack_command_tuple())
+    if service == CustomServiceList.P60DOCK.value:
+        object_id = P60_DOCK_HANDLER
+        return pack_p60dock_test_into(object_id=object_id, tc_queue=service_queue)
+    if service == CustomServiceList.PDU1.value:
+        pdu1_object_id = PDU_1_HANDLER_ID
+        p60dock_object_id = P60_DOCK_HANDLER
+        return pack_pdu1_test_into(
+            pdu1_object_id=pdu1_object_id, p60dock_object_id=p60dock_object_id, tc_queue=service_queue
+        )
+    if service == CustomServiceList.PDU2.value:
+        pdu2_object_id = PDU_2_HANDLER_ID
+        p60dock_object_id = P60_DOCK_HANDLER
+        return pack_pdu2_test_into(
+            pdu2_object_id=pdu2_object_id, p60dock_object_id=p60dock_object_id, tc_queue=service_queue
+        )
+    if service == CustomServiceList.ACU.value:
+        object_id = ACU_HANDLER_ID
+        return pack_acu_test_into(object_id=object_id, tc_queue=service_queue)
+    if service == CustomServiceList.TMP1075_1.value:
+        object_id = TMP_1075_1_HANDLER_ID
+        return pack_tmp1075_test_into(object_id=object_id, tc_queue=service_queue, op_code=op_code)
+    if service == CustomServiceList.TMP1075_2.value:
+        object_id = TMP_1075_2_HANDLER_ID
+        return pack_tmp1075_test_into(object_id=object_id, tc_queue=service_queue, op_code=op_code)
+    if service == CustomServiceList.HEATER.value:
+        object_id = HEATER_ID
+        return pack_heater_test_into(object_id=object_id, tc_queue=service_queue)
+    if service == CustomServiceList.IMTQ.value:
+        object_id = IMTQ_HANDLER_ID
+        return pack_imtq_test_into(object_id=object_id, tc_queue=service_queue, op_code=op_code)
+    if service == CustomServiceList.PLOC.value:
+        object_id = PLOC_ID
+        return pack_ploc_test_into(object_id=object_id, tc_queue=service_queue)
+
+    LOGGER.warning("Invalid Service !")
+
+
+def create_total_tc_queue_user() -> TcQueueT:
+    if not os.path.exists("log"):
+        os.mkdir("log")
+    tc_queue = deque()
+    pack_generic_service5_test_into(tc_queue)
+    tc_queue.appendleft(pack_service17_ping_command(ssc=1700).pack_command_tuple())
+    return tc_queue

pus_tc/tmp1075.py

@@ -1,14 +1,15 @@
 # -*- coding: utf-8 -*-
 """
-@file   tmtcc_tc_tmp1075.py
+@file   tmp1075.py
 @brief  TMP1075 tests
 @author J. Meier
 @date   06.01.2021
 """
+from tmtccmd.config.definitions import QueueCommands
 
-from tmtc_core.pus_tc.tmtcc_pus_tc_packer import TcQueueT
-from tmtc_core.pus_tc.tmtcc_pus_tc_base import PusTelecommand
-from pus_tc.tmtcc_tc_service200_mode import pack_mode_data
+from tmtccmd.pus_tc.packer import TcQueueT
+from tmtccmd.ecss.tc import PusTelecommand
+from pus_tc.service_200_mode import pack_mode_data
 
 
 class Tmp1075TestProcedure:
@@ -29,30 +30,32 @@ class Tmp1075ActionIds:
     start_adc_conversion = bytearray([0x0, 0x0, 0x0, 0x02])
 
 
-def pack_tmp1075_test_into(object_id: bytearray, tc_queue: TcQueueT) -> TcQueueT:
-    tc_queue.appendleft(("print", "Testing Tmp1075 Temperature Sensor Handler with object id: 0x" +
-                         object_id.hex()))
+def pack_tmp1075_test_into(object_id: bytearray, op_code:  str, tc_queue: TcQueueT) -> TcQueueT:
+    tc_queue.appendleft(
+        (QueueCommands.PRINT,
+         "Testing Tmp1075 Temperature Sensor Handler with object id: 0x" + object_id.hex())
+    )
 
     if Tmp1075TestProcedure.all or Tmp1075TestProcedure.start_adc_conversion:
-        tc_queue.appendleft(("print", "TMP1075: Starting new temperature conversion"))
+        tc_queue.appendleft((QueueCommands.PRINT, "TMP1075: Starting new temperature conversion"))
         command = object_id + Tmp1075ActionIds.start_adc_conversion
         command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
         tc_queue.appendleft(command.pack_command_tuple())
 
     if Tmp1075TestProcedure.all or Tmp1075TestProcedure.get_temp:
-        tc_queue.appendleft(("print", "TMP1075: Read temperature"))
+        tc_queue.appendleft((QueueCommands.PRINT, "TMP1075: Read temperature"))
         command = object_id + Tmp1075ActionIds.get_temp
         command = PusTelecommand(service=8, subservice=128, ssc=24, app_data=command)
         tc_queue.appendleft(command.pack_command_tuple())
 
     if Tmp1075TestProcedure.set_mode_normal:
-        tc_queue.appendleft(("print", "TMP1075: Set Mode Normal"))
+        tc_queue.appendleft((QueueCommands.PRINT, "TMP1075: Set Mode Normal"))
         mode_data = pack_mode_data(object_id, 2, 0)
         command = PusTelecommand(service=200, subservice=1, ssc=220, app_data=mode_data)
         tc_queue.appendleft(command.pack_command_tuple())
 
     if Tmp1075TestProcedure.set_mode_on:
-        tc_queue.appendleft(("print", "TMP1075: Set Mode On"))
+        tc_queue.appendleft((QueueCommands.PRINT, "TMP1075: Set Mode On"))
         mode_data = pack_mode_data(object_id, 1, 0)
         command = PusTelecommand(service=200, subservice=1, ssc=221, app_data=mode_data)
         tc_queue.appendleft(command.pack_command_tuple())

pus_tc/tmtcc_tc_packer_hook.py

@@ -1,68 +0,0 @@
-"""
-@brief      This file transfers control of TC packing to the user
-@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
-            it to your needs.
-"""
-
-import os
-from collections import deque
-
-from config.tmtcc_definitions import ServiceList
-from tmtc_core.utility.tmtcc_logger import get_logger
-from tmtc_core.pus_tc.tmtcc_pus_tc_base import TcQueueT
-from tmtc_core.pus_tc.tmtcc_tc_service_5_event import pack_generic_service5_test_into
-from tmtc_core.pus_tc.tmtcc_tc_service_17_test import pack_service17_ping_command
-from pus_tc.tmtcc_tc_p60dock import pack_p60dock_test_into
-from pus_tc.tmtcc_tc_pdu2 import pack_pdu2_test_into
-from pus_tc.tmtcc_tc_pdu1 import pack_pdu1_test_into
-from pus_tc.tmtcc_tc_acu import pack_acu_test_into
-from tmtc_core.core.tmtcc_object_id_manager import get_object_id
-from config.tmtcc_object_ids import ObjectIds
-from pus_tc.tmtcc_tc_tmp1075 import pack_tmp1075_test_into
-from pus_tc.tmtcc_tc_heater import pack_heater_test_into
-from pus_tc.tmtcc_tc_solar_array_deployment import pack_solar_array_deployment_test_into
-
-LOGGER = get_logger()
-
-
-def pack_service_queue_user(service: ServiceList, op_code: str, service_queue: TcQueueT):
-    if service == ServiceList.SERVICE_5:
-        return pack_generic_service5_test_into(service_queue)
-    if service == ServiceList.SERVICE_17:
-        return service_queue.appendleft(pack_service17_ping_command(ssc=1700).pack_command_tuple())
-    if service == ServiceList.P60DOCK:
-        object_id = get_object_id(ObjectIds.P60DOCK_HANDLER_ID)
-        return pack_p60dock_test_into(object_id, service_queue)
-    if service == ServiceList.PDU1:
-        pdu1_object_id = get_object_id(ObjectIds.PDU1_HANDLER_ID)
-        p60dock_object_id = get_object_id(ObjectIds.P60DOCK_HANDLER_ID)
-        return pack_pdu1_test_into(pdu1_object_id, p60dock_object_id, service_queue)
-    if service == ServiceList.PDU2:
-        pdu2_object_id = get_object_id(ObjectIds.PDU2_HANDLER_ID)
-        p60dock_object_id = get_object_id(ObjectIds.P60DOCK_HANDLER_ID)
-        return pack_pdu2_test_into(pdu2_object_id, p60dock_object_id, service_queue)
-    if service == ServiceList.ACU:
-        object_id = get_object_id(ObjectIds.ACU_HANDLER_ID)
-        return pack_acu_test_into(object_id, service_queue)
-    if service == ServiceList.TMP1075_1:
-        object_id = get_object_id(ObjectIds.TMP1075_1_HANDLER_ID)
-        return pack_tmp1075_test_into(object_id, service_queue)
-    if service == ServiceList.TMP1075_2:
-        object_id = get_object_id(ObjectIds.TMP1075_2_HANDLER_ID)
-        return pack_tmp1075_test_into(object_id, service_queue)
-    if service == ServiceList.HEATER:
-        object_id = get_object_id(ObjectIds.HEATER)
-        return pack_heater_test_into(object_id, service_queue)
-    if service == ServiceList.SA_DEPL:
-        object_id = get_object_id(ObjectIds.SOLAR_ARRAY_DEPLOYMENT_HANDLER)
-        return pack_solar_array_deployment_test_into(object_id, service_queue)
-    LOGGER.warning("Invalid Service !")
-
-
-def create_total_tc_queue_user() -> TcQueueT:
-    if not os.path.exists("log"):
-        os.mkdir("log")
-    tc_queue = deque()
-    pack_generic_service5_test_into(tc_queue)
-    tc_queue.appendleft(pack_service17_ping_command(ssc=1700).pack_command_tuple())
-    return tc_queue

pus_tc/tmtcc_tc_pdu1.py

@@ -1,48 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-@file   tmtcc_tc_pdu1.py
-@brief  PDU2 tests
-@author J. Meier
-@date   17.12.2020
-"""
-
-from tmtc_core.pus_tc.tmtcc_pus_tc_packer import TcQueueT
-from tmtc_core.pus_tc.tmtcc_pus_tc_base import PusTelecommand
-from gomspace.gomspace_common import *
-from pus_tc.tmtcc_tc_p60dock import P60DockConfigTable
-from gomspace.gomspace_pdu_definitions import *
-
-
-class PDU1TestProcedure:
-    """
-    @brief  Use this class to define the tests to perform for the PDU2.
-    @details    Setting all to True will run all tests.
-                Setting all to False will only run the tests set to True.
-    """
-    all = False
-    reboot = False
-    ping = False
-    read_temperature = False
-
-
-def pack_pdu1_test_into(pdu1_object_id: bytearray, p60dock_object_id: bytearray, tc_queue: TcQueueT) -> TcQueueT:
-    tc_queue.appendleft(("print", "Testing PDU1"))
-
-    tc_queue.appendleft(("print", "P60 Dock: Enabling PDU1"))
-    command = pack_set_param_command(p60dock_object_id, P60DockConfigTable.out_en_1.parameter_address,
-                                     P60DockConfigTable.out_en_1.parameter_size, Channel.on)
-    command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
-    tc_queue.appendleft(command.pack_command_tuple())
-
-    if PDU1TestProcedure.all or PDU1TestProcedure.ping:
-        tc_queue.appendleft(("print", "PDU1: Ping Test"))
-        ping_data = bytearray([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
-        command = pack_ping_command(pdu1_object_id, ping_data)
-        command = PusTelecommand(service=8, subservice=128, ssc=22, app_data=command)
-        tc_queue.appendleft(command.pack_command_tuple())
-    if PDU1TestProcedure.all or PDU1TestProcedure.read_temperature:
-        tc_queue.appendleft(("print", "PDU1: Testing  temperature reading"))
-        command = pack_get_param_command(pdu1_object_id, TableIds.hk, PDUHkTable.temperature.parameter_address,
-                                         PDUHkTable.temperature.parameter_size)
-        command = PusTelecommand(service=8, subservice=128, ssc=24, app_data=command)
-        tc_queue.appendleft(command.pack_command_tuple())

pus_tm/factory_hook.py

@@ -0,0 +1,42 @@
+"""
+@brief      This file transfers control of TM parsing to the user
+@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
+            it to your needs.
+"""
+from tmtccmd.pus_tm.service_8_functional_cmd import Service8TM
+from tmtccmd.ecss.tm import PusTelemetry
+from tmtccmd.utility.logger import get_logger
+
+from tmtccmd.pus_tm.service_1_verification import Service1TM
+from tmtccmd.pus_tm.service_3_housekeeping import Service3TM
+from tmtccmd.pus_tm.service_5_event import Service5TM
+from tmtccmd.pus_tm.service_17_test import Service17TM
+from tmtccmd.utility.tmtc_printer import TmTcPrinter
+
+from config.definitions import PUS_APID
+
+LOGGER = get_logger()
+
+
+def ccsds_tm_handler(apid: int, raw_tm_packet: bytearray, tmtc_printer: TmTcPrinter) -> None:
+    if apid == PUS_APID:
+        pus_factory_hook(raw_tm_packet=raw_tm_packet, tmtc_printer=tmtc_printer)
+
+
+def pus_factory_hook(raw_tm_packet: bytearray, tmtc_printer: TmTcPrinter):
+    service_type = raw_tm_packet[7]
+    tm_packet = None
+    if service_type == 1:
+        tm_packet = Service1TM(raw_tm_packet)
+    if service_type == 3:
+        tm_packet = Service3TM(raw_tm_packet)
+    if service_type == 5:
+        tm_packet = Service5TM(raw_tm_packet)
+    if service_type == 8:
+        tm_packet = Service8TM(raw_tm_packet)
+    if service_type == 17:
+        tm_packet = Service17TM(raw_tm_packet)
+    if tm_packet is None:
+        LOGGER.info(f'The service {service_type} is not implemented in Telemetry Factory')
+        tm_packet = PusTelemetry(raw_tm_packet)
+    tmtc_printer.print_telemetry(packet=tm_packet)

pus_tm/hk_handling.py

@@ -0,0 +1,157 @@
+"""
+@brief      This file transfers control of housekeeping handling (PUS service 3) to the
+            developer
+@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
+            it to your needs.
+"""
+import struct
+from typing import Tuple
+
+from tmtccmd.pus_tm.service_3_housekeeping import Service3Base
+from tmtccmd.utility.logger import get_logger
+from pus_tc.syrlinks_hk_handler import SetIds
+from pus_tc.imtq import ImtqSetIds
+from config.object_ids import SYRLINKS_HANDLER, IMTQ_HANDLER_ID
+LOGGER = get_logger()
+
+
+def handle_user_hk_packet(object_id: bytes, set_id: int, hk_data: bytearray,
+                          service3_packet: Service3Base) -> Tuple[list, list, bytearray, int]:
+    """
+    This function is called when a Service 3 Housekeeping packet is received.
+
+    Please note that the object IDs should be compared by value because direct comparison of
+    enumerations does not work in Python. For example use:
+
+        if object_id.value == ObjectIds.TEST_OBJECT.value
+
+    to test equality based on the object ID list.
+
+    @param object_id:
+    @param set_id:
+    @param hk_data:
+    @param service3_packet:
+    @return: Expects a tuple, consisting of two lists, a bytearray and an integer
+    The first list contains the header columns, the second list the list with
+    the corresponding values. The bytearray is the validity buffer, which is usually appended
+    at the end of the housekeeping packet. The last value is the number of parameters.
+    """
+    if object_id == SYRLINKS_HANDLER:
+        if set_id == SetIds.RX_REGISTERS_DATASET:
+            return handle_syrlinks_rx_registers_dataset(hk_data)
+        elif set_id == SetIds.TX_REGISTERS_DATASET:
+            return handle_syrlinks_tx_registers_dataset(hk_data)
+        else:
+            LOGGER.info("Serive 3 TM: Syrlinks handler reply with unknown set id")
+            return [], [], bytearray(), 0
+    elif object_id == IMTQ_HANDLER_ID:
+        if (set_id >= ImtqSetIds.POSITIVE_X_TEST) and (set_id <= ImtqSetIds.NEGATIVE_Z_TEST):
+            return handle_self_test_data(hk_data)
+        else:
+            LOGGER.info("Serive 3 TM: Syrlinks handler reply with unknown set id")
+            return [], [], bytearray(), 0
+    else:
+        LOGGER.info("Service 3 TM: Parsing for this SID has not been implemented.")
+        return [], [], bytearray(), 0
+
+
+def handle_syrlinks_rx_registers_dataset(hk_data: bytearray) -> Tuple[list, list, bytearray, int]:
+    hk_header = []
+    hk_content = []
+    validity_buffer = bytearray()
+    hk_header = ["RX Status", "RX Sensitivity", "RX Frequency Shift", "RX IQ Power", "RX AGC Value", "RX Demod Eb",
+                 "RX Demod N0", "RX Datarate"]
+    rx_status = hk_data[0]
+    rx_sensitivity = struct.unpack('!I', hk_data[1:5])
+    rx_frequency_shift = struct.unpack('!I', hk_data[5:9])
+    rx_iq_power = struct.unpack('!H', hk_data[9:11])
+    rx_agc_value = struct.unpack('!H', hk_data[11:13])
+    rx_demod_eb = struct.unpack('!I', hk_data[13:17])
+    rx_demod_n0 = struct.unpack('!I', hk_data[17:21])
+    rx_data_rate = hk_data[21]
+    hk_content = [rx_status, rx_sensitivity, rx_frequency_shift, rx_iq_power, rx_agc_value, rx_demod_eb, rx_demod_n0,
+                  rx_data_rate]
+    return hk_header, hk_content, validity_buffer, 8
+
+
+def handle_syrlinks_tx_registers_dataset(hk_data: bytearray) -> Tuple[list, list, bytearray, int]:
+    hk_header = []
+    hk_content = []
+    validity_buffer = bytearray()
+    hk_header = ["TX Status", "TX Waveform", "TX AGC value"]
+    tx_status = hk_data[0]
+    tx_waveform = hk_data[1]
+    tx_agc_value = struct.unpack('!H', hk_data[2:4])
+    hk_content = [tx_status,  tx_waveform, tx_agc_value]
+    return hk_header, hk_content, validity_buffer, 3
+
+
+def handle_self_test_data(hk_data: bytearray) -> Tuple[list, list, bytearray, int]:
+    hk_header = []
+    hk_content = []
+    validity_buffer = bytearray()
+    hk_header = ["Init Err", "Init Raw Mag X [nT]", "Init Raw Mag Y [nT]", "Init Raw Mag Z [nT]", "Init Cal Mag X [nT]",
+                 "Init Cal Mag Y [nT]", "Init Cal Mag Z [nT]", "Init Coil X Current [mA]", "Init Coil Y Current [mA]",
+                 "Init Coil Z Current [mA]", "Init Coil X Temperature [°C]", "Init Coil Y Temperature [°C]",
+                 "Init Coil Z Temperature [°C]", "Err", "Raw Mag X [nT]", "Raw Mag Y [nT]", "Raw Mag Z [nT]",
+                 "Cal Mag X [nT]", "Cal Mag Y [nT]", "Cal Mag Z [nT]", "Coil X Current [mA]", "Coil Y Current [mA]",
+                 "Coil Z Current [mA]", "Coil X Temperature [°C]", "Coil Y Temperature [°C]", "Coil Z Temperature [°C]",
+                 "Fina Err", "Fina Raw Mag X [nT]", "Fina Raw Mag Y [nT]", "Fina Raw Mag Z [nT]", "Fina Cal Mag X [nT]",
+                 "Fina Cal Mag Y [nT]", "Fina Cal Mag Z [nT]", "Fina Coil X Current [mA]", "Fina Coil Y Current [mA]",
+                 "Fina Coil Z Current [mA]", "Fina Coil X Temperature [°C]", "Fina Coil Y Temperature [°C]",
+                 "Fina Coil Z Temperature [°C]"]
+    # INIT step (no coil actuation)
+    init_err = hk_data[0]
+    init_raw_mag_x = struct.unpack('!f', hk_data[1:5])[0]
+    init_raw_mag_y = struct.unpack('!f', hk_data[5:9])[0]
+    init_raw_mag_z = struct.unpack('!f', hk_data[9:13])[0]
+    init_cal_mag_x = struct.unpack('!f', hk_data[13:17])[0]
+    init_cal_mag_y = struct.unpack('!f', hk_data[17:21])[0]
+    init_cal_mag_z = struct.unpack('!f', hk_data[21:25])[0]
+    init_coil_x_current = struct.unpack('!f', hk_data[25:29])[0]
+    init_coil_y_current = struct.unpack('!f', hk_data[29:33])[0]
+    init_coil_z_current = struct.unpack('!f', hk_data[33:37])[0]
+    init_coil_x_temperature = struct.unpack('!H', hk_data[37:39])[0]
+    init_coil_y_temperature = struct.unpack('!H', hk_data[39:41])[0]
+    init_coil_z_temperature = struct.unpack('!H', hk_data[41:43])[0]
+
+    # Actuation step
+    err = hk_data[43]
+    raw_mag_x = struct.unpack('!f', hk_data[44:48])[0]
+    raw_mag_y = struct.unpack('!f', hk_data[48:52])[0]
+    raw_mag_z = struct.unpack('!f', hk_data[52:56])[0]
+    cal_mag_x = struct.unpack('!f', hk_data[56:60])[0]
+    cal_mag_y = struct.unpack('!f', hk_data[60:64])[0]
+    cal_mag_z = struct.unpack('!f', hk_data[64:68])[0]
+    coil_x_current = struct.unpack('!f', hk_data[68:72])[0]
+    coil_y_current = struct.unpack('!f', hk_data[72:76])[0]
+    coil_z_current = struct.unpack('!f', hk_data[76:80])[0]
+    coil_x_temperature = struct.unpack('!H', hk_data[80:82])[0]
+    coil_y_temperature = struct.unpack('!H', hk_data[82:84])[0]
+    coil_z_temperature = struct.unpack('!H', hk_data[84:86])[0]
+
+    # FINA step (no coil actuation)
+    fina_err = hk_data[86]
+    fina_raw_mag_x = struct.unpack('!f', hk_data[87:91])[0]
+    fina_raw_mag_y = struct.unpack('!f', hk_data[91:95])[0]
+    fina_raw_mag_z = struct.unpack('!f', hk_data[95:99])[0]
+    fina_cal_mag_x = struct.unpack('!f', hk_data[99:103])[0]
+    fina_cal_mag_y = struct.unpack('!f', hk_data[103:107])[0]
+    fina_cal_mag_z = struct.unpack('!f', hk_data[107:111])[0]
+    fina_coil_x_current = struct.unpack('!f', hk_data[111:115])[0]
+    fina_coil_y_current = struct.unpack('!f', hk_data[115:119])[0]
+    fina_coil_z_current = struct.unpack('!f', hk_data[119:123])[0]
+    fina_coil_x_temperature = struct.unpack('!H', hk_data[123:125])[0]
+    fina_coil_y_temperature = struct.unpack('!H', hk_data[125:127])[0]
+    fina_coil_z_temperature = struct.unpack('!H', hk_data[127:129])[0]
+
+    hk_content = [init_err, init_raw_mag_x, init_raw_mag_y, init_raw_mag_z, init_cal_mag_x, init_cal_mag_y,
+                  init_cal_mag_z, init_coil_x_current, init_coil_y_current, init_coil_z_current,
+                  init_coil_x_temperature, init_coil_y_temperature, init_coil_z_temperature, err, raw_mag_x,
+                  init_raw_mag_y, raw_mag_z, cal_mag_x, cal_mag_y, cal_mag_z, coil_x_current, coil_y_current,
+                  coil_z_current, coil_x_temperature, coil_y_temperature, coil_z_temperature, fina_err, fina_raw_mag_x,
+                  fina_raw_mag_y, fina_raw_mag_z, fina_cal_mag_x, fina_cal_mag_y, fina_cal_mag_z, fina_coil_x_current,
+                  fina_coil_y_current, fina_coil_z_current, fina_coil_x_temperature, fina_coil_y_temperature,
+                  fina_coil_z_temperature]
+
+    return hk_header, hk_content, validity_buffer, len(hk_header)

pus_tm/service_8_hook.py

@@ -0,0 +1,58 @@
+import struct
+from typing import Tuple
+from config.object_ids import *
+from pus_tc.imtq import ImtqActionIds
+from pus_tc.ploc import PlocReplyIds
+
+
+def user_analyze_service_8_data(
+        object_id: bytes, action_id: int, custom_data: bytearray) -> Tuple[list, list]:
+    """
+    This function is called by the TMTC core if a Service 8 data reply (subservice 130)
+    is received. The user can return a tuple of two lists, where the first list
+    is a list of header strings to print and the second list is a list of values to print.
+    The TMTC core will take care of printing both lists and logging them.
+
+    @param object_id:
+    @param action_id:
+    @param custom_data:
+    @return:
+    """
+    if object_id == PDU_2_HANDLER_ID:
+        header_list = ['PDU2 Service 8 Reply']
+
+        data_string = str()
+        for index in range(len(custom_data)):
+            data_string += str(hex(custom_data[index])) + " , "
+        data_string = data_string.rstrip()
+        data_string = data_string.rstrip(',')
+        data_string = data_string.rstrip()
+        content_list = [data_string]
+    elif object_id == IMTQ_HANDLER_ID:
+        return handle_imtq_replies(action_id, custom_data)
+    elif object_id == PLOC_ID:
+        return handle_ploc_replies(action_id, custom_data)
+    else:
+        header_list = []
+        content_list = []
+    return header_list, content_list
+
+
+def handle_imtq_replies(action_id: int, custom_data: bytearray) -> Tuple[list, list]:
+    header_list = []
+    content_list = []
+    if action_id == struct.unpack('!I', ImtqActionIds.get_commanded_dipole)[0]:
+        header_list = ['Commanded X-Dipole', 'Commanded Y-Dipole', 'Commanded Z-Dipole']
+        x_dipole = struct.unpack('!H', custom_data[:2])
+        y_dipole = struct.unpack('!H', custom_data[2:4])
+        z_dipole = struct.unpack('!H', custom_data[4:6])
+        content_list = [x_dipole[0], y_dipole[0], z_dipole[0]]
+
+
+def handle_ploc_replies(action_id: int, custom_data: bytearray) -> Tuple[list, list]:
+    header_list = []
+    content_list = []
+    if action_id == PlocReplyIds.tm_mem_read_report:
+        header_list = ['PLOC Memory Address', 'PLOC Mem Len', 'PLOC Read Memory Data']
+        content_list = [custom_data[:4], custom_data[4:6], custom_data[6:10]]
+    return header_list, content_list

pus_tm/tmtcc_pus_hk_handling.py

@@ -1,26 +0,0 @@
-"""
-@brief      This file transfers control of housekeeping handling (PUS service 3) to the
-            developer
-@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
-            it to your needs.
-"""
-from typing import Tuple
-
-from tmtc_core.pus_tm.tmtcc_pus_service_3 import Service3Base
-from tmtc_core.utility.tmtcc_logger import get_logger
-
-LOGGER = get_logger()
-
-
-def handle_user_hk_packet(
-        object_id: bytearray, hk_data: bytearray,
-        service3_packet: Service3Base) -> Tuple[list, list, bytearray]:
-    """
-    This function is called when a Service 3 Housekeeping packet is received.
-    @param object_id:
-    @param hk_data:
-    @param service3_packet:
-    @return:
-    """
-    LOGGER.info("Service3TM: Parsing for this SID has not been implemented.")
-    return [], [], bytearray()

pus_tm/tmtcc_pus_service_8_hook.py

@@ -1,38 +0,0 @@
-from typing import Tuple
-from config.tmtcc_object_ids import ObjectIds
-
-
-def user_analyze_service_8_data(
-        object_id: ObjectIds, action_id: int, custom_data: bytearray) -> Tuple[list, list]:
-    """
-    This function is called by the TMTC core if a Service 8 data reply (subservice 130)
-    is received. The user can return a tuple of two lists, where the first list
-    is a list of header strings to print and the second list is a list of values to print.
-    The TMTC core will take care of printing both lists and logging them.
-
-    Please note that the object IDs should be compared by value because direct comparison of
-    enumerations does not work in Python. For example use:
-
-        if object_id.value == ObjectIds.TEST_OBJECT.value
-
-    to test equality based on the object ID list.
-
-    @param object_id:
-    @param action_id:
-    @param custom_data:
-    @return:
-    """
-    if object_id.value == ObjectIds.PDU2_HANDLER_ID.value:
-        header_list = ['PDU2 Service 8 Reply']
-
-        data_string = str()
-        for index in range(len(custom_data)):
-            data_string += str(hex(custom_data[index])) + " , "
-        data_string = data_string.rstrip()
-        data_string = data_string.rstrip(',')
-        data_string = data_string.rstrip()
-        content_list = [data_string]
-    else:
-        header_list = []
-        content_list = []
-    return header_list, content_list

pus_tm/tmtcc_pus_tm_factory_hook.py

@@ -1,29 +0,0 @@
-"""
-@brief      This file transfers control of TM parsing to the user
-@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
-            it to your needs.
-"""
-from tmtc_core.pus_tm.tmtcc_pus_service_8 import Service8TM
-from tmtc_core.pus_tm.tmtcc_pus_tm_base import PusTelemetry
-from tmtc_core.utility.tmtcc_logger import get_logger
-
-from tmtc_core.pus_tm.tmtcc_tm_service1 import Service1TM
-from tmtc_core.pus_tm.tmtcc_tm_service5 import Service5TM
-from tmtc_core.pus_tm.tmtcc_tm_service17 import Service17TM
-
-LOGGER = get_logger()
-
-
-def tm_user_factory_hook(raw_tm_packet: bytearray) -> PusTelemetry:
-    service_type = raw_tm_packet[7]
-    if service_type == 1:
-        return Service1TM(raw_tm_packet)
-    if service_type == 5:
-        return Service5TM(raw_tm_packet)
-    if service_type == 8:
-        service8tm = Service8TM(raw_tm_packet)
-        return Service8TM(raw_tm_packet)
-    if service_type == 17:
-        return Service17TM(raw_tm_packet)
-    LOGGER.info("The service " + str(service_type) + " is not implemented in Telemetry Factory")
-    return PusTelemetry(raw_tm_packet)

requirements.txt

@@ -1,4 +1 @@
-crcmod>=1.7
-PyQt5>=5.15.1
-PyQt5-stubs>=5.14.2.2
-pyserial>=3.4
+tmtccmd>=1.0.0

tmtc_client_cli.py

@@ -16,7 +16,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-   http://www.apache.org/licenses/LICENSE-2.0
+   https://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -26,11 +26,30 @@ limitations under the License.
 
 @author     R. Mueller
 """
-from tmtc_core.tmtcc_runner import run_tmtc_client
+import sys
+
+from config.hook_implementations import EiveHookObject
+from config.definitions import PUS_APID
+from pus_tm.factory_hook import ccsds_tm_handler
+try:
+    from tmtccmd.runner import initialize_tmtc_commander, run_tmtc_commander, add_ccsds_handler
+    from tmtccmd.ccsds.handler import CcsdsTmHandler
+except ImportError as error:
+    run_tmtc_commander = None
+    initialize_tmtc_commander = None
+    print(error)
+    print("Python tmtccmd submodule could not be imported")
+    print("Install with \"cd tmtccmd && python3 -m pip install -e .\" for interactive installation")
+    sys.exit(0)
 
 
 def main():
-    run_tmtc_client(False)
+    hook_obj = EiveHookObject()
+    initialize_tmtc_commander(hook_object=hook_obj)
+    ccsds_handler = CcsdsTmHandler()
+    ccsds_handler.add_tm_handler(apid=PUS_APID, pus_tm_handler=ccsds_tm_handler, max_queue_len=50)
+    add_ccsds_handler(ccsds_handler)
+    run_tmtc_commander(False)
 
 
 if __name__ == "__main__":

tmtc_client_gui.py

@@ -16,7 +16,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-   http://www.apache.org/licenses/LICENSE-2.0
+   https://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -26,11 +26,14 @@ limitations under the License.
 
 @author     R. Mueller
 """
-from tmtc_core.tmtcc_runner import run_tmtc_client
+from config.hook_implementations import EiveHookObject
+from tmtccmd.runner import initialize_tmtc_commander, run_tmtc_commander
 
 
 def main():
-    run_tmtc_client(True)
+    hook_obj = EiveHookObject()
+    initialize_tmtc_commander(hook_object=hook_obj)
+    run_tmtc_commander(True)
 
 
 if __name__ == "__main__":

utility/args_parser.py

@@ -0,0 +1,11 @@
+
+
+def parse_input_arguments_user(print_known_args: bool = False, print_unknown_args: bool = False):
+    """
+    This function by default will build the default argument parser. A custom CLI parser can be
+    built in this function if required.
+    """
+    from tmtccmd.config.args import parse_default_input_arguments
+    parse_default_input_arguments(
+        print_known_args=print_known_args, print_unknown_args=print_unknown_args
+    )

utility/tmtcc_user_args_parser.py

@@ -1,15 +0,0 @@
-"""
-@brief      This file transfers control of the command line argument parsing to the user.
-@details    Template configuration file. Copy this folder to the TMTC commander root and adapt
-            it to your needs.
-"""
-
-
-def parse_input_arguments_user(print_known_args: bool = False, print_unknown_args: bool = False):
-    """
-    This function by default will build the default argument parser. A custom CLI parser can be
-    built in this function if required.
-    """
-    from tmtc_core.utility.tmtcc_core_args_parser import parse_default_input_arguments
-    parse_default_input_arguments(print_known_args=print_known_args,
-                                  print_unknown_args=print_unknown_args)