WIP: Enhancement nasa#103 - Implemented native cmdUtil

Native cmdUtil has only subset of full cmdUtil functionality
Also implemented updates to GUI and backend to support custom
byte offsets in tlm and cmd

GroundSystem.py

@@ -39,6 +39,9 @@
 # CFS Ground System: Setup and manage the main window
 #
 class GroundSystem(QMainWindow, Ui_MainWindow):
+    HDR_VER_1_OFFSET = 0
+    HDR_VER_2_OFFSET = 4
+
     #
     # Init the class
     #
@@ -51,8 +54,10 @@ def __init__(self):
 
         self.pushButtonStartTlm.clicked.connect(self.startTlmSystem)
         self.pushButtonStartCmd.clicked.connect(self.startCmdSystem)
-        self.cbHeaderVer.currentIndexChanged.connect(self.setFixedOffset)
-        self.sbOffset.valueChanged.connect(self.getOffset)
+        self.cbTlmHeaderVer.currentIndexChanged.connect(self.setTlmOffset)
+        self.cbCmdHeaderVer.currentIndexChanged.connect(self.setCmdOffsets)
+        for sb in (self.sbTlmOffset, self.sbCmdOffsetPri, self.sbCmdOffsetSec):
+            sb.valueChanged.connect(self.saveOffsets)
         # Init lists
         self.ipAddressesList = ['All']
         self.spacecraftNames = ['All']
@@ -115,19 +120,35 @@ def startFDLSystem(self):
                 subscription
             ])
 
-    def setFixedOffset(self):
-        selectedVer = self.cbHeaderVer.currentText().strip()
+    def setTlmOffset(self):
+        selectedVer = self.cbTlmHeaderVer.currentText().strip()
+        if selectedVer == "Custom":
+            self.sbTlmOffset.setEnabled(True)
+        else:
+            self.sbTlmOffset.setEnabled(False)
+            if selectedVer == "1":
+                self.sbTlmOffset.setValue(self.HDR_VER_1_OFFSET)
+            elif selectedVer == "2":
+                self.sbTlmOffset.setValue(self.HDR_VER_2_OFFSET)
+
+    def setCmdOffsets(self):
+        selectedVer = self.cbCmdHeaderVer.currentText().strip()
         if selectedVer == "Custom":
-            self.sbOffset.setEnabled(True)
+            self.sbCmdOffsetPri.setEnabled(True)
+            self.sbCmdOffsetSec.setEnabled(True)
         else:
-            self.sbOffset.setEnabled(False)
+            self.sbCmdOffsetPri.setEnabled(False)
+            self.sbCmdOffsetSec.setEnabled(False)
             if selectedVer == "1":
-                self.sbOffset.setValue(0)
+                self.sbCmdOffsetPri.setValue(self.HDR_VER_1_OFFSET)
             elif selectedVer == "2":
-                self.sbOffset.setValue(4)
+                self.sbCmdOffsetPri.setValue(self.HDR_VER_2_OFFSET)
+            self.sbCmdOffsetSec.setValue(self.HDR_VER_1_OFFSET)
 
-    def getOffset(self):
-        shared.offsetVal = self.sbOffset.value()
+    def saveOffsets(self):
+        shared.tlmOffset = self.sbTlmOffset.value()
+        shared.cmdOffsetPri = self.sbCmdOffsetPri.value()
+        shared.cmdOffsetSec = self.sbCmdOffsetSec.value()
 
     # Update the combo box list in gui
     def updateIpList(self, ip, name):

MainWindow.ui

@@ -9,8 +9,8 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>452</width>
-    <height>265</height>
+    <width>552</width>
+    <height>305</height>
    </rect>
   </property>
   <property name="sizePolicy">
@@ -103,20 +103,20 @@
         </property>
         <property name="minimumSize">
          <size>
-          <width>141</width>
+          <width>169</width>
           <height>0</height>
          </size>
         </property>
         <property name="text">
-         <string>Header version</string>
+         <string>Tlm header version</string>
         </property>
         <property name="alignment">
          <set>Qt::AlignLeading|Qt::AlignLeft|Qt::AlignVCenter</set>
         </property>
        </widget>
       </item>
       <item row="1" column="1">
-       <widget class="QComboBox" name="cbHeaderVer">
+       <widget class="QComboBox" name="cbTlmHeaderVer">
         <property name="minimumSize">
          <size>
           <width>132</width>
@@ -146,13 +146,65 @@
         </item>
        </widget>
       </item>
+      <item row="2" column="0">
+       <widget class="QLabel" name="label_2">
+        <property name="text">
+         <string>Cmd header version</string>
+        </property>
+       </widget>
+      </item>
       <item row="1" column="2">
