eive-tmtc/pus_tc/cmd_definitions.py

from pus_tc.devs.bpx_batt import BpxOpCodes

from config.definitions import CustomServiceList
from tmtccmd.config import TmtcDefinitionWrapper, OpCodeEntry, CoreServiceList
from tmtccmd.config.tmtc import (
    tmtc_definitions_provider,
    call_all_definitions_providers,
)
from tmtccmd.config.globals import get_default_tmtc_defs


def get_eive_service_op_code_dict() -> TmtcDefinitionWrapper:
    """Call all registered TMTC definition providers. They were registered using
    the :py:func:`tmtc_definitions_provider` decorator.
    """
    def_wrapper = get_default_tmtc_defs()
    srv_5 = OpCodeEntry()
    srv_5.add("0", "Event Test")
    def_wrapper.add_service(
        name=CoreServiceList.SERVICE_5.value,
        info="PUS Service 5 Event",
        op_code_entry=srv_5,
    )
    srv_17 = OpCodeEntry()
    srv_17.add("0", "Ping Test")
    def_wrapper.add_service(
        name=CoreServiceList.SERVICE_17_ALT,
        info="PUS Service 17 Test",
        op_code_entry=srv_17,
    )
    call_all_definitions_providers(def_wrapper)
    return def_wrapper


@tmtc_definitions_provider
def add_tmp_sens_cmds(defs: TmtcDefinitionWrapper):
    oce = OpCodeEntry()
    oce.add("0", "TMP1075 Tests")
    defs.add_service(CustomServiceList.TMP1075_1.value, "TMP1075 1", oce)
    defs.add_service(CustomServiceList.TMP1075_2.value, "TMP1075 2", oce)


@tmtc_definitions_provider
def add_pdec_cmds(defs: TmtcDefinitionWrapper):
    oce = OpCodeEntry()
    oce.add("0", "PDEC Handler: Print CLCW")
    oce.add("1", "PDEC Handler: Print PDEC monitor")
    defs.add_service(CustomServiceList.PDEC_HANDLER.value, "PDEC Handler", oce)


@tmtc_definitions_provider
def add_ccsds_cmds(defs: TmtcDefinitionWrapper):
    oce = OpCodeEntry()
    oce.add("0", "CCSDS Handler: Set low rate")
    oce.add("1", "CCSDS Handler: Set high rate")
    oce.add("2", "CCSDS Handler: Enable transmitter")
    oce.add("3", "CCSDS Handler: Disable transmitter")
    oce.add("4", "CCSDS Handler: Set arbitrary bitrate")
    oce.add("5", "CCSDS Handler: Enable tx clock manipulator")
    oce.add("6", "CCSDS Handler: Disable tx clock manipulator")
    oce.add("7", "CCSDS Handler: Update tx data on rising edge")
    oce.add("8", "CCSDS Handler: Update tx data on falling edge")
    defs.add_service(CustomServiceList.CCSDS_HANDLER.value, "CCSDS Handler", oce)


