eive-tmtc/tmtcc.py

309 lines
10 KiB
Python
Raw Normal View History

2022-07-04 18:09:24 +02:00
#!/usr/bin/env python3
2022-07-04 15:22:53 +02:00
import logging
2022-05-17 11:13:32 +02:00
import sys
2022-07-04 18:09:24 +02:00
import time
2022-05-17 11:13:32 +02:00
import traceback
2022-09-16 17:28:19 +02:00
from pathlib import Path
2022-07-04 15:22:53 +02:00
2023-08-17 11:33:42 +02:00
from eive_tmtc.cfdp.fault_handler import EiveCfdpFaultHandler
from eive_tmtc.cfdp.user import EiveCfdpUser
2022-10-21 11:28:33 +02:00
from spacepackets.ccsds import SPACE_PACKET_HEADER_SIZE
2022-09-16 17:37:01 +02:00
from spacepackets.cfdp import (
ChecksumType,
TransmissionMode,
DirectiveType,
2022-10-21 11:28:33 +02:00
PduFactory,
PduType,
2022-09-16 17:37:01 +02:00
)
2023-08-17 11:33:42 +02:00
from eive_tmtc.pus_tc.tc_handler import TcHandler
2023-02-01 11:17:04 +01:00
from tmtccmd.logging import add_colorlog_console_logger
2022-09-16 17:28:19 +02:00
from tmtccmd.cfdp.handler import CfdpInCcsdsHandler
2022-09-16 17:37:01 +02:00
from tmtccmd.cfdp.mib import (
LocalEntityCfg,
IndicationCfg,
RemoteEntityCfg,
)
2022-07-14 15:45:57 +02:00
2022-05-17 11:13:32 +02:00
try:
import spacepackets
except ImportError as error:
print(error)
print("Python spacepackets module could not be imported")
print(
'Install with "cd spacepackets && python3 -m pip intall -e ." for interative installation'
)
sys.exit(1)
try:
2022-07-04 18:14:51 +02:00
import tmtccmd
2023-06-19 17:16:00 +02:00
except ImportError:
2022-05-17 11:13:32 +02:00
run_tmtc_commander = None
initialize_tmtc_commander = None
tb = traceback.format_exc()
print(tb)
print("Python tmtccmd submodule could not be imported")
sys.exit(1)
2022-07-04 18:14:51 +02:00
from spacepackets.ecss import PusVerificator
2023-08-17 11:33:42 +02:00
from tmtccmd import BackendBase
2022-07-13 10:42:48 +02:00
from tmtccmd.util import FileSeqCountProvider, PusFileSeqCountProvider
2023-05-25 11:31:06 +02:00
from tmtccmd.fsfw.tmtc_printer import FsfwTmTcPrinter
2022-07-04 18:14:51 +02:00
from tmtccmd.logging.pus import (
RawTmtcTimedLogWrapper,
RegularTmtcLogWrapper,
TimedLogWhen,
)
from tmtccmd.pus import VerificationWrapper
from tmtccmd.tm import SpecificApidHandlerBase, GenericApidHandlerBase, CcsdsTmHandler
from tmtccmd.core import BackendRequest
2022-09-16 17:37:01 +02:00
from tmtccmd.config import (
default_json_path,
SetupWrapper,
params_to_procedure_conversion,
)
from tmtccmd.config.args import (
SetupParams,
PreArgsParsingWrapper,
ProcedureParamsWrapper,
)
2023-02-01 19:43:25 +01:00
from eive_tmtc import APP_LOGGER
2022-11-29 16:53:29 +01:00
from eive_tmtc import __version__
from eive_tmtc.config.definitions import (
2022-09-16 17:37:01 +02:00
PUS_APID,
CFDP_APID,
CFDP_LOCAL_ENTITY_ID,
CFDP_REMOTE_ENTITY_ID,
)
2022-11-29 16:53:29 +01:00
from eive_tmtc.config.hook import EiveHookObject
2023-06-28 10:43:11 +02:00
from eive_tmtc.pus_tm.pus_demux import pus_factory_hook
2022-07-04 15:22:53 +02:00
2023-02-01 19:43:25 +01:00
_LOGGER = APP_LOGGER
_LOG_LEVEL = logging.INFO
2022-07-04 15:22:53 +02:00
# Put rotating file logger parameters here for quick changes
ROTATING_TIMED_LOGGER_INTERVAL_WHEN = TimedLogWhen.PER_MINUTE
ROTATING_TIMED_LOGGER_INTERVAL = 30
2022-07-04 15:22:53 +02:00
class PusHandler(SpecificApidHandlerBase):
def __init__(
self,
wrapper: VerificationWrapper,
printer: FsfwTmTcPrinter,
raw_logger: RawTmtcTimedLogWrapper,
hk_level: int,
2022-07-04 15:22:53 +02:00
):
super().__init__(PUS_APID, None)
self.printer = printer
self.verif_wrapper = wrapper
self.raw_logger = raw_logger
2023-07-10 16:03:08 +02:00
self.hk_level = hk_level
2022-07-04 15:22:53 +02:00
def handle_tm(self, packet: bytes, _user_args: any):
2022-10-31 19:32:42 +01:00
# with open("tc.bin", "wb") as of:
# of.write(packet)
pus_factory_hook(
packet, self.verif_wrapper, self.printer, self.raw_logger, self.hk_level
)
2022-07-04 15:22:53 +02:00
class UnknownApidHandler(GenericApidHandlerBase):
2023-02-20 14:29:02 +01:00
def handle_tm(self, apid: int, packet: bytes, _user_args: any):
_LOGGER.warning(
f"Packet with unknown APID {apid} detected: {packet.hex(sep=',')}"
)
class CustomCcsdsTmHandler(CcsdsTmHandler):
def user_hook(self, apid: int, packet: bytes):
_LOGGER.debug(f"Received packet {packet.hex(sep=',')} with APID {apid}")
2022-07-04 15:22:53 +02:00
2022-09-16 17:28:19 +02:00
class CfdpInCcsdsWrapper(SpecificApidHandlerBase):
def __init__(self, cfdp_in_ccsds_handler: CfdpInCcsdsHandler):
super().__init__(CFDP_APID, None)
self.handler = cfdp_in_ccsds_handler
def handle_tm(self, packet: bytes, _user_args: any):
2022-10-21 11:28:33 +02:00
# Ignore the space packet header. Its only purpose is to use the same protocol and
# have a seaprate APID for space packets. If this function is called, the APID is correct.
pdu = packet[SPACE_PACKET_HEADER_SIZE:]
pdu_base = PduFactory.from_raw(pdu)
if pdu_base.pdu_type == PduType.FILE_DATA:
2023-02-01 11:17:04 +01:00
_LOGGER.info("Received File Data PDU TM")
2022-10-21 11:28:33 +02:00
else:
if pdu_base.directive_type == DirectiveType.FINISHED_PDU:
2023-06-19 17:16:00 +02:00
_LOGGER.info("Received Finished PDU TM")
2022-10-21 11:28:33 +02:00
else:
2023-02-01 11:17:04 +01:00
_LOGGER.info(
2022-10-21 11:28:33 +02:00
f"Received File Directive PDU with type {pdu_base.directive_type!r} TM"
)
self.handler.pass_pdu_packet(pdu_base)
2022-09-16 17:28:19 +02:00
2023-07-10 16:03:08 +02:00
def setup_params() -> (SetupWrapper, int):
2022-07-04 18:09:24 +02:00
hook_obj = EiveHookObject(default_json_path())
params = SetupParams()
2022-09-16 17:28:19 +02:00
parser_wrapper = PreArgsParsingWrapper()
2022-08-19 12:38:18 +02:00
parser_wrapper.create_default_parent_parser()
parser_wrapper.create_default_parser()
2023-07-10 16:03:08 +02:00
tmtc_parser, cfdp_parser = parser_wrapper.add_def_proc_and_cfdp_as_subparsers()
tmtc_parser.add_argument(
"--hk",
help="HK output level",
default=2,
)
2023-01-31 15:41:51 +01:00
post_arg_parsing_wrapper = parser_wrapper.parse(
setup_params=params, hook_obj=hook_obj
)
2022-09-16 17:28:19 +02:00
tmtccmd.init_printout(post_arg_parsing_wrapper.use_gui)
use_prompts = not post_arg_parsing_wrapper.use_gui
proc_param_wrapper = ProcedureParamsWrapper()
if use_prompts:
2023-01-31 12:56:13 +01:00
post_arg_parsing_wrapper.set_params_with_prompts(proc_param_wrapper)
2022-09-16 17:28:19 +02:00
else:
2023-01-31 12:56:13 +01:00
post_arg_parsing_wrapper.set_params_without_prompts(proc_param_wrapper)
2023-07-10 16:04:36 +02:00
hk_level = int(post_arg_parsing_wrapper.args_raw.hk)
2022-07-04 18:09:24 +02:00
params.apid = PUS_APID
2023-01-31 12:56:13 +01:00
if params.com_if is None:
raise ValueError("could not determine a COM interface.")
2022-09-16 17:28:19 +02:00
setup_wrapper = SetupWrapper(
2022-09-16 17:37:01 +02:00
hook_obj=hook_obj, setup_params=params, proc_param_wrapper=proc_param_wrapper
2022-09-16 17:28:19 +02:00
)
2023-07-10 16:03:08 +02:00
return setup_wrapper, hk_level
2022-07-04 18:09:24 +02:00
2022-09-16 17:28:19 +02:00
def setup_cfdp_handler() -> CfdpInCcsdsWrapper:
fh_base = EiveCfdpFaultHandler()
cfdp_cfg = LocalEntityCfg(
local_entity_id=CFDP_LOCAL_ENTITY_ID,
indication_cfg=IndicationCfg(),
default_fault_handlers=fh_base,
)
remote_cfg = RemoteEntityCfg(
closure_requested=False,
entity_id=CFDP_REMOTE_ENTITY_ID,
2023-02-24 15:49:37 +01:00
max_file_segment_len=990,
2022-09-16 17:28:19 +02:00
check_limit=None,
crc_on_transmission=False,
crc_type=ChecksumType.CRC_32,
default_transmission_mode=TransmissionMode.UNACKNOWLEDGED,
)
cfdp_seq_count_provider = FileSeqCountProvider(
max_bit_width=16, file_name=Path("seqcnt_cfdp_transaction.txt")
)
cfdp_ccsds_seq_count_provider = PusFileSeqCountProvider(
2022-12-15 11:10:33 +01:00
file_name=Path("seqcnt_cfdp_in_ccsds.txt")
2022-09-16 17:28:19 +02:00
)
cfdp_user = EiveCfdpUser()
cfdp_in_ccsds_handler = CfdpInCcsdsHandler(
cfg=cfdp_cfg,
remote_cfgs=[remote_cfg],
ccsds_apid=CFDP_APID,
ccsds_seq_cnt_provider=cfdp_ccsds_seq_count_provider,
cfdp_seq_cnt_provider=cfdp_seq_count_provider,
user=cfdp_user,
)
return CfdpInCcsdsWrapper(cfdp_in_ccsds_handler)
def setup_tmtc_handlers(
2022-07-04 18:09:24 +02:00
verificator: PusVerificator,
printer: FsfwTmTcPrinter,
raw_logger: RawTmtcTimedLogWrapper,
2022-08-08 16:32:18 +02:00
gui: bool,
hk_level: int,
2022-07-04 18:09:24 +02:00
) -> (CcsdsTmHandler, TcHandler):
2022-09-16 17:28:19 +02:00
cfdp_in_ccsds_wrapper = setup_cfdp_handler()
2023-02-01 15:58:34 +01:00
verification_wrapper = VerificationWrapper(
verificator, _LOGGER, printer.file_logger
)
2023-07-10 16:03:08 +02:00
pus_handler = PusHandler(verification_wrapper, printer, raw_logger, hk_level)
ccsds_handler = CustomCcsdsTmHandler(generic_handler=UnknownApidHandler(None))
2022-07-04 18:09:24 +02:00
ccsds_handler.add_apid_handler(pus_handler)
2022-09-16 17:28:19 +02:00
ccsds_handler.add_apid_handler(cfdp_in_ccsds_wrapper)
2022-07-08 16:25:46 +02:00
seq_count_provider = PusFileSeqCountProvider()
2022-07-04 18:09:24 +02:00
tc_handler = TcHandler(
seq_count_provider=seq_count_provider,
pus_verificator=verificator,
2022-10-27 15:33:25 +02:00
high_level_file_logger=printer.file_logger,
2022-10-27 15:32:50 +02:00
raw_pus_logger=raw_logger,
2022-08-08 16:32:18 +02:00
gui=gui,
2022-09-16 17:37:01 +02:00
cfdp_in_ccsds_wrapper=cfdp_in_ccsds_wrapper,
2022-07-04 18:09:24 +02:00
)
return ccsds_handler, tc_handler
2022-05-17 11:13:32 +02:00
2022-07-04 18:09:24 +02:00
def setup_backend(
setup_wrapper: SetupWrapper,
tc_handler: TcHandler,
ccsds_handler: CcsdsTmHandler,
) -> BackendBase:
2022-09-16 17:28:19 +02:00
init_proc = params_to_procedure_conversion(setup_wrapper.proc_param_wrapper)
2022-05-17 11:13:32 +02:00
tmtc_backend = tmtccmd.create_default_tmtc_backend(
2022-09-16 17:37:01 +02:00
setup_wrapper=setup_wrapper,
tm_handler=ccsds_handler,
tc_handler=tc_handler,
init_procedure=init_proc,
2022-07-04 18:09:24 +02:00
)
tmtccmd.start(tmtc_backend=tmtc_backend, hook_obj=setup_wrapper.hook_obj)
return tmtc_backend
2023-06-19 17:16:00 +02:00
def main(): # noqa C901: Complexity okay here.
2023-02-01 11:17:04 +01:00
print(f"-- eive tmtc v{__version__} --")
print(f"-- spacepackets v{spacepackets.__version__} --")
add_colorlog_console_logger(_LOGGER)
# TODO: -V CLI argument to enable this?
_LOGGER.setLevel(_LOG_LEVEL)
2022-07-04 18:09:24 +02:00
try:
2023-07-10 16:03:08 +02:00
setup_wrapper, hk_level = setup_params()
2022-07-04 18:09:24 +02:00
except KeyboardInterrupt as e:
2023-02-01 11:17:04 +01:00
_LOGGER.info(f"{e}. Exiting")
2022-07-04 18:09:24 +02:00
sys.exit(0)
2023-02-01 11:17:04 +01:00
2022-07-04 18:09:24 +02:00
tmtc_logger = RegularTmtcLogWrapper()
printer = FsfwTmTcPrinter(tmtc_logger.logger)
raw_logger = RawTmtcTimedLogWrapper(
when=ROTATING_TIMED_LOGGER_INTERVAL_WHEN,
2022-08-17 11:19:23 +02:00
interval=ROTATING_TIMED_LOGGER_INTERVAL,
)
2022-07-04 18:09:24 +02:00
pus_verificator = PusVerificator()
2022-09-16 17:28:19 +02:00
ccsds_handler, tc_handler = setup_tmtc_handlers(
2023-07-10 16:03:08 +02:00
pus_verificator, printer, raw_logger, setup_wrapper.params.use_gui, hk_level
2022-07-08 16:25:46 +02:00
)
2022-07-04 18:09:24 +02:00
tmtccmd.setup(setup_wrapper)
tmtc_backend = setup_backend(
setup_wrapper=setup_wrapper, ccsds_handler=ccsds_handler, tc_handler=tc_handler
2022-05-17 11:13:32 +02:00
)
2022-07-04 18:09:24 +02:00
try:
while True:
state = tmtc_backend.periodic_op(None)
2022-10-21 15:24:57 +02:00
tc_handler.cfdp_in_ccsds_wrapper.handler.fsm()
2022-07-04 18:09:24 +02:00
if state.request == BackendRequest.TERMINATION_NO_ERROR:
sys.exit(0)
elif state.request == BackendRequest.DELAY_IDLE:
2023-02-01 11:17:04 +01:00
_LOGGER.info("TMTC Client in IDLE mode")
2022-07-04 18:09:24 +02:00
time.sleep(3.0)
elif state.request == BackendRequest.DELAY_LISTENER:
2022-10-21 11:28:33 +02:00
if tc_handler.cfdp_done():
2023-02-01 11:17:04 +01:00
_LOGGER.info("CFDP transaction done, closing client")
2022-10-21 11:28:33 +02:00
sys.exit(0)
2022-08-11 18:10:15 +02:00
time.sleep(0.5)
2022-07-04 18:09:24 +02:00
elif state.request == BackendRequest.DELAY_CUSTOM:
2022-08-11 18:10:15 +02:00
if state.next_delay.total_seconds() < 0.5:
time.sleep(state.next_delay.total_seconds())
else:
time.sleep(0.5)
2022-07-04 18:09:24 +02:00
elif state.request == BackendRequest.CALL_NEXT:
pass
except KeyboardInterrupt:
sys.exit(0)
if __name__ == "__main__":
main()