-       <widget class="QSpinBox" name="sbOffset">
+       <widget class="QSpinBox" name="sbTlmOffset">
+        <property name="enabled">
+         <bool>false</bool>
+        </property>
+        <property name="toolTip">
+         <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Offset (in bytes) to be &lt;span style=&quot; font-weight:600;&quot;&gt;added to&lt;/span&gt; existing offsets listed in telemetry text files&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+        </property>
+        <property name="buttonSymbols">
+         <enum>QAbstractSpinBox::NoButtons</enum>
+        </property>
+       </widget>
+      </item>
+      <item row="2" column="2">
+       <widget class="QSpinBox" name="sbCmdOffsetPri">
+        <property name="enabled">
+         <bool>false</bool>
+        </property>
+        <property name="toolTip">
+         <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Offset (in bytes) to be added &lt;span style=&quot; font-weight:600;&quot;&gt;after&lt;/span&gt; the &lt;span style=&quot; font-weight:600;&quot;&gt;primary&lt;/span&gt; header in a command packet&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+        </property>
+        <property name="buttonSymbols">
+         <enum>QAbstractSpinBox::NoButtons</enum>
+        </property>
+       </widget>
+      </item>
+      <item row="2" column="1">
+       <widget class="QComboBox" name="cbCmdHeaderVer">
+        <item>
+         <property name="text">
+          <string>1</string>
+         </property>
+        </item>
+        <item>
+         <property name="text">
+          <string>2</string>
+         </property>
+        </item>
+        <item>
+         <property name="text">
+          <string>Custom</string>
+         </property>
+        </item>
+       </widget>
+      </item>
+      <item row="2" column="3">
+       <widget class="QSpinBox" name="sbCmdOffsetSec">
         <property name="enabled">
          <bool>false</bool>
         </property>
         <property name="toolTip">
-         <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Offset (in bytes) to be *added to* existing offsets listed in tlm/cmd text files&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+         <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;Offset (in bytes) to be added &lt;span style=&quot; font-weight:600;&quot;&gt;after&lt;/span&gt; the &lt;span style=&quot; font-weight:600;&quot;&gt;secondary&lt;/span&gt; header in a command packet&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
         </property>
         <property name="buttonSymbols">
          <enum>QAbstractSpinBox::NoButtons</enum>
@@ -162,7 +214,14 @@
       <item row="0" column="2">
        <widget class="QLabel" name="label">
         <property name="text">
-         <string>Offset (bytes)</string>
+         <string>Offsets</string>
+        </property>
+       </widget>
+      </item>
+      <item row="0" column="3">
+       <widget class="QLabel" name="label_6">
+        <property name="text">
+         <string>(Hover for info)</string>
         </property>
        </widget>
       </item>

Subsystems/cmdGui/MiniCmdUtil.py

@@ -0,0 +1,69 @@
+#
+#  GSC-18128-1, "Core Flight Executive Version 6.7"
+#
+#  Copyright (c) 2006-2019 United States Government as represented by
+#  the Administrator of the National Aeronautics and Space Administration.
+#  All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+## This file is a Python implementation of a subset of functions in cmdUtil
+## to support the GroundSystem GUI
+
+import socket
+import sys
+from pathlib import Path
+
+ROOTDIR = Path().resolve().parent
+sys.path.append(ROOTDIR.parent.parent)
+## The two preceding lines must be above
+## the next import or the import will fail
+import common.shareddata as shared
+
+
+class MiniCmdUtil:
+    ccsdsExt = bytearray(4)
+    cfsCmdSecHdr = bytearray(2)
+
+    def __init__(self,
+                 host="127.0.0.1",
+                 port="1234",
+                 endian="BE",
+                 hdrVer=1,
+                 pktID=None,
+                 cmdCode=None,
+                 payload=None):
+        endians = {"BE": ">", "LE": "<"}
+
+        self.host = host
+        self.port = port
+        self.endian = ">" if endian == "BE" else "<"
+        self.pktID = pktID
+        self.cmdCode = cmdCode
+        self.hdrVer = hdrVer
+        self.payload = payload
+
+        self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+
+
+def assemblePriHeader(self):
+    ccsdsPri = bytearray(6)
+    ccsdsPri[0:2] = self.pktID.to_bytes(2, byteorder='big')
+    ccsdsPri[2:4] = (0xC000).to_bytes(2, byteorder='big')
+    totalPacketLen = len(ccsdsPri) + len(self.cfsCmdSecHdr)
+    if self.hdrVer == 2:
+        totalPacketLen += len(self.ccsdsExt)
+
+def assemblePayload(self):
+    pass

Subsystems/tlmGUI/GenericTelemetry.py

