eive-tmtc/pus_tc/devs/acu.py

# -*- coding: utf-8 -*-
"""ACU commands
@author J. Meier, R. Mueller
@date   21.12.2020
"""
from config.definitions import CustomServiceList
from tmtccmd.config import add_op_code_entry, add_service_op_code_entry
from tmtccmd.tc.packer import TcQueueT
from tmtccmd.config.definitions import QueueCommands, ServiceOpCodeDictT
from tmtccmd.tc.pus_3_fsfw_hk import (
    make_sid,
    generate_one_diag_command,
    generate_one_hk_command,
)
import gomspace.gomspace_common as gs
from gomspace.gomspace_common import GomspaceOpCodes
from gomspace.gomspace_common import Info as GsInfo
from config.object_ids import ACU_HANDLER_ID
from pus_tc.devs.p60dock import P60DockConfigTable
from tmtccmd.tc.pus_8_funccmd import generate_action_command
from tmtccmd.utility import ObjectId


class ACUConfigTable:
    mppt_mode = gs.TableEntry(bytearray([0x00, 0x00]), gs.TableEntry.uint8_size)
    mppt_d_mode = gs.TableEntry(bytearray([0x00, 0x01]), gs.TableEntry.uint8_size)
    vboost = gs.TableEntry(bytearray([0x00, 0x02]), gs.TableEntry.uint16_size)
    vbat_max_hi = gs.TableEntry(bytearray([0x00, 0x10]), gs.TableEntry.uint16_size)
    vbat_max_lo = gs.TableEntry(bytearray([0x00, 0x12]), gs.TableEntry.uint16_size)
    ov_mode = gs.TableEntry(bytearray([0x00, 0x1A]), gs.TableEntry.uint8_size)


class ACUHkTable:
    temperature1 = gs.TableEntry(bytearray([0x00, 0x1C]), gs.TableEntry.uint16_size)
    temperature2 = gs.TableEntry(bytearray([0x00, 0x1D]), gs.TableEntry.uint16_size)
    temperature3 = gs.TableEntry(bytearray([0x00, 0x1E]), gs.TableEntry.uint16_size)
    # Ground WDT value (remaining seconds until reboot)
    wdt_gnd_left = gs.TableEntry(bytearray([0x00, 0x74]), gs.TableEntry.uint32_size)


class OpCodes:
    TEST = ["0", "test"]


class Info:
    TEST = "ACU Test"


def add_acu_cmds(cmd_dict: ServiceOpCodeDictT):
    op_code_dict = dict()
    add_op_code_entry(
        op_code_dict=op_code_dict,
        keys=GomspaceOpCodes.REQUEST_CORE_HK_ONCE,
        info=GsInfo.REQUEST_CORE_HK_ONCE,
    )
    add_op_code_entry(
        op_code_dict=op_code_dict,
        keys=GomspaceOpCodes.REQUEST_AUX_HK_ONCE,
        info=GsInfo.REQUEST_AUX_HK_ONCE,
    )
    add_op_code_entry(
        op_code_dict=op_code_dict,
        keys=GomspaceOpCodes.REQUEST_AUX_HK_ONCE,
        info=GsInfo.REQUEST_AUX_HK_ONCE,
    )
    add_op_code_entry(op_code_dict=op_code_dict, keys=OpCodes.TEST, info=Info.TEST)
    add_service_op_code_entry(
        srv_op_code_dict=cmd_dict,
        op_code_entry=op_code_dict,
        name=CustomServiceList.ACU.value,
        info="ACU Device",
    )


def pack_acu_commands(
    object_id: ObjectId, tc_queue: TcQueueT, op_code: str
) -> TcQueueT:
    tc_queue.appendleft((QueueCommands.PRINT, "Handling ACU command"))
    if op_code in GomspaceOpCodes.PRINT_SWITCH_V_I:
        tc_queue.appendleft((QueueCommands.PRINT, "ACU: Print channel stats"))
        command = generate_action_command(
            object_id=object_id.as_bytes,
            action_id=gs.GomspaceDeviceActionIds.PRINT_SWITCH_V_I,
        )
        tc_queue.appendleft(command.pack_command_tuple())
    if op_code in GomspaceOpCodes.REQUEST_CORE_HK_ONCE:
        tc_queue.appendleft(
            (QueueCommands.PRINT, f"PDU1: {GsInfo.REQUEST_CORE_HK_ONCE}")
        )
        hk_sid = make_sid(object_id=object_id.as_bytes, set_id=gs.SetIds.ACU_CORE)
        command = generate_one_diag_command(sid=hk_sid, ssc=0)
        tc_queue.appendleft(command.pack_command_tuple())
    if op_code in GomspaceOpCodes.REQUEST_AUX_HK_ONCE:
        tc_queue.appendleft(
            (QueueCommands.PRINT, f"PDU1: {GsInfo.REQUEST_AUX_HK_ONCE}")
        )
        hk_sid = make_sid(object_id=object_id.as_bytes, set_id=gs.SetIds.ACU_AUX)
        command = generate_one_hk_command(sid=hk_sid, ssc=0)
        tc_queue.appendleft(command.pack_command_tuple())
    pack_test_cmds(object_id=object_id, tc_queue=tc_queue)

    return tc_queue


