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

# -*- coding: utf-8 -*-
"""
@file   syrlinks_hk_handler.py
@brief  Syrlinks Hk Handler tests
@author J. Meier
@date   13.12.2020
"""
from eive_tmtc.config.definitions import CustomServiceList
from tmtccmd.config.tmtc import (
    tmtc_definitions_provider,
    TmtcDefinitionWrapper,
    OpCodeEntry,
)
from tmtccmd.tc import DefaultPusQueueHelper
from tmtccmd.tc.pus_3_fsfw_hk import make_sid, generate_one_hk_command
from spacepackets.ecss.tc import PusTelecommand
from tmtccmd.tc.pus_200_fsfw_modes import pack_mode_data, Modes
import struct

from tmtccmd.util import ObjectIdU32


class SetIds:
    RX_REGISTERS_DATASET = 1
    TX_REGISTERS_DATASET = 2


class OpCodes:
    OFF = "off"
    ON = "on"
    NORMAL = "nml"
    STANDBY = "set_tx_standby"
    SET_CW = "set_tx_carrier_wave"
    MODULATION = "modulation"
    HK_RX_REGS = "hk_rx_regs"
    HK_TX_REGS = "hk_tx_regs"
    TX_STATUS = "tx_status"
    RX_STATUS = "rx_status"


class Info:
    HK_RX_REGS = "Request RX register set"
    HK_TX_REGS = "Request TX register set"
    TX_STATUS = "Read TX status (always read in normal mode)"
    RX_STATUS = "Read RX status (always read in normal mode)"
    SET_CW = "Set TX carrier wave"


class CommandIds:
    READ_RX_STATUS_REGISTERS = 2
    SET_TX_MODE_STANDBY = 3
    SET_TX_MODE_MODULATION = 4
    SET_TX_MODE_CW = 5
    READ_TX_STATUS = 7
    READ_TX_WAVEFORM = 8
    READ_TX_AGC_VALUE_HIGH_BYTE = 9
    READ_TX_AGC_VALUE_LOW_BYTE = 10
    WRITE_LCL_CONFIG = 11
    READ_LCL_CONFIG_REGISTER = 12
    SET_WAVEFORM_OQPSK = 17
    SET_WAVEFORM_BPSK = 18
    SET_SECOND_CONFIG = 19
    ENABLE_DEBUG = 20
    DISABLE_DEBUG = 21


