eive-tmtc/pus_tm/hk_handling.py

"""
@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 tmtccmd.pus_tm.service_3_base import Service3Base
from tmtccmd.utility.tmtcc_logger import get_logger

LOGGER = get_logger()


def handle_user_hk_packet(object_id: int, 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.

    @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.
    """
    LOGGER.info("Service3TM: Parsing for this SID has not been implemented.")
    return [], [], bytearray(), 0