fprime-gds 3.4.4a1__tar.gz → 3.4.4a2__tar.gz

{fprime-gds-3.4.4a1 → fprime_gds-3.4.4a2}/.github/actions/spelling/excludes.txt

@@ -1,3 +1,5 @@
+pyproject.toml
+setup.py
 ignore$
 /html/
 (?:^|/)(?i)COPYRIGHT
@@ -5,6 +7,8 @@ ignore$
 (?:^|/)vendor/
 ^\.github/
 ^Autocoders/Python/test/.*\.xml$
+RefTopologyDictionary.json
+dictionary.xml
 /doc/xml/
 /third-party/
 /third/
@@ -43,6 +47,3 @@ ignore$
 \.xlsx$
 \.xsd$
 \.ico$
-pyproject.toml
-setup.py
-dictionary.xml

{fprime-gds-3.4.4a1 → fprime_gds-3.4.4a2}/.github/actions/spelling/expect.txt

@@ -47,10 +47,12 @@ backport
 basestring
 batchmode
 baudrate
+bcolors
 beforeunload
 BGR
 Biberstein
 bibtex
+binascii
 bitmaps
 blockquote
 bmp
@@ -67,8 +69,9 @@ cata
 cbl
 CCB
 CCFF
-cdn
 Cdioux
+cdn
+cdxoefg
 CFDG
 CFDP
 CFPD
@@ -76,6 +79,7 @@ cgi
 Chainable
 chartjs
 checkbox
+CHNG
 chrono
 classdocs
 classmethod
@@ -85,6 +89,7 @@ cls
 CMake
 cmdhist
 cmds
+cmp
 CODEFILE
 Codemirror
 colorized
@@ -95,8 +100,8 @@ combuffer
 commandsi
 concat
 config
-configs
 configparser
+configs
 Consolas
 cpp
 CPython
@@ -128,9 +133,12 @@ deframed
 deframer
 deframing
 DEPRECATEDLIST
+DESER
+Deserial
 deserialization
 deserialize
 deserialized
+deserializes
 deserializing
 dest
 dexc
@@ -166,10 +174,14 @@ doxyrules
 doxysearch
 Doxywizard
 doy
+dpi
+dps
+dpspec
 dropdown
 dropleft
 dropright
 dropup
+Drv
 Dsh
 dst
 dts
@@ -183,6 +195,7 @@ EINPROGRESS
 elif
 Emoji
 encodable
+ENDC
 endcond
 endian
 endif
@@ -191,6 +204,7 @@ endtime
 enqueuing
 entrypoint
 enum
+Enumtype
 envvar
 errno
 errored
@@ -216,9 +230,12 @@ FFCC
 FFFF
 fieldset
 figcaption
+figsize
+filecmp
 filemode
 fileno
 filepath
+filesize
 fileurl
 finditer
 Firefox
@@ -229,6 +246,7 @@ focusring
 FONTNAME
 FONTPATH
 FONTSIZE
+fpp
 fprime
 fptable
 frac
@@ -277,6 +295,7 @@ hidecallergraph
 hidecallgraph
 hideinitializer
 hlp
+HLTH
 Hookimpl
 hookspec
 hostname
@@ -360,6 +379,7 @@ libc
 libclang
 libcrc
 libiconv
+lineno
 Linting
 Linux
 listbox
@@ -384,6 +404,7 @@ MAKEVAR
 marijnh
 matchobj
 mathjax
+matplotlib
 maxcountryman
 maxdepth
 mcternan
@@ -412,6 +433,7 @@ myproject
 namespace
 nargs
 navbar
+nbytes
 Neue
 newname
 Nify
@@ -420,6 +442,7 @@ nitpicky
 noapp
 noqa
 normpath
+NOSONAR
 nosort
 Noto
 novalidate
@@ -433,6 +456,8 @@ odl
 odo
 oga
 ogg
+OKBLUE
+OKGREEN
 OMG
 onabort
 onerror
@@ -465,10 +490,12 @@ php
 phtml
 pid
 pkgutil
+pkts
 Pkts
 plainnat
 plantuml
 plist
+plt
 plugin
 png
 PNGs
