eive-tmtc/pus_tc/devs/plpcdu.py

451 lines
14 KiB
Python
Raw Normal View History

2022-02-25 19:21:32 +01:00
import enum
2022-05-24 17:01:35 +02:00
import struct
import time
2022-03-01 18:00:39 +01:00
from typing import Optional
2022-02-25 19:21:32 +01:00
2022-05-24 02:16:54 +02:00
from config.definitions import CustomServiceList
from tmtccmd.config import TmtcDefinitionWrapper
2022-07-04 17:59:09 +02:00
from tmtccmd.config.tmtc import OpCodeEntry, tmtc_definitions_provider
2022-08-08 16:32:18 +02:00
from tmtccmd.tc import DefaultPusQueueHelper
2022-05-24 02:16:54 +02:00
from tmtccmd.tc.pus_3_fsfw_hk import (
make_sid,
generate_one_diag_command,
2022-10-19 10:11:40 +02:00
enable_periodic_hk_command_with_interval,
disable_periodic_hk_command,
2022-05-24 02:16:54 +02:00
)
2022-05-24 17:01:35 +02:00
from tmtccmd.tc.pus_11_tc_sched import (
generate_enable_tc_sched_cmd,
generate_time_tagged_cmd,
)
from tmtccmd.tc.pus_200_fsfw_modes import pack_mode_data, Modes, Subservices
from tmtccmd.tc.pus_20_params import (
2022-03-01 17:31:36 +01:00
pack_scalar_double_param_app_data,
2022-03-01 18:12:31 +01:00
pack_fsfw_load_param_cmd,
2022-03-04 10:44:55 +01:00
pack_boolean_parameter_app_data,
2022-03-01 17:31:36 +01:00
)
2022-04-05 00:51:52 +02:00
from tmtccmd.logging import get_console_logger
2022-02-25 19:21:32 +01:00
from spacepackets.ecss.tc import PusTelecommand
from config.object_ids import PL_PCDU_ID
2022-03-01 17:31:36 +01:00
LOGGER = get_console_logger()
2022-02-25 19:21:32 +01:00
2022-03-01 18:00:39 +01:00
2022-02-25 19:21:32 +01:00
class OpCodes:
2022-10-19 09:45:40 +02:00
SWITCH_HPA_ON_PROC = ["0", "proc_hpa"]
2022-05-24 17:07:13 +02:00
SWITCH_ON = ["2", "on"]
SWITCH_OFF = ["3", "off"]
2022-10-19 09:45:40 +02:00
NORMAL_SSR = ["4", "nml_ssr"]
NORMAL_DRO = ["5", "nml_dro"]
NORMAL_X8 = ["6", "nml_x8"]
NORMAL_TX = ["7", "nml_tx"]
NORMAL_MPA = ["8", "nml_mpa"]
NORMAL_HPA = ["9", "nml_hpa"]
2022-10-19 10:11:40 +02:00
ENABLE_HK = ["enable_hk"]
DISABLE_HK = ["disable_hk"]
REQ_OS_HK = ["hk_os"]
2022-10-19 09:45:40 +02:00
INJECT_SSR_TO_DRO_FAILURE = ["10", "inject_ssr_dro_fault"]
INJECT_DRO_TO_X8_FAILURE = ["11", "inject_dro_x8_fault"]
INJECT_X8_TO_TX_FAILURE = ["12", "inject_x8_tx_fault"]
INJECT_TX_TO_MPA_FAILURE = ["13", "inject_tx_mpa_fault"]
INJECT_MPA_TO_HPA_FAILURE = ["14", "inject_mpa_hpa_fault"]
INJECT_ALL_ON_FAILURE = ["15", "inject_all_on_fault"]
2022-02-25 19:21:32 +01:00
class Info:
2022-10-19 10:52:29 +02:00
NORMAL = "ADC modules normal"
SWITCH_ON = "Switching on"
SWITCH_OFF = "Switching off"
NORMAL_SSR = f"{NORMAL}, SSR on"
NORMAL_DRO = f"{NORMAL},DRO on"
NORMAL_X8 = f"{NORMAL}, X8 on"
NORMAL_TX = f"{NORMAL}, TX on"
NORMAL_MPA = f"{NORMAL}, MPA on"
NORMAL_HPA = f"{NORMAL}, HPA on"
2022-05-24 02:16:54 +02:00
REQ_OS_HK = "Request One Shot HK"
2022-10-19 10:52:29 +02:00
SWITCH_HPA_ON_PROC = "Switch HPA on procedure"
2022-10-19 10:11:40 +02:00
ENABLE_HK = "Enable HK"
DISABLE_HK = "Disable HK"
2022-05-24 02:16:54 +02:00
class SetIds(enum.IntEnum):
ADC = 0
2022-04-04 13:53:26 +02:00
class NormalSubmodesMask(enum.IntEnum):
SOLID_STATE_RELAYS_ADC_ON = 0
DRO_ON = 1
X8_ON = 2
TX_ON = 3
MPA_ON = 4
HPA_ON = 5
2022-02-25 19:21:32 +01:00
2022-03-01 17:31:36 +01:00
class ParamIds(enum.IntEnum):
2022-03-02 11:26:18 +01:00
NEG_V_LOWER_BOUND = 0
NEG_V_UPPER_BOUND = 1
DRO_U_LOWER_BOUND = 2
DRO_U_UPPER_BOUND = 3
DRO_I_UPPER_BOUND = 4
X8_U_LOWER_BOUND = 5
X8_U_UPPER_BOUND = 6
X8_I_UPPER_BOUND = 7
TX_U_LOWER_BOUND = 8
TX_U_UPPER_BOUND = 9
TX_I_UPPER_BOUND = 10
MPA_U_LOWER_BOUND = 11
MPA_U_UPPER_BOUND = 12
MPA_I_UPPER_BOUND = 13
HPA_U_LOWER_BOUND = 14
HPA_U_UPPER_BOUND = 15
HPA_I_UPPER_BOUND = 16
2022-03-01 19:41:24 +01:00
SSR_TO_DRO_WAIT_TIME = 17
DRO_TO_X8_WAIT_TIME = 18
2022-03-02 11:26:18 +01:00
X8_TO_TX_WAIT_TIME = 19
TX_TO_MPA_WAIT_TIME = 20
MPA_TO_HPA_WAIT_TIME = 21
INJECT_SSR_TO_DRO_FAILURE = 30
INJECT_DRO_TO_X8_FAILURE = 31
INJECT_X8_TO_TX_FAILURE = 32
INJECT_TX_TO_MPA_FAILURE = 33
INJECT_MPA_TO_HPA_FAILURE = 34
INJECT_ALL_ON_FAILURE = 35
2022-03-01 17:31:36 +01:00
@tmtc_definitions_provider
def add_pl_pcdu_cmds(defs: TmtcDefinitionWrapper):
2022-07-05 02:12:54 +02:00
oce = OpCodeEntry()
2022-08-11 15:40:38 +02:00
oce.add(keys=OpCodes.SWITCH_HPA_ON_PROC, info=Info.SWITCH_HPA_ON_PROC)
2022-07-05 02:12:54 +02:00
oce.add(keys=OpCodes.SWITCH_ON, info=Info.SWITCH_ON)
oce.add(keys=OpCodes.SWITCH_OFF, info=Info.SWITCH_OFF)
oce.add(keys=OpCodes.NORMAL_SSR, info=Info.NORMAL_SSR)
oce.add(keys=OpCodes.NORMAL_DRO, info=Info.NORMAL_DRO)
oce.add(keys=OpCodes.NORMAL_X8, info=Info.NORMAL_X8)
oce.add(keys=OpCodes.NORMAL_TX, info=Info.NORMAL_TX)
oce.add(keys=OpCodes.NORMAL_MPA, info=Info.NORMAL_MPA)
oce.add(keys=OpCodes.NORMAL_HPA, info=Info.NORMAL_HPA)
oce.add(keys=OpCodes.REQ_OS_HK, info=Info.REQ_OS_HK)
2022-10-19 10:11:40 +02:00
oce.add(keys=OpCodes.ENABLE_HK, info=Info.ENABLE_HK)
2022-07-05 02:12:54 +02:00
oce.add(
2022-05-24 02:16:54 +02:00
keys=OpCodes.INJECT_SSR_TO_DRO_FAILURE,
info="Inject failure SSR to DRO transition",
)
2022-07-05 02:12:54 +02:00
oce.add(
2022-05-24 02:16:54 +02:00
keys=OpCodes.INJECT_DRO_TO_X8_FAILURE,
info="Inject failure in DRO to X8 transition",
)
2022-07-05 02:12:54 +02:00
oce.add(
2022-05-24 02:16:54 +02:00
keys=OpCodes.INJECT_X8_TO_TX_FAILURE,
info="Inject failure in X8 to TX transition",
)
2022-07-05 02:12:54 +02:00
oce.add(
2022-05-24 02:16:54 +02:00
keys=OpCodes.INJECT_TX_TO_MPA_FAILURE,
info="Inject failure in TX to MPA transition",
)
2022-07-05 02:12:54 +02:00
oce.add(
2022-05-24 02:16:54 +02:00
keys=OpCodes.INJECT_MPA_TO_HPA_FAILURE,
info="Inject failure in MPA to HPA transition",
)
2022-07-05 02:12:54 +02:00
oce.add(keys=OpCodes.INJECT_ALL_ON_FAILURE, info="Inject failure in all on mode")
2022-08-08 16:47:41 +02:00
defs.add_service(CustomServiceList.PL_PCDU.value, "PL PCDU", oce)
2022-05-24 02:16:54 +02:00
2022-08-08 16:32:18 +02:00
def pack_pl_pcdu_commands(q: DefaultPusQueueHelper, op_code: str):
2022-03-03 18:24:17 +01:00
if op_code in OpCodes.SWITCH_ON:
2022-07-04 17:59:09 +02:00
pack_pl_pcdu_mode_cmd(q=q, info=Info.SWITCH_ON, mode=Modes.ON, submode=0)
2022-03-03 18:55:11 +01:00
if op_code in OpCodes.SWITCH_OFF:
2022-07-04 17:59:09 +02:00
pack_pl_pcdu_mode_cmd(q=q, info=Info.SWITCH_OFF, mode=Modes.OFF, submode=0)
2022-10-19 10:11:40 +02:00
if op_code in OpCodes.ENABLE_HK:
interval = float(
input("Please enter HK collection interval in floating point seconds: ")
)
cmds = enable_periodic_hk_command_with_interval(
diag=True, sid=make_sid(PL_PCDU_ID, SetIds.ADC), interval_seconds=interval
)
q.add_log_cmd(f"Enable PL PCDU HK with interval of {interval} seconds")
for cmd in cmds:
q.add_pus_tc(cmd)
if op_code in OpCodes.DISABLE_HK:
cmd = disable_periodic_hk_command(
diag=True, sid=make_sid(PL_PCDU_ID, SetIds.ADC)
)
q.add_log_cmd("Disabling PL PCDU HK")
q.add_pus_tc(cmd)
if op_code in OpCodes.NORMAL_SSR:
pack_pl_pcdu_mode_cmd(
2022-07-04 17:59:09 +02:00
q=q,
info=Info.NORMAL_SSR,
mode=Modes.NORMAL,
2022-05-24 17:01:35 +02:00
submode=submode_mask_to_submode(
NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON
),
2022-03-04 10:44:55 +01:00
)
if op_code in OpCodes.NORMAL_DRO:
pack_pl_pcdu_mode_cmd(
2022-07-04 17:59:09 +02:00
q=q,
info=Info.NORMAL_DRO,
mode=Modes.NORMAL,
2022-05-24 17:01:35 +02:00
submode=submode_mask_to_submode(NormalSubmodesMask.DRO_ON),
2022-02-25 19:21:32 +01:00
)
if op_code in OpCodes.NORMAL_X8:
pack_pl_pcdu_mode_cmd(
2022-07-04 17:59:09 +02:00
q=q,
info=Info.NORMAL_X8,
mode=Modes.NORMAL,
2022-05-24 17:01:35 +02:00
submode=submode_mask_to_submode(NormalSubmodesMask.X8_ON),
2022-02-25 19:21:32 +01:00
)
if op_code in OpCodes.NORMAL_TX:
pack_pl_pcdu_mode_cmd(
2022-07-04 17:59:09 +02:00
q=q,
info=Info.NORMAL_TX,
mode=Modes.NORMAL,
2022-05-24 17:01:35 +02:00
submode=submode_mask_to_submode(NormalSubmodesMask.TX_ON),
2022-03-04 10:44:55 +01:00
)
if op_code in OpCodes.NORMAL_MPA:
pack_pl_pcdu_mode_cmd(
2022-07-04 17:59:09 +02:00
q=q,
info=Info.NORMAL_MPA,
mode=Modes.NORMAL,
2022-05-24 17:01:35 +02:00
submode=submode_mask_to_submode(NormalSubmodesMask.MPA_ON),
2022-02-25 19:21:32 +01:00
)
if op_code in OpCodes.NORMAL_HPA:
pack_pl_pcdu_mode_cmd(
2022-07-04 17:59:09 +02:00
q=q,
info=Info.NORMAL_HPA,
mode=Modes.NORMAL,
2022-05-24 17:01:35 +02:00
submode=submode_mask_to_submode(NormalSubmodesMask.HPA_ON),
2022-02-25 19:21:32 +01:00
)
2022-05-24 02:16:54 +02:00
if op_code in OpCodes.REQ_OS_HK:
2022-07-04 17:59:09 +02:00
q.add_log_cmd(f"PL PCDU: {Info.REQ_OS_HK}")
q.add_pus_tc(
generate_one_diag_command(
sid=make_sid(object_id=PL_PCDU_ID, set_id=SetIds.ADC)
)
2022-05-24 02:16:54 +02:00
)
2022-05-24 17:01:35 +02:00
if op_code in OpCodes.SWITCH_HPA_ON_PROC:
2022-07-04 17:59:09 +02:00
hpa_on_procedure(q)
2022-03-02 15:06:50 +01:00
if op_code in OpCodes.INJECT_ALL_ON_FAILURE:
pack_failure_injection_cmd(
2022-07-04 17:59:09 +02:00
q=q,
2022-03-02 15:06:50 +01:00
param_id=ParamIds.INJECT_ALL_ON_FAILURE,
2022-03-04 10:44:55 +01:00
print_str="All On",
2022-03-02 15:06:50 +01:00
)
2022-03-01 18:00:39 +01:00
2022-08-08 16:32:18 +02:00
def hpa_on_procedure(q: DefaultPusQueueHelper):
2022-05-24 17:04:03 +02:00
delay_dro_to_x8 = request_wait_time()
if delay_dro_to_x8 is None:
delay_dro_to_x8 = 900
2022-07-04 17:59:09 +02:00
q.add_log_cmd(
f"Starting procedure to switch on PL PCDU HPA with DRO to X8 "
f"delay of {delay_dro_to_x8} seconds"
2022-05-24 17:04:03 +02:00
)
pl_pcdu_on = PusTelecommand(
service=200,
subservice=Subservices.TC_MODE_COMMAND,
app_data=pack_mode_data(object_id=PL_PCDU_ID, mode=Modes.ON, submode=0),
)
ssr_on = PusTelecommand(
service=200,
subservice=Subservices.TC_MODE_COMMAND,
app_data=pack_mode_data(
object_id=PL_PCDU_ID,
mode=Modes.NORMAL,
submode=submode_mask_to_submode(
NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON
),
),
)
dro_on = PusTelecommand(
service=200,
subservice=Subservices.TC_MODE_COMMAND,
app_data=pack_mode_data(
object_id=PL_PCDU_ID,
mode=Modes.NORMAL,
submode=submode_mask_to_submode(NormalSubmodesMask.DRO_ON),
),
)
x8_on = PusTelecommand(
service=200,
subservice=Subservices.TC_MODE_COMMAND,
app_data=pack_mode_data(
object_id=PL_PCDU_ID,
mode=Modes.NORMAL,
submode=submode_mask_to_submode(NormalSubmodesMask.X8_ON),
),
)
tx_on = PusTelecommand(
service=200,
subservice=Subservices.TC_MODE_COMMAND,
app_data=pack_mode_data(
object_id=PL_PCDU_ID,
mode=Modes.NORMAL,
submode=submode_mask_to_submode(NormalSubmodesMask.TX_ON),
),
)
mpa_on = PusTelecommand(
service=200,
subservice=Subservices.TC_MODE_COMMAND,
app_data=pack_mode_data(
object_id=PL_PCDU_ID,
mode=Modes.NORMAL,
submode=submode_mask_to_submode(NormalSubmodesMask.MPA_ON),
),
)
hpa_on = PusTelecommand(
service=200,
subservice=Subservices.TC_MODE_COMMAND,
app_data=pack_mode_data(
object_id=PL_PCDU_ID,
mode=Modes.NORMAL,
submode=submode_mask_to_submode(NormalSubmodesMask.HPA_ON),
),
)
current_time = time.time()
2022-05-24 17:01:35 +02:00
2022-07-04 17:59:09 +02:00
enb_sched = generate_enable_tc_sched_cmd()
2022-05-24 17:01:35 +02:00
2022-08-11 15:40:38 +02:00
sched_time = int(round(current_time + 10))
2022-07-04 17:59:09 +02:00
q.add_pus_tc(enb_sched)
2022-05-24 17:04:03 +02:00
tagged_on_cmd = generate_time_tagged_cmd(
release_time=struct.pack("!I", sched_time),
tc_to_insert=pl_pcdu_on,
)
2022-07-04 17:59:09 +02:00
q.add_pus_tc(tagged_on_cmd)
2022-05-24 17:01:35 +02:00
2022-05-24 17:04:03 +02:00
sched_time += 5
tagged_ssr_cmd = generate_time_tagged_cmd(
release_time=struct.pack("!I", sched_time),
tc_to_insert=ssr_on,
)
2022-07-04 17:59:09 +02:00
q.add_pus_tc(tagged_ssr_cmd)
2022-05-24 17:01:35 +02:00
2022-05-24 17:04:03 +02:00
sched_time += 5
tagged_dro_cmd = generate_time_tagged_cmd(
2022-07-04 17:59:09 +02:00
release_time=struct.pack("!I", sched_time), tc_to_insert=dro_on
2022-05-24 17:04:03 +02:00
)
2022-07-04 17:59:09 +02:00
q.add_pus_tc(tagged_dro_cmd)
2022-05-24 17:01:35 +02:00
2022-05-24 17:04:03 +02:00
sched_time += delay_dro_to_x8
2022-08-11 15:40:38 +02:00
sched_time = int(round(sched_time))
2022-05-24 17:04:03 +02:00
tagged_x8_cmd = generate_time_tagged_cmd(
2022-07-04 17:59:09 +02:00
release_time=struct.pack("!I", sched_time), tc_to_insert=x8_on
2022-05-24 17:04:03 +02:00
)
2022-07-04 17:59:09 +02:00
q.add_pus_tc(tagged_x8_cmd)
2022-05-24 17:01:35 +02:00
2022-05-24 17:04:03 +02:00
sched_time += 5
tagged_tx_cmd = generate_time_tagged_cmd(
2022-07-04 17:59:09 +02:00
release_time=struct.pack("!I", sched_time), tc_to_insert=tx_on
2022-05-24 17:04:03 +02:00
)
2022-07-04 17:59:09 +02:00
q.add_pus_tc(tagged_tx_cmd)
2022-05-24 17:01:35 +02:00
2022-05-24 17:04:03 +02:00
sched_time += 5
tagged_mpa_cmd = generate_time_tagged_cmd(
2022-07-04 17:59:09 +02:00
release_time=struct.pack("!I", sched_time), tc_to_insert=mpa_on
2022-05-24 17:04:03 +02:00
)
2022-07-04 17:59:09 +02:00
q.add_pus_tc(tagged_mpa_cmd)
2022-05-24 17:04:03 +02:00
sched_time += 5
tagged_hpa_cmd = generate_time_tagged_cmd(
2022-07-04 17:59:09 +02:00
release_time=struct.pack("!I", sched_time), tc_to_insert=hpa_on
2022-05-24 17:04:03 +02:00
)
2022-07-04 17:59:09 +02:00
q.add_pus_tc(tagged_hpa_cmd)
2022-03-01 18:00:39 +01:00
def request_wait_time() -> Optional[float]:
while True:
2022-03-01 19:41:24 +01:00
wait_time = input("Please enter DRO to X8 wait time in seconds, x to cancel: ")
2022-03-01 18:00:39 +01:00
if wait_time.lower() == "x":
return None
2022-03-01 19:41:24 +01:00
try:
wait_time = float(wait_time)
except ValueError:
2022-03-01 18:00:39 +01:00
LOGGER.warning("Invalid input")
continue
if wait_time <= 0:
LOGGER.warning("Invalid input")
else:
return wait_time
2022-03-02 11:44:39 +01:00
2022-05-24 17:04:03 +02:00
def submode_mask_to_submode(on_tgt: NormalSubmodesMask) -> int:
if on_tgt == NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON:
return 1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON
if on_tgt == NormalSubmodesMask.DRO_ON:
return 1 << NormalSubmodesMask.DRO_ON | (
1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON
)
if on_tgt == NormalSubmodesMask.X8_ON:
return (
1 << NormalSubmodesMask.DRO_ON
| (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
| (1 << NormalSubmodesMask.X8_ON)
)
if on_tgt == NormalSubmodesMask.TX_ON:
return (
1 << NormalSubmodesMask.DRO_ON
| (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
| (1 << NormalSubmodesMask.X8_ON)
| (1 << NormalSubmodesMask.TX_ON)
)
if on_tgt == NormalSubmodesMask.MPA_ON:
return (
1 << NormalSubmodesMask.DRO_ON
| (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
| (1 << NormalSubmodesMask.X8_ON)
| (1 << NormalSubmodesMask.TX_ON)
| (1 << NormalSubmodesMask.MPA_ON)
)
if on_tgt == NormalSubmodesMask.HPA_ON:
return (
1 << NormalSubmodesMask.DRO_ON
| (1 << NormalSubmodesMask.SOLID_STATE_RELAYS_ADC_ON)
| (1 << NormalSubmodesMask.X8_ON)
| (1 << NormalSubmodesMask.TX_ON)
| (1 << NormalSubmodesMask.MPA_ON)
| (1 << NormalSubmodesMask.HPA_ON)
)
2022-08-08 16:32:18 +02:00
def pack_wait_time_cmd(q: DefaultPusQueueHelper, param_id: int, print_str: str):
2022-03-02 11:44:39 +01:00
wait_time = request_wait_time()
2022-07-05 02:12:54 +02:00
q.add_log_cmd(f"Updating {print_str} wait time to {wait_time}")
2022-03-02 11:44:39 +01:00
if wait_time is None:
return
param_data = pack_scalar_double_param_app_data(
object_id=PL_PCDU_ID,
domain_id=0,
unique_id=param_id,
parameter=wait_time,
)
2022-07-05 02:12:54 +02:00
q.add_pus_tc(pack_fsfw_load_param_cmd(app_data=param_data))
2022-03-02 15:06:50 +01:00
2022-08-08 16:32:18 +02:00
def pack_failure_injection_cmd(q: DefaultPusQueueHelper, param_id: int, print_str: str):
2022-07-04 17:59:09 +02:00
q.add_log_cmd(f"Inserting {print_str} error")
2022-03-02 15:06:50 +01:00
param_data = pack_boolean_parameter_app_data(
2022-03-04 10:44:55 +01:00
object_id=PL_PCDU_ID, domain_id=0, unique_id=param_id, parameter=True
2022-03-02 15:06:50 +01:00
)
2022-07-04 17:59:09 +02:00
q.add_pus_tc(pack_fsfw_load_param_cmd(app_data=param_data))
2022-08-08 16:32:18 +02:00
def pack_pl_pcdu_mode_cmd(
q: DefaultPusQueueHelper, info: str, mode: Modes, submode: int
):
2022-07-04 17:59:09 +02:00
q.add_log_cmd(info)
mode_data = pack_mode_data(object_id=PL_PCDU_ID, mode=mode, submode=submode)
2022-07-04 17:59:09 +02:00
q.add_pus_tc(
PusTelecommand(
service=200, subservice=Subservices.TC_MODE_COMMAND, app_data=mode_data
)
)