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

# -*- coding: utf-8 -*-
"""
@file   rad_sensor.py
@brief  Tests for the radiation sensor handler
@author J. Meier
@date   01.07.2021
"""
import struct

from eive_tmtc.config.definitions import CustomServiceList

from spacepackets.ecss.tc import PusTelecommand
from eive_tmtc.pus_tc.service_200_mode import pack_mode_data, Modes
from tmtccmd.config import TmtcDefinitionWrapper, OpCodeEntry
from tmtccmd.config.tmtc import tmtc_definitions_provider
from tmtccmd.tc import DefaultPusQueueHelper
from tmtccmd.tc.pus_3_fsfw_hk import generate_one_hk_command, make_sid
from tmtccmd.util import ObjectIdU32


class SetIds:
    HK = 3


class OpCodes:
    ON = ["0", "on"]
    NORMAL = ["1", "normal"]
    OFF = ["2", "off"]
    REQ_HK_ONCE = ["3", "hk-os"]
    DEBUG_ON = ["10", "dbg-on"]
    DEBUG_OFF = ["11", "dbg-off"]


class Info:
    ON = "Switch Rad Sensor on"
    NORMAL = "Switch Rad Sensor normal"
    OFF = "Switch Rad sensor off"
    REQ_OS_HK = "Request one-shot HK"
    DEBUG_ON = "Switch debug output on"
    DEBUG_OFF = "Switch debug output off"


class CommandIds:
    START_CONVERSIONS = 2
    READ_CONVERSIONS = 3
    ENABLE_DEBUG_OUTPUT = 4
    DISABLE_DEBUG_OUTPUT = 5


@tmtc_definitions_provider
def add_rad_sens_cmds(defs: TmtcDefinitionWrapper):
    oce = OpCodeEntry()
    oce.add(info=Info.ON, keys=OpCodes.ON)
    oce.add(info=Info.OFF, keys=OpCodes.OFF)
    oce.add(info=Info.NORMAL, keys=OpCodes.NORMAL)
    oce.add(info=Info.REQ_OS_HK, keys=OpCodes.REQ_HK_ONCE)
    oce.add(info=Info.DEBUG_ON, keys=OpCodes.DEBUG_ON)
    oce.add(info=Info.DEBUG_OFF, keys=OpCodes.DEBUG_OFF)
    defs.add_service(
        name=CustomServiceList.RAD_SENSOR.value,
        info="Radiation Sensor",
        op_code_entry=oce,
    )


def pack_rad_sensor_test_into(
    object_id: ObjectIdU32, q: DefaultPusQueueHelper, op_code: str
):
    q.add_log_cmd(f"Commanding Radiation sensor handler {object_id}")

    if op_code in OpCodes.ON:
        rad_sensor_mode_cmd(object_id, Modes.ON, Info.ON, q)
    if op_code in OpCodes.NORMAL:
        rad_sensor_mode_cmd(object_id, Modes.NORMAL, Info.NORMAL, q)
    if op_code in OpCodes.OFF:
        rad_sensor_mode_cmd(object_id, Modes.OFF, Info.OFF, q)
    if op_code in OpCodes.REQ_HK_ONCE:
        q.add_log_cmd(f"Rad sensor: {Info.REQ_OS_HK}")
        q.add_pus_tc(
            generate_one_hk_command(sid=make_sid(object_id.as_bytes, set_id=SetIds.HK))
        )
    if op_code in OpCodes.DEBUG_ON:
        q.add_log_cmd(f"Rad sensor: {Info.DEBUG_ON}")
        command = object_id.as_bytes + struct.pack("!I", CommandIds.ENABLE_DEBUG_OUTPUT)
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))
    if op_code in OpCodes.DEBUG_OFF:
        q.add_log_cmd(f"Rad sensor: {Info.DEBUG_OFF}")
        command = object_id.as_bytes + struct.pack(
            "!I", CommandIds.DISABLE_DEBUG_OUTPUT
        )
        q.add_pus_tc(PusTelecommand(service=8, subservice=128, app_data=command))


def rad_sensor_mode_cmd(
    object_id: ObjectIdU32, mode: Modes, info: str, q: DefaultPusQueueHelper
):
    q.add_log_cmd(f"Rad sensor: {info}")
    mode_data = pack_mode_data(object_id.as_bytes, mode, 0)
    q.add_pus_tc(PusTelecommand(service=200, subservice=1, app_data=mode_data))