@@ -476,6 +503,7 @@ popen
 posixpath
 PREDEF
 preds
+prm
 procs
 PROGRAMLISTING
 progressbar
@@ -490,8 +518,10 @@ ptr
 px
 py
 pyc
+pydantic
 pylint
 pypi
+pyplot
 pyserial
 pytest
 PYTHONHOME
@@ -512,6 +542,7 @@ RCE
 RCVHWM
 RCVTIMEO
 RDWR
+Readback
 readlines
 README
 readonly
@@ -544,6 +575,7 @@ rst
 rtd
 rtf
 saba
+savefig
 scm
 scrollable
 scrollbar
@@ -659,8 +691,8 @@ ttl
 tts
 twbs
 txz
-typedef'ed
 typedef
+typedef'ed
 typehints
 typeof
 tzinfo
@@ -676,6 +708,7 @@ UML
 undef
 undoc
 unicode
+UNINIT
 unittest
 unpause
 updown
@@ -685,7 +718,6 @@ uplinkvue
 uploader
 upto
 uri
-URI
 url
 usec
 useconds
@@ -717,6 +749,7 @@ vname
 VRuntime
 vue
 vw
+Watney
 wav
 webbrowser
 webified
@@ -740,14 +773,15 @@ xcode
 xhtml
 xhttp
 xl
+xlabel
 xls
 xlsx
+xmit
 xml
 xy
 yaml
+ylabel
 yml
 zeromq
 zlib
 zmq
-ZMQ
-Zmq

