fsfw_example_public/tmtc/config/hook_base.py

import argparse
from typing import Dict, Union, Tuple

from tmtccmd.core.hook_base import TmTcHookBase
from tmtccmd.ecss.tc import PusTelecommand
from tmtccmd.pus_tm.service_3_base import Service3Base


class FsfwHookBase(TmTcHookBase):
    from tmtccmd.com_if.com_interface_base import CommunicationInterface
    from tmtccmd.core.backend import TmTcHandler
    from tmtccmd.pus_tc.definitions import TcQueueT
    from tmtccmd.ecss.tm import PusTelemetry
    from tmtccmd.utility.tmtc_printer import TmTcPrinter

    def get_version(self) -> str:
        from config.version import SW_NAME, SW_VERSION, SW_SUBVERSION, SW_SUBSUBVERSION
        return f"{SW_NAME} {SW_VERSION}.{SW_SUBVERSION}.{SW_SUBSUBVERSION}"

    def add_globals_pre_args_parsing(self, gui: bool = False):
        from tmtccmd.defaults.globals_setup import set_default_globals_pre_args_parsing
        set_default_globals_pre_args_parsing(gui=gui, apid=0xef)

    def add_globals_post_args_parsing(self, args: argparse.Namespace, json_cfg_path: str = ""):
        from tmtccmd.defaults.globals_setup import set_default_globals_post_args_parsing
        set_default_globals_post_args_parsing(args=args, json_cfg_path=json_cfg_path)

    def assign_communication_interface(self, com_if: int, tmtc_printer: TmTcPrinter) -> \
            Union[CommunicationInterface, None]:
        from tmtccmd.defaults.com_setup import create_communication_interface_default
        return create_communication_interface_default(com_if=com_if, tmtc_printer=tmtc_printer)

    def perform_mode_operation(self, tmtc_backend: TmTcHandler, mode: int):
        print("No custom mode operation implemented")

    def pack_service_queue(self, service: int, op_code: str, service_queue: TcQueueT):
        from pus_tc.tc_packing import pack_service_queue_user
        pack_service_queue_user(service=service, op_code=op_code, service_queue=service_queue)

    def pack_total_service_queue(self) -> Union[None, TcQueueT]:
        from pus_tc.tc_packing import create_total_tc_queue_user
        return create_total_tc_queue_user()

    def tm_user_factory_hook(self, raw_tm_packet: bytearray) -> Union[None, PusTelemetry]:
        from pus_tm.factory_hook import tm_user_factory_hook
        return tm_user_factory_hook(raw_tm_packet=raw_tm_packet)

    def set_object_ids(self) -> Dict[bytes, list]:
        from config.object_ids import set_object_ids
        return set_object_ids()

    @staticmethod
    def handle_service_8_telemetry(
            object_id: int, action_id: int, custom_data: bytearray
    ) -> Tuple[list, list]:
        from pus_tm.service_8_handling import custom_service_8_handling
        return custom_service_8_handling(
            object_id=object_id, action_id=action_id, custom_data=custom_data
        )

    @staticmethod
    def handle_service_3_housekeeping(
        object_id: bytearray, set_id: int, hk_data: bytearray, service3_packet: Service3Base
    ) -> Tuple[list, list, bytearray, int]:
        from pus_tm.service_3_hk_handling import service_3_hk_handling
        return service_3_hk_handling(
            object_id=object_id, set_id=set_id, hk_data=hk_data, service3_packet=service3_packet
        )

    def command_preparation_hook(self) -> Union[None, PusTelecommand]:
        pass

    def set_json_config_file_path(self) -> str:
        return "config/tmtc_config.json"