@tmtc_definitions_provider
def add_str_cmds(defs: TmtcDefinitionWrapper):
    oce = OpCodeEntry()
    oce.add("0", "Star Tracker: Mode On, Submode Bootloader")
    oce.add("1", "Star Tracker: Mode On, Submode Firmware")
    oce.add("2", "Star Tracker: Mode Normal")
    oce.add("3", "Star Tracker: Mode Off")
    oce.add("4", "Star Tracker: Mode Raw")
    oce.add("5", "Star Tracker: Ping")
    oce.add("6", "Star Tracker: Switch to bootloader program")
    oce.add("7", "Star Tracker: Request temperature")
    oce.add("8", "Star Tracker: Request version")
    oce.add("9", "Star Tracker: Request interface")
    oce.add("10", "Star Tracker: Request power")
    oce.add("11", "Star Tracker: Set subscription parameters")
    oce.add("12", "Star Tracker: Boot image (requires bootloader mode)")
    oce.add("13", "Star Tracker: Request time")
    oce.add("14", "Star Tracker: Request solution")
    oce.add("15", "Star Tracker: Upload image")
    oce.add("16", "Star Tracker: Download image")
    oce.add("17", "Star Tracker: Set limit parameters")
    oce.add("17", "Star Tracker: Set limit parameters")
    oce.add("18", "Star Tracker: Set tracking parameters")
    oce.add("19", "Star Tracker: Set mounting parameters")
    oce.add("20", "Star Tracker: Set camera parameters")
    oce.add("22", "Star Tracker: Set centroiding parameters")
    oce.add("23", "Star Tracker: Set LISA parameters")
    oce.add("24", "Star Tracker: Set matching parameters")
    oce.add("25", "Star Tracker: Set validation parameters")
    oce.add("26", "Star Tracker: Set algo parameters")
    oce.add("27", "Star Tracker: Take image")
    oce.add("28", "Star Tracker: Stop str helper")
    oce.add("30", "Star Tracker: Set name of download image")
    oce.add("31", "Star Tracker: Request histogram")
    oce.add("32", "Star Tracker: Request contrast")
    oce.add("33", "Star Tracker: Set json filename")
    oce.add("35", "Star Tracker: Flash read")
    oce.add("36", "Star Tracker: Set flash read filename")
    oce.add("37", "Star Tracker: Get checksum")
    oce.add("49", "Star Tracker: Request camera parameter")
    oce.add("50", "Star Tracker: Request limits")
    oce.add("51", "Star Tracker: Set image processor parameters")
    oce.add("52", "Star Tracker: (EGSE only) Load camera ground config")
    oce.add("53", "Star Tracker: (EGSE only) Load camera flight config")
    oce.add("54", "Star Tracker: Request log level parameters")
    oce.add("55", "Star Tracker: Request mounting parameters")
    oce.add("56", "Star Tracker: Request image processor parameters")
    oce.add("57", "Star Tracker: Request centroiding parameters")
    oce.add("58", "Star Tracker: Request lisa parameters")
    oce.add("59", "Star Tracker: Request matching parameters")
    oce.add("60", "Star Tracker: Request tracking parameters")
    oce.add("61", "Star Tracker: Request validation parameters")
    oce.add("62", "Star Tracker: Request algo parameters")
    oce.add("63", "Star Tracker: Request subscription parameters")
    oce.add("64", "Star Tracker: Request log subscription parameters")
    oce.add("65", "Star Tracker: Request debug camera parameters")
    oce.add("66", "Star Tracker: Set log level parameters")
    oce.add("67", "Star Tracker: Set log subscription parameters")
    oce.add("68", "Star Tracker: Set debug camera parameters")
    oce.add("69", "Star Tracker: Firmware update")
    oce.add("70", "Star Tracker: Disable timestamp generation")
    oce.add("71", "Star Tracker: Enable timestamp generation")
    defs.add_service(CustomServiceList.STAR_TRACKER.value, "Star Tracker", oce)


@tmtc_definitions_provider
def add_syrlinks_cmds(defs: TmtcDefinitionWrapper):
    oce = OpCodeEntry()
    oce.add("0", "Syrlinks Handler: Set mode off")
    oce.add("1", "Syrlinks Handler: Set mode on")
    oce.add("2", "Syrlinks Handler: Set mode normal")
    oce.add("3", "Syrlinks Handler: Set TX standby")
    oce.add("4", "Syrlinks Handler: Set TX modulation")
    oce.add("5", "Syrlinks Handler: Set TX carrier wave")
    oce.add("6", "Syrlinks Handler: Read TX status")
    oce.add("7", "Syrlinks Handler: Read TX waveform")
    oce.add("8", "Syrlinks Handler: Read TX AGC value high byte")
    oce.add("9", "Syrlinks Handler: Read TX AGC value low byte")
    oce.add("12", "Syrlinks Handler: Write LCL config")
    oce.add("13", "Syrlinks Handler: Read RX status registers")
    oce.add("14", "Syrlinks Handler: Read LCL config register")
    oce.add("15", "Syrlinks Handler: Set waveform OQPSK")
    oce.add("16", "Syrlinks Handler: Set waveform BPSK")
    oce.add("17", "Syrlinks Handler: Set second config")
    oce.add("18", "Syrlinks Handler: Enable debug output")
    oce.add("19", "Syrlinks Handler: Disable debug output")
    defs.add_service(CustomServiceList.SYRLINKS.value, "Syrlinks Handler", oce)