@tmtc_definitions_provider
def add_syrlinks_cmds(defs: TmtcDefinitionWrapper):
    oce = OpCodeEntry()
    oce.add(OpCodes.OFF, "Syrlinks Handler: Set mode off")
    oce.add(OpCodes.ON, "Syrlinks Handler: Set mode on")
    oce.add(OpCodes.NORMAL, "Syrlinks Handler: Set mode normal")
    oce.add(OpCodes.STANDBY, "Syrlinks Handler: Set TX standby")
    oce.add(OpCodes.MODULATION, "Syrlinks Handler: Set TX modulation")
    oce.add(OpCodes.HK_RX_REGS, Info.HK_RX_REGS)
    oce.add(OpCodes.HK_TX_REGS, Info.HK_TX_REGS)
    oce.add(OpCodes.SET_CW, Info.SET_CW)
    oce.add(OpCodes.TX_STATUS, Info.TX_STATUS)
    oce.add(OpCodes.RX_STATUS, Info.RX_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("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)


def pack_syrlinks_command(
    object_id: ObjectIdU32, q: DefaultPusQueueHelper, op_code: str
):
    obyt = object_id.as_bytes
    prefix = "Syrlinks"
    q.add_log_cmd(f"Testing Syrlinks with object id: {object_id.as_hex_string}")
    if op_code == OpCodes.OFF:
        q.add_log_cmd(f"{prefix}: Set mode off")
        data = pack_mode_data(obyt, Modes.OFF, 0)
        q.add_pus_tc(PusTelecommand(service=200, subservice=1, app_data=data))
    if op_code == OpCodes.ON:
        q.add_log_cmd(f"{prefix}: Set mode on")
        data = pack_mode_data(obyt, Modes.ON, 0)
        q.add_pus_tc(PusTelecommand(service=200, subservice=1, app_data=data))
    if op_code == OpCodes.NORMAL:
        q.add_log_cmd(f"{prefix}: Mode Normal")
        data = pack_mode_data(obyt, Modes.NORMAL, 0)
        q.add_pus_tc(PusTelecommand(service=200, subservice=1, app_data=data))
    if op_code == OpCodes.STANDBY:
        q.add_log_cmd(f"{prefix}: Set TX mode standby")
        data = obyt + struct.pack("!I", CommandIds.SET_TX_MODE_STANDBY)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=data))
    if op_code == OpCodes.MODULATION:
        q.add_log_cmd(f"{prefix}: Set TX mode modulation")
        data = obyt + struct.pack("!I", CommandIds.SET_TX_MODE_MODULATION)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=data))
    if op_code in OpCodes.SET_CW:
        q.add_log_cmd(f"{prefix}: {Info.SET_CW}")
        data = obyt + struct.pack("!I", CommandIds.SET_TX_MODE_CW)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=data))
    if op_code in OpCodes.HK_RX_REGS:
        q.add_log_cmd(f"{prefix}: {Info.HK_RX_REGS}")
        sid = make_sid(obyt, SetIds.RX_REGISTERS_DATASET)
        q.add_pus_tc(generate_one_hk_command(sid))
    if op_code in OpCodes.HK_TX_REGS:
        q.add_log_cmd(f"{prefix}: {Info.HK_TX_REGS}")
        sid = make_sid(obyt, SetIds.TX_REGISTERS_DATASET)
        q.add_pus_tc(generate_one_hk_command(sid))
    if op_code in OpCodes.TX_STATUS:
        q.add_log_cmd(f"{prefix}: {Info.TX_STATUS}")
        command = obyt + struct.pack("!I", CommandIds.READ_TX_STATUS)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code == "9":
        q.add_log_cmd("Syrlinks: Read TX waveform")
        command = obyt + struct.pack("!I", CommandIds.READ_TX_WAVEFORM)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code == "10":
        q.add_log_cmd("Syrlinks: Read TX AGC value high byte")
        command = obyt + struct.pack("!I", CommandIds.READ_TX_AGC_VALUE_HIGH_BYTE)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code == "11":
        q.add_log_cmd("Syrlinks: Read TX AGC value low byte")
        command = obyt + struct.pack("!I", CommandIds.READ_TX_AGC_VALUE_LOW_BYTE)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code == "12":
        q.add_log_cmd("Syrlinks: Write LCL config")
        command = obyt + struct.pack("!I", CommandIds.WRITE_LCL_CONFIG)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code == "13":
        q.add_log_cmd("Syrlinks: Read RX status registers")
        command = obyt + struct.pack("!I", CommandIds.READ_RX_STATUS_REGISTERS)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code == "14":
        q.add_log_cmd("Syrlinks: Read LCL config register")
        command = obyt + struct.pack("!I", CommandIds.READ_LCL_CONFIG_REGISTER)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code == "15":
        q.add_log_cmd("Syrlinks: Set waveform OQPSK")
        command = obyt + struct.pack("!I", CommandIds.SET_WAVEFORM_OQPSK)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code == "16":
        q.add_log_cmd("Syrlinks: Set waveform BPSK")
        command = obyt + struct.pack("!I", CommandIds.SET_WAVEFORM_BPSK)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code == "17":
        q.add_log_cmd("Syrlinks: Set second config")
        command = obyt + struct.pack("!I", CommandIds.SET_SECOND_CONFIG)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code == "18":
        q.add_log_cmd("Syrlinks: Enable debug printout")
        command = obyt + struct.pack("!I", CommandIds.ENABLE_DEBUG)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code == "19":
        q.add_log_cmd("Syrlinks: Disable debug printout")
        command = obyt + struct.pack("!I", CommandIds.DISABLE_DEBUG)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))