@@ -60,7 +60,7 @@ def displayTelemetryItem(datagram, tlmIndex, labelField, valueField):
             TlmField1 = tlmItemFormat[tlmIndex]
             if TlmField1[0] == "<":
                 TlmField1 = TlmField1[1:]
-            itemStart = int(tlmItemStart[tlmIndex]) + shared.offsetVal
+            itemStart = int(tlmItemStart[tlmIndex]) + shared.tlmOffset
             TlmField2 = datagram[itemStart:itemStart +
                                  int(tlmItemSize[tlmIndex])]
             TlmField = unpack(TlmField1, TlmField2)

Ui_MainWindow.py

@@ -12,7 +12,7 @@ class Ui_MainWindow(object):
     def setupUi(self, MainWindow):
         MainWindow.setObjectName("MainWindow")
         MainWindow.setEnabled(True)
-        MainWindow.resize(452, 265)
+        MainWindow.resize(552, 305)
         sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Preferred, QtWidgets.QSizePolicy.Preferred)
         sizePolicy.setHorizontalStretch(24)
         sizePolicy.setVerticalStretch(0)
@@ -60,26 +60,48 @@ def setupUi(self, MainWindow):
         sizePolicy.setVerticalStretch(0)
         sizePolicy.setHeightForWidth(self.label_4.sizePolicy().hasHeightForWidth())
         self.label_4.setSizePolicy(sizePolicy)
-        self.label_4.setMinimumSize(QtCore.QSize(141, 0))
+        self.label_4.setMinimumSize(QtCore.QSize(169, 0))
         self.label_4.setAlignment(QtCore.Qt.AlignLeading|QtCore.Qt.AlignLeft|QtCore.Qt.AlignVCenter)
         self.label_4.setObjectName("label_4")
         self.gridLayout.addWidget(self.label_4, 1, 0, 1, 1)
-        self.cbHeaderVer = QtWidgets.QComboBox(self.centralwidget)
-        self.cbHeaderVer.setMinimumSize(QtCore.QSize(132, 0))
-        self.cbHeaderVer.setMaximumSize(QtCore.QSize(132, 16777215))
-        self.cbHeaderVer.setObjectName("cbHeaderVer")
-        self.cbHeaderVer.addItem("")
-        self.cbHeaderVer.addItem("")
-        self.cbHeaderVer.addItem("")
-        self.gridLayout.addWidget(self.cbHeaderVer, 1, 1, 1, 1)
-        self.sbOffset = QtWidgets.QSpinBox(self.centralwidget)
-        self.sbOffset.setEnabled(False)
-        self.sbOffset.setButtonSymbols(QtWidgets.QAbstractSpinBox.NoButtons)
-        self.sbOffset.setObjectName("sbOffset")
-        self.gridLayout.addWidget(self.sbOffset, 1, 2, 1, 1)
+        self.cbTlmHeaderVer = QtWidgets.QComboBox(self.centralwidget)
+        self.cbTlmHeaderVer.setMinimumSize(QtCore.QSize(132, 0))
+        self.cbTlmHeaderVer.setMaximumSize(QtCore.QSize(132, 16777215))
+        self.cbTlmHeaderVer.setObjectName("cbTlmHeaderVer")
+        self.cbTlmHeaderVer.addItem("")
+        self.cbTlmHeaderVer.addItem("")
+        self.cbTlmHeaderVer.addItem("")
+        self.gridLayout.addWidget(self.cbTlmHeaderVer, 1, 1, 1, 1)
+        self.label_2 = QtWidgets.QLabel(self.centralwidget)
+        self.label_2.setObjectName("label_2")
+        self.gridLayout.addWidget(self.label_2, 2, 0, 1, 1)
+        self.sbTlmOffset = QtWidgets.QSpinBox(self.centralwidget)
+        self.sbTlmOffset.setEnabled(False)
+        self.sbTlmOffset.setButtonSymbols(QtWidgets.QAbstractSpinBox.NoButtons)
+        self.sbTlmOffset.setObjectName("sbTlmOffset")
+        self.gridLayout.addWidget(self.sbTlmOffset, 1, 2, 1, 1)
+        self.sbCmdOffsetPri = QtWidgets.QSpinBox(self.centralwidget)
+        self.sbCmdOffsetPri.setEnabled(False)
+        self.sbCmdOffsetPri.setButtonSymbols(QtWidgets.QAbstractSpinBox.NoButtons)
+        self.sbCmdOffsetPri.setObjectName("sbCmdOffsetPri")
+        self.gridLayout.addWidget(self.sbCmdOffsetPri, 2, 2, 1, 1)
+        self.cbCmdHeaderVer = QtWidgets.QComboBox(self.centralwidget)
+        self.cbCmdHeaderVer.setObjectName("cbCmdHeaderVer")
+        self.cbCmdHeaderVer.addItem("")
+        self.cbCmdHeaderVer.addItem("")
+        self.cbCmdHeaderVer.addItem("")
+        self.gridLayout.addWidget(self.cbCmdHeaderVer, 2, 1, 1, 1)
+        self.sbCmdOffsetSec = QtWidgets.QSpinBox(self.centralwidget)
+        self.sbCmdOffsetSec.setEnabled(False)
+        self.sbCmdOffsetSec.setButtonSymbols(QtWidgets.QAbstractSpinBox.NoButtons)
+        self.sbCmdOffsetSec.setObjectName("sbCmdOffsetSec")
+        self.gridLayout.addWidget(self.sbCmdOffsetSec, 2, 3, 1, 1)
         self.label = QtWidgets.QLabel(self.centralwidget)
         self.label.setObjectName("label")
         self.gridLayout.addWidget(self.label, 0, 2, 1, 1)
