ploc tests

config/definitions.py

@@ -15,3 +15,5 @@ class CustomServiceList(enum.Enum):
     TMP1075_1 = "tmp1075_1"
     TMP1075_2 = "tmp1075_2"
     HEATER = "heater"
+    IMTQ = "imtq"
+    PLOC = "ploc"

config/object_ids.py

@@ -18,6 +18,8 @@ TMP_1075_2_HANDLER_ID = bytearray([0x44, 0x00, 0x00, 0x6])
 HEATER_ID = bytearray([0x54, 0x00, 0x00, 0x1])
 PCDU_HANDLER_ID = bytearray([0x44, 0x00, 0x10, 0x00])
 SOLAR_ARRAY_DEPLOYMENT_ID = bytearray([0x44, 0x00, 0x10, 0x01])
+IMTQ_HANDLER_ID = bytearray([0x44, 0x00, 0x00, 0x14])
+PLOC_ID = bytearray([0x44, 0x00, 0x00, 0x15])
 
 
 class ObjIdIds(enum.IntEnum):
@@ -32,6 +34,8 @@ class ObjIdIds(enum.IntEnum):
     TMP1075_2_HANDLER_ID = 8
     HEATER_ID = 9
     SOLAR_ARRAY_DEPLOYMENT_ID = 10
+    IMTQ_HANDLER_ID = 11
+    PLOC_ID = 12
 
 
 def set_object_ids() -> Dict[int, bytearray]:
@@ -47,5 +51,7 @@ def set_object_ids() -> Dict[int, bytearray]:
          ObjIdIds.HEATER_ID: HEATER_ID,
          ObjIdIds.PCDU_HANDLER_ID: PCDU_HANDLER_ID,
          ObjIdIds.SOLAR_ARRAY_DEPLOYMENT_ID: SOLAR_ARRAY_DEPLOYMENT_ID,
+         ObjIdIds.IMTQ_HANDLER_ID: IMTQ_HANDLER_ID,
+         ObjIdIds.PLOC_ID: PLOC_ID
     })
     return object_id_dict

gomspace/gomspace_pdu_definitions.py

@@ -6,6 +6,11 @@ class PDUConfigTable:
     out_en_1 = TableEntry(bytearray([0x00, 0x49]), TableEntry.uint8_size)
     out_en_2 = TableEntry(bytearray([0x00, 0x4A]), TableEntry.uint8_size)
     out_en_3 = TableEntry(bytearray([0x00, 0x4B]), TableEntry.uint8_size)
+    out_en_4 = TableEntry(bytearray([0x00, 0x4C]), TableEntry.uint8_size)
+    out_en_5 = TableEntry(bytearray([0x00, 0x4D]), TableEntry.uint8_size)
+    out_en_6 = TableEntry(bytearray([0x00, 0x4E]), TableEntry.uint8_size)
+    out_en_7 = TableEntry(bytearray([0x00, 0x4F]), TableEntry.uint8_size)
+    out_en_8 = TableEntry(bytearray([0x00, 0x50]), TableEntry.uint8_size)
     # When channel consumes more than cur_lu_lim, channel is turned of immediately
     cur_lu_lim_0 = TableEntry(bytearray([0x00, 0xB8]), TableEntry.uint16_size)
 

pus_tc/imtq.py

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+"""
+@file   imtq.py
+@brief  Tests for the ISIS IMTQ (Magnettorquer) device handler
+@author J. Meier
+@date   25.03.2021
+"""
+from tmtccmd.core.definitions import QueueCommands
+
+from tmtccmd.pus_tc.packer import TcQueueT
+from tmtccmd.ecss.tc import PusTelecommand
+
+
+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
+    command_dipole = True
+    get_commanded_dipole = True
+
+
+class ImtqActionIds:
+    start_actuation_dipole = bytearray([0x0, 0x0, 0x0, 0x02])
+    get_commanded_dipole = bytearray([0x0, 0x0, 0x0, 0x03])
+
+
+def pack_imtq_test_into(object_id: bytearray, tc_queue: TcQueueT) -> TcQueueT:
+    tc_queue.appendleft(
+        (QueueCommands.PRINT,
+         "Testing ISIS IMTQ handler with object id: 0x" + object_id.hex())
+    )
+
+    if ImtqTestProcedure.all or ImtqTestProcedure.command_dipole:
+        tc_queue.appendleft((QueueCommands.PRINT, "IMTQ: Commanding dipole"))
+        command = pack_dipole_command(object_id, 2000, 2000, 2000, 10000)
+        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
+        command = PusTelecommand(service=8, subservice=128, ssc=20, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+
+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.
+    @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)
+    @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
+    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

pus_tc/pdu1.py

@@ -24,6 +24,10 @@ class PDU1TestProcedure:
     reboot = False
     ping = False
     read_temperature = False