@tmtc_definitions_provider
def add_bpx_cmd_definitions(defs: TmtcDefinitionWrapper):
    oce = OpCodeEntry()
    oce.add(keys=BpxOpCodes.HK, info="Request BPX HK")
    oce.add(keys=BpxOpCodes.RST_BOOT_CNT, info="Reset Boot Count")
    oce.add(keys=BpxOpCodes.REQUEST_CFG, info="Request Configuration Struct (Step 1)")
    oce.add(
        keys=BpxOpCodes.REQUEST_CFG_HK, info="Request Configuration Struct HK (Step 2)"
    )
    oce.add(keys=BpxOpCodes.REBOOT, info="Reboot Command")
    defs.add_service(
        name=CustomServiceList.BPX_BATTERY.value,
        info="BPX Battery Handler",
        op_code_entry=oce,
    )


@tmtc_definitions_provider
def add_time_cmds(defs: TmtcDefinitionWrapper):
    from pus_tc.system.time import OpCodes, Info

    oce = OpCodeEntry()
    oce.add(
        keys=OpCodes.SET_CURRENT_TIME,
        info=Info.SET_CURRENT_TIME,
    )
    defs.add_service(
        name=CustomServiceList.TIME.value,
        info="Time Service",
        op_code_entry=oce,
    )


@tmtc_definitions_provider
def add_system_cmds(defs: TmtcDefinitionWrapper):
    from pus_tc.system.acs import AcsOpCodes, SusOpCodes
    import pus_tc.system.controllers as controllers

    oce = OpCodeEntry()
    oce.add(
        keys=AcsOpCodes.ACS_ASS_A_SIDE,
        info="Switch to ACS board A side",
    )
    oce.add(
        keys=AcsOpCodes.ACS_ASS_B_SIDE,
        info="Switch to ACS board B side",
    )
    oce.add(
        keys=AcsOpCodes.ACS_ASS_DUAL_MODE,
        info="Switch to ACS board dual mode",
    )
    oce.add(
        keys=AcsOpCodes.ACS_ASS_A_ON,
        info="Switch ACS board A side on",
    )
    oce.add(
        keys=AcsOpCodes.ACS_ASS_B_ON,
        info="Switch ACS board B side on",
    )
    oce.add(
        keys=AcsOpCodes.ACS_ASS_DUAL_ON,
        info="Switch ACS board dual mode on",
    )
    oce.add(
        keys=AcsOpCodes.ACS_ASS_OFF,
        info="Switch off ACS board",
    )
    defs.add_service(
        name=CustomServiceList.ACS_ASS.value, info="ACS Assemblies", op_code_entry=oce
    )

    oce = OpCodeEntry()
    oce.add(
        keys=SusOpCodes.SUS_ASS_NOM_SIDE,
        info="Switch SUS board to nominal side",
    )
    oce.add(
        keys=SusOpCodes.SUS_ASS_RED_SIDE,
        info="Switch SUS board to redundant side",
    )
    oce.add(
        keys=SusOpCodes.SUS_ASS_OFF,
        info="Switch off SUS board",
    )
    oce.add(
        keys=SusOpCodes.SUS_ASS_DUAL_MODE,
        info="Switch SUS board to dual mode",
    )
    defs.add_service(
        name=CustomServiceList.SUS_ASS.value,
        info="SUS Assembly",
        op_code_entry=oce,
    )

    oce = OpCodeEntry()
    oce.add(
        keys=controllers.OpCodes.THERMAL_CONTROLLER,
        info=controllers.Info.THERMAL_CONTROLLER,
    )
    oce.add(
        keys=controllers.OpCodes.CORE_CONTROLLER,
        info=controllers.Info.CORE_CONTROLLER,
    )
    defs.add_service(
        name=CustomServiceList.CONTROLLERS.value,
        info="Controllers",
        op_code_entry=oce,
    )