2021-03-25 17:53:05 +01:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
|
|
@file imtq.py
|
|
|
|
@brief Tests for the ISIS IMTQ (Magnettorquer) device handler
|
|
|
|
@author J. Meier
|
|
|
|
@date 25.03.2021
|
|
|
|
"""
|
2021-06-12 13:49:25 +02:00
|
|
|
from tmtccmd.config.definitions import QueueCommands
|
2021-03-25 17:53:05 +01:00
|
|
|
|
|
|
|
from tmtccmd.pus_tc.packer import TcQueueT
|
2021-04-25 17:46:53 +02:00
|
|
|
from tmtccmd.ecss.tc import PusTelecommand
|
2021-06-12 13:49:25 +02:00
|
|
|
from tmtccmd.pus_tc.service_3_housekeeping import make_sid, generate_one_hk_command
|
2021-03-25 17:53:05 +01:00
|
|
|
|
|
|
|
|
|
|
|
class ImtqTestProcedure:
|
|
|
|
"""
|
|
|
|
@brief Use this class to define the tests to perform for the IMTQ Handler.
|
|
|
|
@details Setting all to True will run all tests.
|
|
|
|
Setting all to False will only run the tests set to True.
|
|
|
|
"""
|
|
|
|
all = False
|
2021-06-12 13:49:25 +02:00
|
|
|
command_dipole = False
|
|
|
|
get_commanded_dipole = False
|
|
|
|
positive_x_test = True
|
|
|
|
negative_x_test = False
|
|
|
|
positive_y_test = False
|
|
|
|
negative_y_test = False
|
|
|
|
positive_z_test = False
|
|
|
|
negative_z_test = False
|
|
|
|
|
|
|
|
class SetIds:
|
|
|
|
POSITIVE_X_TEST = 1
|
|
|
|
NEGATIVE_X_TEST = 2
|
|
|
|
POSITIVE_Y_TEST = 3
|
|
|
|
NEGATIVE_Y_TEST = 4
|
|
|
|
POSITIVE_Z_TEST = 5
|
|
|
|
NEGATIVE_Z_TEST = 6
|
2021-03-25 17:53:05 +01:00
|
|
|
|
|
|
|
|
|
|
|
class ImtqActionIds:
|
|
|
|
start_actuation_dipole = bytearray([0x0, 0x0, 0x0, 0x02])
|
2021-04-25 17:46:53 +02:00
|
|
|
get_commanded_dipole = bytearray([0x0, 0x0, 0x0, 0x03])
|
2021-06-12 13:49:25 +02:00
|
|
|
perform_positive_x_test = bytearray([0x0, 0x0, 0x0, 0x07])
|
|
|
|
perform_negative_x_test = bytearray([0x0, 0x0, 0x0, 0x08])
|
|
|
|
perform_positive_y_test = bytearray([0x0, 0x0, 0x0, 0x09])
|
|
|
|
perform_negative_y_test = bytearray([0x0, 0x0, 0x0, 0x0A])
|
|
|
|
perform_positive_z_test = bytearray([0x0, 0x0, 0x0, 0x0B])
|
|
|
|
perform_negative_z_test = bytearray([0x0, 0x0, 0x0, 0x0C])
|
|
|
|
# Initiates the reading of the last performed self test. After sending this command the results can be downlinked
|
|
|
|
# via the housekeeping service by using the appropriate set ids listed above.
|
|
|
|
read_self_test_results = bytearray([0x0, 0x0, 0x0, 0x0D])
|
2021-03-25 17:53:05 +01:00
|
|
|
|
|
|
|
|
2021-06-12 13:49:25 +02:00
|
|
|
def pack_imtq_test_into(object_id: bytearray, tc_queue: TcQueueT, op_code: str) -> TcQueueT:
|
2021-03-25 17:53:05 +01:00
|
|
|
tc_queue.appendleft(
|
|
|
|
(QueueCommands.PRINT,
|
2021-03-26 13:56:02 +01:00
|
|
|
"Testing ISIS IMTQ handler with object id: 0x" + object_id.hex())
|
2021-03-25 17:53:05 +01:00
|
|
|
)
|
|
|
|
|
|
|
|
if ImtqTestProcedure.all or ImtqTestProcedure.command_dipole:
|
|
|
|
tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Commanding dipole"))
|
2021-04-26 14:56:51 +02:00
|
|
|
command = pack_dipole_command(object_id, 2000, 2000, 2000, 10000)
|
2021-04-25 17:46:53 +02:00
|
|
|
command = PusTelecommand(service=8, subservice=128, ssc=20, app_data=command)
|
|
|
|
tc_queue.appendleft(command.pack_command_tuple())
|
|
|
|
|
|
|
|
if ImtqTestProcedure.all or ImtqTestProcedure.get_commanded_dipole:
|
|
|
|
tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Get commanded dipole"))
|
|
|
|
command = object_id + ImtqActionIds.get_commanded_dipole
|
2021-06-12 13:49:25 +02:00
|
|
|
command = PusTelecommand(service=8, subservice=128, ssc=21, app_data=command)
|
2021-03-25 17:53:05 +01:00
|
|
|
tc_queue.appendleft(command.pack_command_tuple())
|
|
|
|
|
2021-06-12 13:49:25 +02:00
|
|
|
if op_code == "0" or op_code == "1":
|
|
|
|
tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Perform positive x self test"))
|
|
|
|
command = object_id + ImtqActionIds.perform_positive_x_test
|
|
|
|
command = PusTelecommand(service=8, subservice=128, ssc=22, app_data=command)
|
|
|
|
tc_queue.appendleft(command.pack_command_tuple())
|
|
|
|
|
|
|
|
tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Initiate reading of positive x self test results"))
|
|
|
|
command = object_id + ImtqActionIds.read_self_test_results
|
|
|
|
command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
|
|
|
|
tc_queue.appendleft(command.pack_command_tuple())
|
|
|
|
|
|
|
|
tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Request dataset with positive x self test results"))
|
|
|
|
sid = make_sid(object_id, SetIds.POSITIVE_X_TEST)
|
|
|
|
command = generate_one_hk_command(sid, 24)
|
|
|
|
tc_queue.appendleft(command.pack_command_tuple())
|
|
|
|
|
|
|
|
return tc_queue
|
|
|
|
|
2021-03-25 17:53:05 +01:00
|
|
|
|
|
|
|
def pack_dipole_command(object_id: bytearray, x_dipole: int, y_dipole: int, z_dipole: int, duration: int) -> bytearray:
|
|
|
|
""" This function packs the command causing the ISIS IMTQ to generate a dipole.
|
|
|
|
@param object_id The object id of the gomspace device handler.
|
2021-03-26 13:56:02 +01:00
|
|
|
@param x_dipole The dipole of the x coil in 10^-4*Am^2 (max. 2000)
|
|
|
|
@param y_dipole The dipole of the y coil in 10^-4*Am^2 (max. 2000)
|
|
|
|
@param z_dipole The dipole of the z coil in 10^-4*Am^2 (max. 2000)
|
2021-03-25 17:53:05 +01:00
|
|
|
@param duration The duration in milliseconds the dipole will be generated by the coils.
|
|
|
|
When set to 0, the dipole will be generated until a new dipole actuation
|
|
|
|
command is sent.
|
|
|
|
"""
|
|
|
|
action_id = ImtqActionIds.start_actuation_dipole
|
|
|
|
command = bytearray()
|
|
|
|
command = object_id + action_id
|
2021-03-26 13:56:02 +01:00
|
|
|
command.extend(x_dipole.to_bytes(length=2, byteorder='big'))
|
|
|
|
command.extend(y_dipole.to_bytes(length=2, byteorder='big'))
|
|
|
|
command.extend(z_dipole.to_bytes(length=2, byteorder='big'))
|
|
|
|
command.extend(duration.to_bytes(length=2, byteorder='big'))
|
|
|
|
return command
|