class ACUTestProcedure:
    """
    @brief  Use this class to define the tests to perform for the ACU.
    @details    Setting all to True will run all tests.
                Setting all to False will only run the tests set to True.
    """

    all = False
    reboot = False
    read_gnd_wdt = False
    gnd_wdt_reset = False
    ping = False
    read_temperature1 = False
    read_temperature2 = False
    read_temperature3 = False
    read_mppt_mode = False
    read_vboost = False
    read_vbat_max_hi = False
    read_vbat_max_lo = False
    read_ov_mode = False
    off = False


def pack_test_cmds(object_id: ObjectId, tc_queue: TcQueueT):
    if ACUTestProcedure.all or ACUTestProcedure.reboot:
        tc_queue.appendleft((QueueCommands.PRINT, "ACU: Reboot"))
        command = gs.pack_reboot_command(object_id)
        # command = PusTelecommand(service=8, subservice=128, ssc=22, app_data=command)
        tc_queue.appendleft(command.pack_command_tuple())
    if ACUTestProcedure.all or ACUTestProcedure.read_gnd_wdt:
        tc_queue.appendleft(
            (QueueCommands.PRINT, "ACU: Reading ground watchdog timer value")
        )
        command = gs.pack_get_param_command(
            object_id.as_bytes,
            gs.TableIds.hk,
            ACUHkTable.wdt_gnd_left.parameter_address,
            ACUHkTable.wdt_gnd_left.parameter_size,
        )
        # command = PusTelecommand(service=8, subservice=128, ssc=20, app_data=command)
        tc_queue.appendleft(command.pack_command_tuple())
    if ACUTestProcedure.all or ACUTestProcedure.gnd_wdt_reset:
        tc_queue.appendleft((QueueCommands.PRINT, "ACU: Testing ground watchdog reset"))
        command = gs.pack_gnd_wdt_reset_command(object_id)
        # command = PusTelecommand(service=8, subservice=128, ssc=21, app_data=command)
        tc_queue.appendleft(command.pack_command_tuple())
    if ACUTestProcedure.all or ACUTestProcedure.ping:
        tc_queue.appendleft((QueueCommands.PRINT, "ACU: Ping Test"))
        ping_data = bytearray([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
        command = gs.pack_ping_command(object_id, ping_data)
        # command = PusTelecommand(service=8, subservice=128, ssc=22, app_data=command)
        tc_queue.appendleft(command.pack_command_tuple())
    if ACUTestProcedure.all or ACUTestProcedure.read_temperature3:
        tc_queue.appendleft((QueueCommands.PRINT, "ACU: Reading temperature 3"))
        command = gs.pack_get_param_command(
            object_id.as_bytes,
            gs.TableIds.hk,
            ACUHkTable.temperature3.parameter_address,
            ACUHkTable.temperature3.parameter_size,
        )
        # command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
        tc_queue.appendleft(command.pack_command_tuple())
    if ACUTestProcedure.all or ACUTestProcedure.read_vboost:
        tc_queue.appendleft((QueueCommands.PRINT, "ACU: Reading vboost value"))
        command = gs.pack_get_param_command(
            object_id.as_bytes,
            gs.TableIds.config,
            ACUConfigTable.vboost.parameter_address,
            ACUConfigTable.vboost.parameter_size,
        )
        # command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
        tc_queue.appendleft(command.pack_command_tuple())
    if ACUTestProcedure.all or ACUTestProcedure.read_vbat_max_hi:
        tc_queue.appendleft((QueueCommands.PRINT, "ACU: Reading vbat_max_hi"))
        command = gs.pack_get_param_command(
            object_id.as_bytes,
            gs.TableIds.config,
            ACUConfigTable.vbat_max_hi.parameter_address,
            ACUConfigTable.vbat_max_hi.parameter_size,
        )
        # command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
        tc_queue.appendleft(command.pack_command_tuple())
    if ACUTestProcedure.all or ACUTestProcedure.read_vbat_max_lo:
        tc_queue.appendleft((QueueCommands.PRINT, "ACU: Reading vbat_max_lo"))
        command = gs.pack_get_param_command(
            object_id.as_bytes,
            gs.TableIds.config,
            ACUConfigTable.vbat_max_lo.parameter_address,
            ACUConfigTable.vbat_max_lo.parameter_size,
        )
        # command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
        tc_queue.appendleft(command.pack_command_tuple())
    if ACUTestProcedure.all or ACUTestProcedure.read_ov_mode:
        tc_queue.appendleft((QueueCommands.PRINT, "ACU: Reading ov_mode"))
        command = gs.pack_get_param_command(
            object_id.as_bytes,
            gs.TableIds.config,
            ACUConfigTable.ov_mode.parameter_address,
            ACUConfigTable.ov_mode.parameter_size,
        )
        # command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
        tc_queue.appendleft(command.pack_command_tuple())
    if ACUTestProcedure.all or ACUTestProcedure.off:
        tc_queue.appendleft((QueueCommands.PRINT, "P60 Dock: Turning off ACU"))
        command = gs.pack_set_param_command(
            ACU_HANDLER_ID,
            P60DockConfigTable.out_en_0.parameter_address,
            P60DockConfigTable.out_en_0.parameter_size,
            gs.Channel.off,
        )
        tc_queue.appendleft(command.pack_command_tuple())