sat-rs/satrs-example/pyclient/main.py

281 lines
11 KiB
Python
Raw Normal View History

2022-11-20 18:07:38 +01:00
#!/usr/bin/env python3
"""Example client for the sat-rs example application"""
import logging
2022-11-20 18:07:38 +01:00
import sys
import time
from typing import Optional
import tmtccmd
from spacepackets.ecss import PusTelemetry, PusVerificator
2022-11-20 18:07:38 +01:00
from spacepackets.ecss.pus_17_test import Service17Tm
from spacepackets.ecss.pus_1_verification import UnpackParams, Service1Tm
from spacepackets.ccsds.time import CdsShortTimestamp
2022-11-20 18:07:38 +01:00
from tmtccmd import CcsdsTmtcBackend, TcHandlerBase, ProcedureParamsWrapper
from tmtccmd.core.base import BackendRequest
from tmtccmd.pus import VerificationWrapper
2023-11-11 16:33:43 +01:00
from tmtccmd.tmtc import CcsdsTmHandler, SpecificApidHandlerBase
from tmtccmd.com import ComInterface
2022-11-20 18:07:38 +01:00
from tmtccmd.config import (
default_json_path,
SetupParams,
HookBase,
2022-11-20 18:07:38 +01:00
TmtcDefinitionWrapper,
params_to_procedure_conversion,
)
from tmtccmd.config import PreArgsParsingWrapper, SetupWrapper
from tmtccmd.logging import add_colorlog_console_logger
2022-11-20 18:07:38 +01:00
from tmtccmd.logging.pus import (
RegularTmtcLogWrapper,
RawTmtcTimedLogWrapper,
TimedLogWhen,
)
2023-11-11 16:33:43 +01:00
from tmtccmd.tmtc import (
2022-11-20 18:07:38 +01:00
TcQueueEntryType,
ProcedureWrapper,
TcProcedureType,
FeedWrapper,
SendCbParams,
DefaultPusQueueHelper,
QueueWrapper,
2022-11-20 18:07:38 +01:00
)
from tmtccmd.util import FileSeqCountProvider, PusFileSeqCountProvider
from tmtccmd.util.obj_id import ObjectIdDictT
import pus_tc
import tc_definitions
2023-09-29 14:11:03 +02:00
from common import EXAMPLE_PUS_APID, TM_PACKET_IDS, EventU32
2022-11-20 18:07:38 +01:00
2023-07-02 17:47:47 +02:00
_LOGGER = logging.getLogger()
2022-11-20 18:07:38 +01:00
class SatRsConfigHook(HookBase):
2022-11-20 18:07:38 +01:00
def __init__(self, json_cfg_path: str):
super().__init__(json_cfg_path=json_cfg_path)
def assign_communication_interface(self, com_if_key: str) -> Optional[ComInterface]:
from tmtccmd.config.com import (
2022-11-20 18:07:38 +01:00
create_com_interface_default,
create_com_interface_cfg_default,
)
cfg = create_com_interface_cfg_default(
com_if_key=com_if_key,
json_cfg_path=self.cfg_path,
2023-09-29 14:11:03 +02:00
space_packet_ids=TM_PACKET_IDS,
2022-11-20 18:07:38 +01:00
)
return create_com_interface_default(cfg)
def get_tmtc_definitions(self) -> TmtcDefinitionWrapper:
return tc_definitions.tc_definitions()
2022-11-20 18:07:38 +01:00
def perform_mode_operation(self, tmtc_backend: CcsdsTmtcBackend, mode: int):
_LOGGER.info("Mode operation hook was called")
2022-11-20 18:07:38 +01:00
pass
def get_object_ids(self) -> ObjectIdDictT:
from tmtccmd.config.objects import get_core_object_ids
return get_core_object_ids()
class PusHandler(SpecificApidHandlerBase):
def __init__(
self,
2023-07-02 17:47:47 +02:00
file_logger: logging.Logger,
2022-11-20 18:07:38 +01:00
verif_wrapper: VerificationWrapper,
raw_logger: RawTmtcTimedLogWrapper,
):
super().__init__(EXAMPLE_PUS_APID, None)
2023-07-02 17:47:47 +02:00
self.file_logger = file_logger
2022-11-20 18:07:38 +01:00
self.raw_logger = raw_logger
self.verif_wrapper = verif_wrapper
def handle_tm(self, packet: bytes, _user_args: any):
try:
tm_packet = PusTelemetry.unpack(
packet, time_reader=CdsShortTimestamp.empty()
)
2022-11-20 18:45:11 +01:00
except ValueError as e:
_LOGGER.warning("Could not generate PUS TM object from raw data")
_LOGGER.warning(f"Raw Packet: [{packet.hex(sep=',')}], REPR: {packet!r}")
2022-11-20 18:45:11 +01:00
raise e
2022-11-20 18:07:38 +01:00
service = tm_packet.service
dedicated_handler = False
if service == 1:
tm_packet = Service1Tm.unpack(
data=packet, params=UnpackParams(CdsShortTimestamp.empty(), 1, 2)
)
2022-11-20 18:07:38 +01:00
res = self.verif_wrapper.add_tm(tm_packet)
if res is None:
_LOGGER.info(
2022-11-20 18:07:38 +01:00
f"Received Verification TM[{tm_packet.service}, {tm_packet.subservice}] "
f"with Request ID {tm_packet.tc_req_id.as_u32():#08x}"
)
_LOGGER.warning(
2022-11-20 18:07:38 +01:00
f"No matching telecommand found for {tm_packet.tc_req_id}"
)
else:
self.verif_wrapper.log_to_console(tm_packet, res)
self.verif_wrapper.log_to_file(tm_packet, res)
dedicated_handler = True
2022-12-22 09:15:59 +01:00
if service == 3:
_LOGGER.info("No handling for HK packets implemented")
_LOGGER.info(f"Raw packet: 0x[{packet.hex(sep=',')}]")
pus_tm = PusTelemetry.unpack(packet, time_reader=CdsShortTimestamp.empty())
2022-12-22 09:15:59 +01:00
if pus_tm.subservice == 25:
if len(pus_tm.source_data) < 8:
raise ValueError("No addressable ID in HK packet")
json_str = pus_tm.source_data[8:]
dedicated_handler = True
2022-11-20 18:07:38 +01:00
if service == 5:
tm_packet = PusTelemetry.unpack(
packet, time_reader=CdsShortTimestamp.empty()
)
src_data = tm_packet.source_data
event_u32 = EventU32.unpack(src_data)
_LOGGER.info(f"Received event packet. Event: {event_u32}")
if event_u32.group_id == 0 and event_u32.unique_id == 0:
_LOGGER.info("Received test event")
2022-11-20 18:07:38 +01:00
if service == 17:
tm_packet = Service17Tm.unpack(
packet, time_reader=CdsShortTimestamp.empty()
)
2022-11-20 18:07:38 +01:00
dedicated_handler = True
if tm_packet.subservice == 2:
2023-07-02 17:47:47 +02:00
self.file_logger.info("Received Ping Reply TM[17,2]")
_LOGGER.info("Received Ping Reply TM[17,2]")
2022-11-20 18:07:38 +01:00
else:
2023-07-02 17:47:47 +02:00
self.file_logger.info(
2022-11-20 18:07:38 +01:00
f"Received Test Packet with unknown subservice {tm_packet.subservice}"
)
_LOGGER.info(
2022-11-20 18:07:38 +01:00
f"Received Test Packet with unknown subservice {tm_packet.subservice}"
)
if tm_packet is None:
_LOGGER.info(
2022-11-20 18:07:38 +01:00
f"The service {service} is not implemented in Telemetry Factory"
)
tm_packet = PusTelemetry.unpack(
packet, time_reader=CdsShortTimestamp.empty()
)
2022-11-20 18:07:38 +01:00
self.raw_logger.log_tm(tm_packet)
if not dedicated_handler and tm_packet is not None:
pass
# self.printer.handle_long_tm_print(packet_if=tm_packet, info_if=tm_packet)
2022-11-20 18:07:38 +01:00
class TcHandler(TcHandlerBase):
def __init__(
self,
seq_count_provider: FileSeqCountProvider,
verif_wrapper: VerificationWrapper,
):
super(TcHandler, self).__init__()
self.seq_count_provider = seq_count_provider
self.verif_wrapper = verif_wrapper
self.queue_helper = DefaultPusQueueHelper(
queue_wrapper=QueueWrapper.empty(),
tc_sched_timestamp_len=CdsShortTimestamp.TIMESTAMP_SIZE,
2022-11-20 18:07:38 +01:00
seq_cnt_provider=seq_count_provider,
pus_verificator=self.verif_wrapper.pus_verificator,
default_pus_apid=EXAMPLE_PUS_APID,
2022-11-20 18:07:38 +01:00
)
def send_cb(self, send_params: SendCbParams):
entry_helper = send_params.entry
if entry_helper.is_tc:
if entry_helper.entry_type == TcQueueEntryType.PUS_TC:
pus_tc_wrapper = entry_helper.to_pus_tc_entry()
raw_tc = pus_tc_wrapper.pus_tc.pack()
_LOGGER.info(f"Sending {pus_tc_wrapper.pus_tc}")
2022-11-20 18:07:38 +01:00
send_params.com_if.send(raw_tc)
elif entry_helper.entry_type == TcQueueEntryType.LOG:
log_entry = entry_helper.to_log_entry()
_LOGGER.info(log_entry.log_str)
2022-11-20 18:07:38 +01:00
def queue_finished_cb(self, helper: ProcedureWrapper):
if helper.proc_type == TcProcedureType.DEFAULT:
def_proc = helper.to_def_procedure()
_LOGGER.info(
2022-11-20 18:07:38 +01:00
f"Queue handling finished for service {def_proc.service} and "
f"op code {def_proc.op_code}"
)
def feed_cb(self, helper: ProcedureWrapper, wrapper: FeedWrapper):
2022-12-21 10:01:19 +01:00
q = self.queue_helper
q.queue_wrapper = wrapper.queue_wrapper
2022-11-20 18:07:38 +01:00
if helper.proc_type == TcProcedureType.DEFAULT:
def_proc = helper.to_def_procedure()
service = def_proc.service
2022-12-21 10:01:19 +01:00
op_code = def_proc.op_code
pus_tc.pack_pus_telecommands(q, service, op_code)
2022-11-20 18:07:38 +01:00
def main():
add_colorlog_console_logger(_LOGGER)
2022-11-20 18:07:38 +01:00
tmtccmd.init_printout(False)
hook_obj = SatRsConfigHook(json_cfg_path=default_json_path())
parser_wrapper = PreArgsParsingWrapper()
parser_wrapper.create_default_parent_parser()
parser_wrapper.create_default_parser()
parser_wrapper.add_def_proc_args()
params = SetupParams()
post_args_wrapper = parser_wrapper.parse(hook_obj, params)
2022-11-20 18:07:38 +01:00
proc_wrapper = ProcedureParamsWrapper()
if post_args_wrapper.use_gui:
post_args_wrapper.set_params_without_prompts(proc_wrapper)
2022-11-20 18:07:38 +01:00
else:
post_args_wrapper.set_params_with_prompts(proc_wrapper)
2022-11-20 18:07:38 +01:00
params.apid = EXAMPLE_PUS_APID
setup_args = SetupWrapper(
hook_obj=hook_obj, setup_params=params, proc_param_wrapper=proc_wrapper
)
# Create console logger helper and file loggers
tmtc_logger = RegularTmtcLogWrapper()
2023-07-02 17:47:47 +02:00
file_logger = tmtc_logger.logger
2022-11-20 18:07:38 +01:00
raw_logger = RawTmtcTimedLogWrapper(when=TimedLogWhen.PER_HOUR, interval=1)
verificator = PusVerificator()
2023-07-02 17:47:47 +02:00
verification_wrapper = VerificationWrapper(verificator, _LOGGER, file_logger)
2022-11-20 18:07:38 +01:00
# Create primary TM handler and add it to the CCSDS Packet Handler
2023-07-02 17:47:47 +02:00
tm_handler = PusHandler(file_logger, verification_wrapper, raw_logger)
2022-11-20 18:07:38 +01:00
ccsds_handler = CcsdsTmHandler(generic_handler=None)
ccsds_handler.add_apid_handler(tm_handler)
# Create TC handler
seq_count_provider = PusFileSeqCountProvider()
tc_handler = TcHandler(seq_count_provider, verification_wrapper)
tmtccmd.setup(setup_args=setup_args)
init_proc = params_to_procedure_conversion(setup_args.proc_param_wrapper)
tmtc_backend = tmtccmd.create_default_tmtc_backend(
setup_wrapper=setup_args,
tm_handler=ccsds_handler,
tc_handler=tc_handler,
init_procedure=init_proc,
)
tmtccmd.start(tmtc_backend=tmtc_backend, hook_obj=hook_obj)
try:
while True:
state = tmtc_backend.periodic_op(None)
if state.request == BackendRequest.TERMINATION_NO_ERROR:
sys.exit(0)
elif state.request == BackendRequest.DELAY_IDLE:
_LOGGER.info("TMTC Client in IDLE mode")
2022-11-20 18:07:38 +01:00
time.sleep(3.0)
elif state.request == BackendRequest.DELAY_LISTENER:
time.sleep(0.8)
elif state.request == BackendRequest.DELAY_CUSTOM:
2022-11-20 18:45:11 +01:00
if state.next_delay.total_seconds() <= 0.4:
time.sleep(state.next_delay.total_seconds())
else:
time.sleep(0.4)
2022-11-20 18:07:38 +01:00
elif state.request == BackendRequest.CALL_NEXT:
pass
except KeyboardInterrupt:
sys.exit(0)
if __name__ == "__main__":
main()