eive-tmtc/eive_tmtc/pus_tc/devs/bpx_batt.py

from spacepackets.ecss import PusTelecommand

from eive_tmtc.config.definitions import CustomServiceList
from eive_tmtc.config.object_ids import BPX_HANDLER_ID
from tmtccmd.config.tmtc import (
    tmtc_definitions_provider,
    TmtcDefinitionWrapper,
    OpCodeEntry,
)
from tmtccmd.tc import service_provider
from tmtccmd.tc.decorator import ServiceProviderParams
from tmtccmd.tc.pus_8_funccmd import make_fsfw_action_cmd
from tmtccmd.tc.pus_3_fsfw_hk import generate_one_hk_command, make_sid
from tmtccmd.tc.pus_200_fsfw_modes import pack_mode_data, Modes
from tmtccmd.tc.pus_200_fsfw_modes import Subservices as ModeSubservices


class BpxSetIds:
    GET_HK_SET = 0
    GET_CFG_SET = 5


class BpxActionIds:
    REBOOT = 2
    RESET_COUNTERS = 3
    SET_CFG = 4
    GET_CFG = 5


class BpxOpCodes:
    HK = ["0", "hk"]
    OFF = ["off"]
    ON = ["on"]
    RST_BOOT_CNT = ["1", "rst_boot_cnt"]
    REQUEST_CFG = ["2", "cfg"]
    REQUEST_CFG_HK = ["3", "cfg_hk"]
    REBOOT = ["4", "reboot"]


@tmtc_definitions_provider
def add_bpx_cmd_definitions(defs: TmtcDefinitionWrapper):
    oce = OpCodeEntry()
    oce.add(keys=BpxOpCodes.ON, info="On command")
    oce.add(keys=BpxOpCodes.OFF, info="Off command")
    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,
    )


@service_provider(CustomServiceList.BPX_BATTERY.value)
def pack_bpx_commands(p: ServiceProviderParams):
    op_code = p.op_code
    q = p.queue_helper
    if op_code in BpxOpCodes.HK:
        q.add_log_cmd("Requesting BPX battery HK set")
        sid = make_sid(object_id=BPX_HANDLER_ID, set_id=BpxSetIds.GET_HK_SET)
        q.add_pus_tc(generate_one_hk_command(sid=sid))
    if op_code in BpxOpCodes.OFF:
        q.add_log_cmd("Off mode")
        mode_cmd = pack_mode_data(BPX_HANDLER_ID, Modes.OFF, 0)
        q.add_pus_tc(
            PusTelecommand(
                service=200,
                subservice=ModeSubservices.TC_MODE_COMMAND,
                app_data=mode_cmd,
            )
        )
    if op_code in BpxOpCodes.ON:
        q.add_log_cmd("On mode")
        mode_cmd = pack_mode_data(BPX_HANDLER_ID, Modes.ON, 0)
        q.add_pus_tc(
            PusTelecommand(
                service=200,
                subservice=ModeSubservices.TC_MODE_COMMAND,
                app_data=mode_cmd,
            )
        )
    if op_code in BpxOpCodes.RST_BOOT_CNT:
        q.add_log_cmd("Resetting reboot counters")
        q.add_pus_tc(
            make_fsfw_action_cmd(
                object_id=BPX_HANDLER_ID, action_id=BpxActionIds.RESET_COUNTERS
            )
        )
    if op_code in BpxOpCodes.REQUEST_CFG:
        q.add_log_cmd("Requesting configuration struct")
        q.add_pus_tc(
            make_fsfw_action_cmd(
                object_id=BPX_HANDLER_ID, action_id=BpxActionIds.GET_CFG
            )
        )
    if op_code in BpxOpCodes.REQUEST_CFG_HK:
        q.add_log_cmd("Requesting configuration struct HK")
        sid = make_sid(object_id=BPX_HANDLER_ID, set_id=BpxSetIds.GET_CFG_SET)
        q.add_pus_tc(generate_one_hk_command(sid=sid))
    if op_code in BpxOpCodes.REBOOT:
        q.add_log_cmd("Rebooting BPX battery")
        q.add_pus_tc(
            make_fsfw_action_cmd(
                object_id=BPX_HANDLER_ID, action_id=BpxActionIds.REBOOT
            )
        )