eive-tmtc/eive_tmtc/pus_tm/verification_handler.py

from typing import List, Optional

from spacepackets.ccsds import CdsShortTimestamp
from spacepackets.ecss.pus_1_verification import UnpackParams, Service1Tm
from tmtccmd.logging import get_console_logger
from tmtccmd.pus import VerificationWrapper
from tmtccmd.tm.pus_1_verification import Service1FsfwWrapper
from eive_tmtc.config.retvals import get_retval_dict

LOGGER = get_console_logger()


def handle_service_1_fsfw_packet(wrapper: VerificationWrapper, raw_tm: bytes):
    if wrapper.console_logger is None or wrapper.file_logger is None:
        raise ValueError(
            "Console logger or file logger not valid. Please set a valid one"
        )
    # Error code with length 2 is FSFW specific
    tm_packet = Service1Tm.unpack(
        data=raw_tm, params=UnpackParams(CdsShortTimestamp.empty(), 1, 2)
    )
    fsfw_wrapper = Service1FsfwWrapper(tm_packet)
    res = wrapper.verificator.add_tm(tm_packet)
    if res is None:
        LOGGER.info(
            f"Received Verification TM[{tm_packet.service}, {tm_packet.subservice}] "
            f"with Request ID {tm_packet.tc_req_id.as_u32():#08x}"
        )
        LOGGER.warning(f"No matching telecommand found for {tm_packet.tc_req_id}")
    else:
        wrapper.log_to_console(tm_packet, res)
        wrapper.log_to_file(tm_packet, res)
    if tm_packet.has_failure_notice:
        str_list = generic_retval_printout(
            tm_packet.error_code.val,
            fsfw_wrapper.error_param_1,
            fsfw_wrapper.error_param_2,
        )
        for string in str_list:
            wrapper.dlog(string)


def generic_retval_printout(
    retval: int, p1: Optional[int] = None, p2: Optional[int] = None
) -> List[str]:
    retval_dict = get_retval_dict()
    retval_info = retval_dict.get(retval)
    if retval_info is None:
        raw_err = retval
        return [
            f"No returnvalue information found for error code  with "
            f"subsystem ID {(raw_err >> 8) & 0xff} and unique ID {raw_err & 0xff}"
        ]
    else:
        retval_string = (
            f"Error Code information for code {retval:#06x} | "
            f"Name: {retval_info.name} | Info: {retval_info.info}"
        )
        string_list = [retval_string]
        if p1:
            error_param_1_str = f"Error Parameter 1: hex {p1:#010x} " f"dec {p1} "
            string_list.append(error_param_1_str)
        if p2:
            error_param_2_str = f"Error Parameter 2: hex {p2:#010x} " f"dec {p2}"
            string_list.append(error_param_2_str)
        return string_list