{fprime-gds-3.4.4a1 → fprime_gds-3.4.4a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fprime-gds
-Version: 3.4.4a1
+Version: 3.4.4a2
 Summary: F Prime Flight Software Ground Data System layer
 Author-email: Michael Starch <Michael.D.Starch@jpl.nasa.gov>, Thomas Boyer-Chammard <Thomas.Boyer.Chammard@jpl.nasa.gov>
 License: 
@@ -239,6 +239,7 @@ Requires-Dist: argcomplete>=1.12.3
 Requires-Dist: Jinja2>=2.11.3
 Requires-Dist: openpyxl>=3.0.10
 Requires-Dist: pyserial>=3.5
+Requires-Dist: pydantic>=2.6
 
 # F´ GDS
 
@@ -267,7 +268,7 @@ output data type included. Command data objects are created in the command panel
 the command encoder registered to that panel. Encoders take a data object and turn it into binary
 data that can be sent to the F´ deployment. The binary data is then passed to the TCP client
 which is registered to the encoder. Finally, the TCP client send the data back to the TCP server and
-the F´ deployment. ![The layout of the GDS](https://github.com/nasa/fprime/blob/master/docs/UsersGuide/media/gds_layout.jpg)
+the F´ deployment. ![The layout of the GDS](https://github.com/nasa/fprime/blob/devel/docs/UsersGuide/media/gds_layout.jpg)
 
 All of these objects are created and registered to other objects when the GDS
 is initialized. Thus, all of the structure of the GDS is created in one place,

{fprime-gds-3.4.4a1 → fprime_gds-3.4.4a2}/README.md

@@ -25,7 +25,7 @@ output data type included. Command data objects are created in the command panel
 the command encoder registered to that panel. Encoders take a data object and turn it into binary
 data that can be sent to the F´ deployment. The binary data is then passed to the TCP client
 which is registered to the encoder. Finally, the TCP client send the data back to the TCP server and
-the F´ deployment. ![The layout of the GDS](https://github.com/nasa/fprime/blob/master/docs/UsersGuide/media/gds_layout.jpg)
+the F´ deployment. ![The layout of the GDS](https://github.com/nasa/fprime/blob/devel/docs/UsersGuide/media/gds_layout.jpg)
 
 All of these objects are created and registered to other objects when the GDS
 is initialized. Thus, all of the structure of the GDS is created in one place,

{fprime-gds-3.4.4a1 → fprime_gds-3.4.4a2}/pyproject.toml

@@ -42,6 +42,7 @@ dependencies = [
     "Jinja2>=2.11.3",
     "openpyxl>=3.0.10",
     "pyserial>=3.5",
+    "pydantic>=2.6"
 ]
 
 [project.urls]
@@ -58,8 +59,7 @@ Repository = "https://github.com/fprime-community/fprime-gds"
 [project.scripts]
 fprime-cli = "fprime_gds.executables.fprime_cli:main"
 fprime-seqgen = "fprime_gds.common.tools.seqgen:main"
-
-[project.gui-scripts]
+fprime-dp-write = "fprime_gds.executables.data_product_writer:main"
 fprime-gds = "fprime_gds.executables.run_deployment:main"
 
 # For Pytest fixtures

{fprime-gds-3.4.4a1 → fprime_gds-3.4.4a2}/src/fprime_gds/common/data_types/event_data.py

@@ -44,7 +44,12 @@ class EventData(sys_data.SysData):
             self.display_text = event_temp.description
         elif event_temp.format_str == "":
             args_template = self.template.get_args()
-            self.display_text = str([{args_template[index][0]:arg.val} for index, arg in enumerate(event_args)])
+            self.display_text = str(
+                [
+                    {args_template[index][0]: arg.val}
+                    for index, arg in enumerate(event_args)
+                ]
+            )
         else:
             self.display_text = format_string_template(
                 event_temp.format_str, tuple([arg.val for arg in event_args])

{fprime-gds-3.4.4a1 → fprime_gds-3.4.4a2}/src/fprime_gds/common/data_types/exceptions.py

@@ -2,10 +2,25 @@
 Created on Jan 9, 2015
 @author: reder
 """
+
 # Exception classes for all controllers modules
 
 
-class GseControllerException(Exception):
+class FprimeGdsException(Exception):
+    """
+    Base Exception for exceptions that need to be handled at the system-level
+    by the GDS
+    """
+
+    pass
+
+
+class GdsDictionaryParsingException(FprimeGdsException):
+    pass
+
+
+# Note: Gse is the historical name for what is now called the GDS
+class GseControllerException(FprimeGdsException):
     def __init__(self, val):
         self.except_msg = val
         super().__init__(val)
@@ -27,13 +42,3 @@ class GseControllerUndefinedFileException(GseControllerException):
 class GseControllerParsingException(GseControllerException):
     def __init__(self, val):
         super().__init__(f"Parsing error: {str(val)}")
-
-
-class GseControllerMnemonicMismatchException(GseControllerException):
-    def __init__(self, val1, val2):
-        super().__init__(f"ID mismatch ({str(val1)}, {str(val2)})!")
-
-
-class GseControllerStatusUpdateException(GseControllerException):
-    def __init__(self, val):
-        super().__init__(f"Bad status update mode: {str(val)}!")

fprime_gds-3.4.4a2/src/fprime_gds/common/loaders/ch_json_loader.py

@@ -0,0 +1,107 @@
+"""
+ch_json_loader.py:
+
+Loads flight dictionary (JSON) and returns id and mnemonic based Python dictionaries of channels
+
+@author thomas-bc
+"""
+
+from fprime_gds.common.templates.ch_template import ChTemplate
+from fprime_gds.common.loaders.json_loader import JsonLoader
+from fprime_gds.common.data_types.exceptions import GdsDictionaryParsingException
+
+
+class ChJsonLoader(JsonLoader):
+    """Class to load python based telemetry channel dictionaries"""
+
+    CHANNELS_FIELD = "telemetryChannels"
+
+    ID = "id"
+    NAME = "name"
+    DESC = "annotation"
+    TYPE = "type"
+    FMT_STR = "format"
+    LIMIT_FIELD = "limit"
+    LIMIT_LOW = "low"
+    LIMIT_HIGH = "high"
+    LIMIT_RED = "red"
+    LIMIT_ORANGE = "orange"
+    LIMIT_YELLOW = "yellow"
+
+    def construct_dicts(self, _):
+        """
+        Constructs and returns python dictionaries keyed on id and name
+
+        Args:
+            _: Unused argument (inherited)
+        Returns:
+            A tuple with two channel dictionaries (python type dict):
+            (id_dict, name_dict). The keys should be the channels' id and
+            name fields respectively and the values should be ChTemplate
+            objects.
+        """
+        id_dict = {}
+        name_dict = {}
+
+        if self.CHANNELS_FIELD not in self.json_dict:
+            raise GdsDictionaryParsingException(
+                f"Ground Dictionary missing '{self.CHANNELS_FIELD}' field: {str(self.json_file)}"
+            )
+
+        for ch_dict in self.json_dict[self.CHANNELS_FIELD]:
+            # Create a channel template object
+            ch_temp = self.construct_template_from_dict(ch_dict)
+
+            id_dict[ch_temp.get_id()] = ch_temp
+            name_dict[ch_temp.get_full_name()] = ch_temp
+
+        return (
+            dict(sorted(id_dict.items())),
+            dict(sorted(name_dict.items())),
+            self.get_versions(),
+        )
+
+    def construct_template_from_dict(self, channel_dict: dict) -> ChTemplate:
+        try:
+            ch_id = channel_dict[self.ID]
+            # The below assignment also raises a ValueError if the name does not contain a '.'
+            component_name, channel_name = channel_dict[self.NAME].split(".")
+            if not component_name or not channel_name:
+                raise ValueError()
+
+            type_obj = self.parse_type(channel_dict[self.TYPE])
+        except ValueError as e:
+            raise GdsDictionaryParsingException(
+                f"Channel dictionary entry malformed, expected name of the form '<COMP_NAME>.<CH_NAME>' in : {str(channel_dict)}"
+            )
+        except KeyError as e:
+            raise GdsDictionaryParsingException(
+                f"{str(e)} key missing from Channel dictionary entry or its associated type in the dictionary: {str(channel_dict)}"
+            )
+
+        format_str = JsonLoader.preprocess_format_str(channel_dict.get(self.FMT_STR))
+
+        limit_field = channel_dict.get(self.LIMIT_FIELD)
+        limit_low = limit_field.get(self.LIMIT_LOW) if limit_field else None
+        limit_high = limit_field.get(self.LIMIT_HIGH) if limit_field else None
+        limit_low_yellow = limit_low.get(self.LIMIT_YELLOW) if limit_low else None
+        limit_low_red = limit_low.get(self.LIMIT_RED) if limit_low else None
+        limit_low_orange = limit_low.get(self.LIMIT_ORANGE) if limit_low else None
+        limit_high_yellow = limit_high.get(self.LIMIT_YELLOW) if limit_high else None
+        limit_high_red = limit_high.get(self.LIMIT_RED) if limit_high else None
+        limit_high_orange = limit_high.get(self.LIMIT_ORANGE) if limit_high else None
+
+        return ChTemplate(
+            ch_id,
+            channel_name,
+            component_name,
+            type_obj,
+            ch_fmt_str=format_str,
+            ch_desc=channel_dict.get(self.DESC),
+            low_red=limit_low_red,
+            low_orange=limit_low_orange,
+            low_yellow=limit_low_yellow,
+            high_yellow=limit_high_yellow,
+            high_orange=limit_high_orange,
+            high_red=limit_high_red,
+        )

{fprime-gds-3.4.4a1 → fprime_gds-3.4.4a2}/src/fprime_gds/common/loaders/ch_xml_loader.py

@@ -49,15 +49,15 @@ class ChXmlLoader(XmlLoader):
             respectively and the values are ChTemplate objects
         """
         xml_tree = self.get_xml_tree(path)
-        versions = xml_tree.attrib.get("framework_version", "unknown"), xml_tree.attrib.get("project_version", "unknown")
+        versions = xml_tree.attrib.get(
+            "framework_version", "unknown"
+        ), xml_tree.attrib.get("project_version", "unknown")
 
         # Check if xml dict has channels section
         ch_section = self.get_xml_section(self.CH_SECT, xml_tree)
         if ch_section is None:
             msg = f"Xml dict did not have a {self.CH_SECT} section"
-            raise exceptions.GseControllerParsingException(
-                msg
-            )
+            raise exceptions.GseControllerParsingException(msg)
 
         id_dict = {}
         name_dict = {}
@@ -84,7 +84,7 @@ class ChXmlLoader(XmlLoader):
                 ch_desc = ch_dict[self.DESC_TAG]
 
             if self.FMT_STR_TAG in ch_dict:
-                ch_fmt_str = ch_dict[self.FMT_STR_TAG]
+                ch_fmt_str = XmlLoader.preprocess_format_str(ch_dict[self.FMT_STR_TAG])
 
             # TODO we need to convert these into numbers, is this the best
             #  way to do it?

fprime_gds-3.4.4a2/src/fprime_gds/common/loaders/cmd_json_loader.py

@@ -0,0 +1,85 @@
+"""
+cmd_json_loader.py:
+
+Loads flight dictionary (JSON) and returns id and mnemonic based Python dictionaries of commands
+
+@author thomas-bc
+"""
+
+from fprime_gds.common.templates.cmd_template import CmdTemplate
+from fprime_gds.common.loaders.json_loader import JsonLoader
+from fprime_gds.common.data_types.exceptions import GdsDictionaryParsingException
+
+
+class CmdJsonLoader(JsonLoader):
+    """Class to load json based command dictionaries"""
+
+    COMMANDS_FIELD = "commands"
+
+    NAME = "name"
+    OPCODE = "opcode"
+    DESC = "annotation"
+    PARAMETERS = "formalParams"
+
+    def construct_dicts(self, _):
+        """
+         Constructs and returns python dictionaries keyed on id and name
+
+        Args:
+            _: Unused argument (inherited)
+         Returns:
+            A tuple with two command dictionaries (python type dict):
+            (id_dict, name_dict). The keys are the events' id and name fields
+            respectively and the values are CmdTemplate objects
+        """
+        id_dict = {}
+        name_dict = {}
+
+        if self.COMMANDS_FIELD not in self.json_dict:
+            raise GdsDictionaryParsingException(
+                f"Ground Dictionary missing '{self.COMMANDS_FIELD}' field: {str(self.json_file)}"
+            )
+
+        for cmd_dict in self.json_dict[self.COMMANDS_FIELD]:
+            cmd_temp = self.construct_template_from_dict(cmd_dict)
+
+            id_dict[cmd_temp.get_id()] = cmd_temp
+            name_dict[cmd_temp.get_full_name()] = cmd_temp
+
+        return (
+            dict(sorted(id_dict.items())),
+            dict(sorted(name_dict.items())),
+            self.get_versions(),
+        )
+
+    def construct_template_from_dict(self, cmd_dict: dict) -> CmdTemplate:
+        try:
+            cmd_comp, cmd_mnemonic = cmd_dict[self.NAME].split(".")
+            cmd_opcode = cmd_dict[self.OPCODE]
+            cmd_desc = cmd_dict.get(self.DESC)
+        except ValueError as e:
+            raise GdsDictionaryParsingException(
+                f"Command dictionary entry malformed, expected name of the form '<COMP_NAME>.<CMD_NAME>' in : {str(cmd_dict)}"
+            )
+        except KeyError as e:
+            raise GdsDictionaryParsingException(
+                f"{str(e)} key missing from Command dictionary entry: {str(cmd_dict)}"
+            )
+        # Parse Arguments
+        cmd_args = []
+        for param in cmd_dict.get(self.PARAMETERS, []):
+            try:
+                param_name = param["name"]
+                param_type = self.parse_type(param["type"])
+            except KeyError as e:
+                raise GdsDictionaryParsingException(
+                    f"{str(e)} key missing from Command parameter or its associated type in the dictionary: {str(param)}"
+                )
+            cmd_args.append(
+                (
+                    param_name,
+                    param.get("annotation"),
+                    param_type,
+                )
+            )
+        return CmdTemplate(cmd_opcode, cmd_mnemonic, cmd_comp, cmd_args, cmd_desc)

{fprime-gds-3.4.4a1 → fprime_gds-3.4.4a2}/src/fprime_gds/common/loaders/dict_loader.py

@@ -93,7 +93,7 @@ class DictLoader:
         return name_dict
 
     def get_versions(self):
-        """ Get version tuple """
+        """Get version tuple"""
         return self.versions
 
     def construct_dicts(self, path):