+    turn_channel_2_on = False    # Star Tracker connected to this channel (5V)
+    turn_channel_2_off = False
+    turn_channel_3_on = False  # MTQ connected to this channel (5V)
+    turn_channel_3_off = True
 
 
 def pack_pdu1_test_into(
@@ -31,14 +35,6 @@ def pack_pdu1_test_into(
 ):
     tc_queue.appendleft((QueueCommands.PRINT, "Testing PDU1"))
 
-    tc_queue.appendleft((QueueCommands.PRINT, "P60 Dock: Enabling PDU1"))
-    command = pack_set_param_command(
-        p60dock_object_id, P60DockConfigTable.out_en_1.parameter_address,
-        P60DockConfigTable.out_en_1.parameter_size, Channel.on
-    )
-    command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
-    tc_queue.appendleft(command.pack_command_tuple())
-
     if PDU1TestProcedure.all or PDU1TestProcedure.ping:
         tc_queue.appendleft((QueueCommands.PRINT, "PDU1: Ping Test"))
         ping_data = bytearray([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
@@ -53,3 +49,27 @@ def pack_pdu1_test_into(
         )
         command = PusTelecommand(service=8, subservice=128, ssc=24, app_data=command)
         tc_queue.appendleft(command.pack_command_tuple())
+    if PDU1TestProcedure.all or PDU1TestProcedure.turn_channel_2_on:
+        tc_queue.appendleft((QueueCommands.PRINT, "PDU1: Turn channel 2 on (Star Tracker)"))
+        command = pack_set_param_command(pdu1_object_id, PDUConfigTable.out_en_2.parameter_address,
+                                         PDUConfigTable.out_en_2.parameter_size, Channel.on)
+        command = PusTelecommand(service=8, subservice=128, ssc=30, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+    if PDU1TestProcedure.all or PDU1TestProcedure.turn_channel_2_off:
+        tc_queue.appendleft((QueueCommands.PRINT, "PDU1: Turn channel 2 off (Star Tracker)"))
+        command = pack_set_param_command(pdu1_object_id, PDUConfigTable.out_en_2.parameter_address,
+                                         PDUConfigTable.out_en_2.parameter_size, Channel.off)
+        command = PusTelecommand(service=8, subservice=128, ssc=31, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+    if PDU1TestProcedure.all or PDU1TestProcedure.turn_channel_3_on:
+        tc_queue.appendleft((QueueCommands.PRINT, "PDU1: Turn channel 3 on (MTQ)"))
+        command = pack_set_param_command(pdu1_object_id, PDUConfigTable.out_en_3.parameter_address,
+                                         PDUConfigTable.out_en_3.parameter_size, Channel.on)
+        command = PusTelecommand(service=8, subservice=128, ssc=32, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+    if PDU1TestProcedure.all or PDU1TestProcedure.turn_channel_3_off:
+        tc_queue.appendleft((QueueCommands.PRINT, "PDU1: Turn channel 3 off (MTQ)"))
+        command = pack_set_param_command(pdu1_object_id, PDUConfigTable.out_en_3.parameter_address,
+                                         PDUConfigTable.out_en_3.parameter_size, Channel.off)
+        command = PusTelecommand(service=8, subservice=128, ssc=33, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())

pus_tc/pdu2.py

@@ -101,4 +101,5 @@ def pack_pdu2_test_into(pdu2_object_id: bytearray, p60dock_object_id: bytearray,
         command = pack_request_full_hk_table_command(pdu2_object_id)
         command = PusTelecommand(service=8, subservice=128, ssc=28, app_data=command)
         tc_queue.appendleft(command.pack_command_tuple())
+
     return tc_queue

pus_tc/ploc.py

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+"""
+@file   ploc.py
+@brief  TMP1075 tests
+@author J. Meier
+@date   06.01.2021
+"""
+import struct
+
+from tmtccmd.core.definitions import QueueCommands
+
+from tmtccmd.pus_tc.packer import TcQueueT
+from tmtccmd.ecss.tc import PusTelecommand
+
+
+class PlocTestProcedure:
+    """
+    @brief  Use this class to define the tests to perform for the PLOC.
+    @details    Setting all to True will run all tests.
+                Setting all to False will only run the tests set to True.
+    """
+    all = False
+    test_tc_mem_write = False
+    test_tc_mem_read = True
+
+
+class PlocActionIds:
+    tc_mem_write = bytearray([0x0, 0x0, 0x0, 0x1])
+    tc_mem_read = bytearray([0x0, 0x0, 0x0, 0x2])
+
+
+class PlocReplyIds:
+    tm_mem_read_report = 6
+
+
+def pack_ploc_test_into(object_id: bytearray, tc_queue: TcQueueT) -> TcQueueT:
+    tc_queue.appendleft(
+        (QueueCommands.PRINT,
+         "Testing PLOC Handler with object id: 0x" + object_id.hex())
+    )
+
+    if PlocTestProcedure.all or PlocTestProcedure.test_tc_mem_write:
+        tc_queue.appendleft((QueueCommands.PRINT, "PLOC: TC Mem Write Test"))
+        memory_address = int(input("PLOC Tc Mem Write: Type memory address: 0x"), 16)
+        memory_data = int(input("PLOC Tc Mem Write: Type memory data: 0x"), 16)
+        command = generate_write_mem_command(object_id, struct.pack('!I', memory_address), memory_data)
+        command = PusTelecommand(service=8, subservice=128, ssc=23, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    if PlocTestProcedure.all or PlocTestProcedure.test_tc_mem_read:
+        tc_queue.appendleft((QueueCommands.PRINT, "PLOC: TC Mem Read Test"))
+        memory_address = int(input("PLOC Tc Mem Read: Type memory address: 0x"), 16)
+        command = object_id + PlocActionIds.tc_mem_read + struct.pack('!I', memory_address)
+        command = PusTelecommand(service=8, subservice=128, ssc=24, app_data=command)
+        tc_queue.appendleft(command.pack_command_tuple())
+
+    return tc_queue
+
+
+def generate_write_mem_command(object_id: bytearray, memory_address: bytearray, memory_data: int) -> bytearray:
+    """ This function generates the command to write to a memory address within the PLOC
+    @param object_id    The object id of the PlocHandler
+    @param memory_address   The PLOC memory address where to write to.
+    @param memory_data    The data to write to the memory address specified by the bytearray memory_address.
+    """
+    command = object_id + PlocActionIds.tc_mem_write + memory_address + struct.pack('!I', memory_data)
+    return command

pus_tc/tc_packer_hook.py

@@ -19,7 +19,9 @@ from pus_tc.p60dock import pack_p60dock_test_into
 from pus_tc.pdu2 import pack_pdu2_test_into
 from pus_tc.pdu1 import pack_pdu1_test_into
 from pus_tc.acu import pack_acu_test_into
+from pus_tc.imtq import pack_imtq_test_into
 from pus_tc.tmp1075 import pack_tmp1075_test_into
+from pus_tc.ploc import pack_ploc_test_into
 from pus_tc.heater import pack_heater_test_into
 from config.definitions import CustomServiceList
 from config.object_ids import ObjIdIds
@@ -54,8 +56,14 @@ def pack_service_queue_user(service: Union[str, int], op_code: str, service_queu
         object_id = get_object_id(ObjIdIds.TMP1075_2_HANDLER_ID)
         return pack_tmp1075_test_into(object_id, service_queue)
     if service == CustomServiceList.HEATER.value:
-        object_id = get_object_id(ObjIdIds.HEATER)
+        object_id = get_object_id(ObjIdIds.HEATER_ID)
         return pack_heater_test_into(object_id, service_queue)
+    if service == CustomServiceList.IMTQ.value:
+        object_id = get_object_id(ObjIdIds.IMTQ_HANDLER_ID)
+        return pack_imtq_test_into(object_id, service_queue)
+    if service == CustomServiceList.PLOC.value:
+        object_id = get_object_id(ObjIdIds.PLOC_ID)
+        return pack_ploc_test_into(object_id, service_queue)
     LOGGER.warning("Invalid Service !")
 
 

pus_tc/tmp1075.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-@file   tmtcc_tc_tmp1075.py
+@file   tmp1075.py
 @brief  TMP1075 tests
 @author J. Meier
 @date   06.01.2021

pus_tm/service_8_hook.py

@@ -1,5 +1,8 @@
+import struct
 from typing import Tuple
 from config.object_ids import ObjIdIds
+from pus_tc.imtq import ImtqActionIds
+from pus_tc.ploc import PlocReplyIds
 
 
 def user_analyze_service_8_data(
@@ -25,7 +28,31 @@ def user_analyze_service_8_data(
         data_string = data_string.rstrip(',')
         data_string = data_string.rstrip()
         content_list = [data_string]
+    elif object_id == ObjIdIds.IMTQ_HANDLER_ID:
+        return handle_imtq_replies(action_id, custom_data)
+    elif object_id == ObjIdIds.PLOC_ID:
+        return handle_ploc_replies(action_id, custom_data)
     else:
         header_list = []
         content_list = []
     return header_list, content_list
+
+
+def handle_imtq_replies(action_id: int, custom_data: bytearray) -> Tuple[list, list]:
+    header_list = []
+    content_list = []
+    if action_id == struct.unpack('!I', ImtqActionIds.get_commanded_dipole)[0]:
+        header_list = ['Commanded X-Dipole', 'Commanded Y-Dipole', 'Commanded Z-Dipole']
+        x_dipole = struct.unpack('!H', custom_data[:2])
+        y_dipole = struct.unpack('!H', custom_data[2:4])
+        z_dipole = struct.unpack('!H', custom_data[4:6])
+        content_list = [x_dipole[0], y_dipole[0], z_dipole[0]]
+
+
+def handle_ploc_replies(action_id: int, custom_data: bytearray) -> Tuple[list, list]:
+    header_list = []
+    content_list = []
+    if action_id == PlocReplyIds.tm_mem_read_report:
+        header_list = ['PLOC Memory Address', 'PLOC Mem Len', 'PLOC Read Memory Data']
+        content_list = [custom_data[:4], custom_data[4:6], custom_data[6:10]]
+    return header_list, content_list