eive-tmtc/eive_tmtc/tmtc/power/acu.py

# -*- coding: utf-8 -*-
"""ACU commands
@author J. Meier, R. Mueller
@date   21.12.2020
"""
import struct

from eive_tmtc.config.definitions import CustomServiceList
from eive_tmtc.pus_tm.defs import PrintWrapper
from eive_tmtc.tmtc.power.common_power import (
    pack_common_gomspace_cmds,
    add_gomspace_cmd_defs,
    req_hk_cmds,
    pack_common_power_cmds,
    SetId,
    OBC_ENDIANNESS,
    unpack_array_in_data,
)
from tmtccmd.config import TmtcDefinitionWrapper, OpCodeEntry
from tmtccmd.config.tmtc import tmtc_definitions_provider

from tmtccmd.tc import DefaultPusQueueHelper
import eive_tmtc.gomspace.gomspace_common as gs
from eive_tmtc.config.object_ids import ACU_HANDLER_ID
from tmtccmd.util import ObjectIdU32


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 OpCode:
    TEST = ["0", "test"]


class Info:
    TEST = "ACU Test"


@tmtc_definitions_provider
def add_acu_cmds(defs: TmtcDefinitionWrapper):
    oce = OpCodeEntry()
    add_gomspace_cmd_defs(oce)

    oce.add(keys=OpCode.TEST, info=Info.TEST)
    defs.add_service(
        name=CustomServiceList.ACU.value,
        info="ACU Device",
        op_code_entry=oce,
    )


def pack_acu_commands(object_id: ObjectIdU32, q: DefaultPusQueueHelper, op_code: str):
    q.add_log_cmd("Handling ACU command")
    pack_common_power_cmds("ACU", object_id, q, op_code)
    pack_common_gomspace_cmds("ACU", object_id, q, op_code)
    acu_req_hk_cmds(q, op_code)
    pack_test_cmds(object_id=object_id, q=q)


def acu_req_hk_cmds(q: DefaultPusQueueHelper, op_code: str):
    req_hk_cmds("ACU", q, op_code, ACU_HANDLER_ID, [SetId.CORE, SetId.AUX])


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: ObjectIdU32, q: DefaultPusQueueHelper):
    if ACUTestProcedure.all or ACUTestProcedure.reboot:
        q.add_log_cmd("ACU: Reboot")
        q.add_pus_tc(gs.pack_reboot_command(object_id))
    if ACUTestProcedure.all or ACUTestProcedure.read_gnd_wdt:
        q.add_log_cmd("ACU: Reading ground watchdog timer value")
        q.add_pus_tc(
            gs.pack_get_param_command(
                object_id.as_bytes,
                gs.TableIds.HK,
                ACUHkTable.wdt_gnd_left.parameter_address,
                ACUHkTable.wdt_gnd_left.parameter_size,
            )
        )
    if ACUTestProcedure.all or ACUTestProcedure.gnd_wdt_reset:
        q.add_log_cmd("ACU: Testing ground watchdog reset")
        q.add_pus_tc(gs.pack_gnd_wdt_reset_command(object_id))
    if ACUTestProcedure.all or ACUTestProcedure.ping:
        q.add_log_cmd("ACU: Ping Test")
        ping_data = bytearray([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
        q.add_pus_tc(gs.pack_ping_command(object_id, ping_data))
    if ACUTestProcedure.all or ACUTestProcedure.read_temperature3:
        q.add_log_cmd("ACU: Reading temperature 3")
        q.add_pus_tc(
            gs.pack_get_param_command(
                object_id.as_bytes,
                gs.TableIds.HK,
                ACUHkTable.temperature3.parameter_address,
                ACUHkTable.temperature3.parameter_size,
            )
        )
    if ACUTestProcedure.all or ACUTestProcedure.read_vboost:
        q.add_log_cmd("ACU: Reading vboost value")
        q.add_pus_tc(
            gs.pack_get_param_command(
                object_id.as_bytes,
                gs.TableIds.CONFIG,
                ACUConfigTable.vboost.parameter_address,
                ACUConfigTable.vboost.parameter_size,
            )
        )
    if ACUTestProcedure.all or ACUTestProcedure.read_vbat_max_hi:
        q.add_log_cmd("ACU: Reading vbat_max_hi")
        q.add_pus_tc(
            gs.pack_get_param_command(
                object_id.as_bytes,
                gs.TableIds.CONFIG,
                ACUConfigTable.vbat_max_hi.parameter_address,
                ACUConfigTable.vbat_max_hi.parameter_size,
            )
        )
    if ACUTestProcedure.all or ACUTestProcedure.read_vbat_max_lo:
        q.add_log_cmd("ACU: Reading vbat_max_lo")
        q.add_pus_tc(
            gs.pack_get_param_command(
                object_id.as_bytes,
                gs.TableIds.CONFIG,
                ACUConfigTable.vbat_max_lo.parameter_address,
                ACUConfigTable.vbat_max_lo.parameter_size,
            )
        )
    if ACUTestProcedure.all or ACUTestProcedure.read_ov_mode:
        q.add_log_cmd("ACU: Reading ov_mode")
        q.add_pus_tc(
            gs.pack_get_param_command(
                object_id.as_bytes,
                gs.TableIds.CONFIG,
                ACUConfigTable.ov_mode.parameter_address,
                ACUConfigTable.ov_mode.parameter_size,
            )
        )


def acu_config_table_handler(pw: PrintWrapper, custom_data: bytes):
    mppt_mode = custom_data[0]
    mppt_delta_mode = custom_data[1]
    vboost_list = unpack_array_in_data(custom_data, 0x02, 2, 6, "H")
    vbat_max_hi = struct.unpack(f"{OBC_ENDIANNESS}H", custom_data[0x10 : 0x10 + 2])[0]
    vbat_max_lo = struct.unpack(f"{OBC_ENDIANNESS}H", custom_data[0x12 : 0x12 + 2])[0]
    mppt_period = struct.unpack(f"{OBC_ENDIANNESS}I", custom_data[0x14 : 0x14 + 4])[0]
    max_dv = struct.unpack(f"{OBC_ENDIANNESS}H", custom_data[0x18 : 0x18 + 2])[0]
    ov_mode = custom_data[0x1A]
    pw.dlog(f"{'mppt_mode'.ljust(15)}: {mppt_mode}")
    pw.dlog(f"{'mppt_delta_mode'.ljust(15)}: {mppt_delta_mode}")
    pw.dlog(f"{'vboost_list'.ljust(15)}: {vboost_list}")
    pw.dlog(f"{'vbat_max_hi'.ljust(15)}: {vbat_max_hi}")
    pw.dlog(f"{'vbat_max_lo'.ljust(15)}: {vbat_max_lo}")
    pw.dlog(f"{'mppt_period'.ljust(15)}: {mppt_period}")
    pw.dlog(f"{'max_dv'.ljust(15)}: {max_dv}")
    pw.dlog(f"{'ov_mode'.ljust(15)}: {ov_mode}")