+        self.label_6 = QtWidgets.QLabel(self.centralwidget)
+        self.label_6.setObjectName("label_6")
+        self.gridLayout.addWidget(self.label_6, 0, 3, 1, 1)
         self.verticalLayout.addLayout(self.gridLayout)
         self.horizontalLayout_2 = QtWidgets.QHBoxLayout()
         self.horizontalLayout_2.setSpacing(32)
@@ -135,12 +157,19 @@ def retranslateUi(self, MainWindow):
         self.labelHomeTitle.setText(_translate("MainWindow", "CFS Ground System"))
         self.label_3.setText(_translate("MainWindow", "Selected IP Address"))
         self.comboBoxIpAddresses.setItemText(0, _translate("MainWindow", "All"))
-        self.label_4.setText(_translate("MainWindow", "Header version"))
-        self.cbHeaderVer.setItemText(0, _translate("MainWindow", "1"))
-        self.cbHeaderVer.setItemText(1, _translate("MainWindow", "2"))
-        self.cbHeaderVer.setItemText(2, _translate("MainWindow", "Custom"))
-        self.sbOffset.setToolTip(_translate("MainWindow", "<html><head/><body><p>Offset (in bytes) to be *added to* existing offsets listed in tlm/cmd text files</p></body></html>"))
-        self.label.setText(_translate("MainWindow", "Offset (bytes)"))
+        self.label_4.setText(_translate("MainWindow", "Tlm header version"))
+        self.cbTlmHeaderVer.setItemText(0, _translate("MainWindow", "1"))
+        self.cbTlmHeaderVer.setItemText(1, _translate("MainWindow", "2"))
+        self.cbTlmHeaderVer.setItemText(2, _translate("MainWindow", "Custom"))
+        self.label_2.setText(_translate("MainWindow", "Cmd header version"))
+        self.sbTlmOffset.setToolTip(_translate("MainWindow", "<html><head/><body><p>Offset (in bytes) to be <span style=\" font-weight:600;\">added to</span> existing offsets listed in telemetry text files</p></body></html>"))
+        self.sbCmdOffsetPri.setToolTip(_translate("MainWindow", "<html><head/><body><p>Offset (in bytes) to be added <span style=\" font-weight:600;\">after</span> the <span style=\" font-weight:600;\">primary</span> header in a command packet</p></body></html>"))
+        self.cbCmdHeaderVer.setItemText(0, _translate("MainWindow", "1"))
+        self.cbCmdHeaderVer.setItemText(1, _translate("MainWindow", "2"))
+        self.cbCmdHeaderVer.setItemText(2, _translate("MainWindow", "Custom"))
+        self.sbCmdOffsetSec.setToolTip(_translate("MainWindow", "<html><head/><body><p>Offset (in bytes) to be added <span style=\" font-weight:600;\">after</span> the <span style=\" font-weight:600;\">secondary</span> header in a command packet</p></body></html>"))
+        self.label.setText(_translate("MainWindow", "Offsets"))
+        self.label_6.setText(_translate("MainWindow", "(Hover for info)"))
         self.pushButtonStartTlm.setText(_translate("MainWindow", "Start Telemetry System"))
         self.pushButtonStartCmd.setText(_translate("MainWindow", "Start Command System"))
         self.label_5.setText(_translate("MainWindow", "*Read Guide-GroundSystem.txt for help"))

common/shareddata.py

@@ -22,4 +22,6 @@
 # IMPORTANT: ANY class importing this module can read/write any of the data.
 # Use caution when read/writing data here.
 
-offsetVal = 0
+tlmOffset = 0
+cmdOffsetPri = 0
+cmdOffsetSec = 0