fprime-gds 3.4.3__tar.gz → 3.4.4a2__tar.gz

{fprime-gds-3.4.3 → 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,5 +47,3 @@ ignore$
 \.xlsx$
 \.xsd$
 \.ico$
-pyproject.toml
-setup.py

{fprime-gds-3.4.3 → 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,9 @@ hidecallergraph
 hidecallgraph
 hideinitializer
 hlp
+HLTH
+Hookimpl
+hookspec
 hostname
 hpaulson
 hpp
@@ -313,6 +334,7 @@ ints
 ip
 ipc
 ipp
+isabstract
 isalnum
 isclass
 isdir
@@ -357,6 +379,7 @@ libc
 libclang
 libcrc
 libiconv
+lineno
 Linting
 Linux
 listbox
@@ -381,6 +404,7 @@ MAKEVAR
 marijnh
 matchobj
 mathjax
+matplotlib
 maxcountryman
 maxdepth
 mcternan
@@ -409,6 +433,7 @@ myproject
 namespace
 nargs
 navbar
+nbytes
 Neue
 newname
 Nify
@@ -417,6 +442,7 @@ nitpicky
 noapp
 noqa
 normpath
+NOSONAR
 nosort
 Noto
 novalidate
@@ -430,6 +456,8 @@ odl
 odo
 oga
 ogg
+OKBLUE
+OKGREEN
 OMG
 onabort
 onerror
@@ -462,10 +490,12 @@ php
 phtml
 pid
 pkgutil
+pkts
 Pkts
 plainnat
 plantuml
 plist
+plt
 plugin
 png
 PNGs
@@ -473,6 +503,7 @@ popen
 posixpath
 PREDEF
 preds
+prm
 procs
 PROGRAMLISTING
 progressbar
@@ -487,8 +518,10 @@ ptr
 px
 py
 pyc
+pydantic
 pylint
 pypi
+pyplot
 pyserial
 pytest
 PYTHONHOME
@@ -509,6 +542,7 @@ RCE
 RCVHWM
 RCVTIMEO
 RDWR
+Readback
 readlines
 README
 readonly
@@ -541,6 +575,7 @@ rst
 rtd
 rtf
 saba
+savefig
 scm
 scrollable
 scrollbar
@@ -656,8 +691,8 @@ ttl
 tts
 twbs
 txz
-typedef'ed
 typedef
+typedef'ed
 typehints
 typeof
 tzinfo
@@ -673,6 +708,7 @@ UML
 undef
 undoc
 unicode
+UNINIT
 unittest
 unpause
 updown
@@ -682,7 +718,6 @@ uplinkvue
 uploader
 upto
 uri
-URI
 url
 usec
 useconds
@@ -714,6 +749,7 @@ vname
 VRuntime
 vue
 vw
+Watney
 wav
 webbrowser
 webified
@@ -737,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.3 → fprime_gds-3.4.4a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fprime-gds
-Version: 3.4.3
+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.3 → 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.3 → 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
@@ -85,3 +85,7 @@ fprime_test_api = "fprime_gds.common.testing_fw.pytest_integration"
 # - https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
 # - https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#src-layout
 ####
+[tool.pytest.ini_options]
+markers =[
+  "gds_cli"
+]

fprime_gds-3.4.4a2/src/fprime_gds/common/communication/adapters/base.py

@@ -0,0 +1,89 @@
+"""
+base.py:
+
+This file specifies the base-adapter for the F prime comm-layer. This class defines the basic methods needed to interact
+with various wire formats as they are supported by the F prime comm-layer. This file defines a single abstract base
+class representing the core features of the adapter class that must be implemented by every implementation of the
+adapter for use with the comm-layer.
+
+@author lestarch
+"""
+import abc
+from typing import Type
+from fprime_gds.plugin.definitions import gds_plugin_implementation, gds_plugin_specification
+
+
+class BaseAdapter(abc.ABC):
+    """
+    Base adapter for adapting the communications layer. This essentially breaks down to providing the ability to read
+    data from, and write to the necessary wire-format. The children of this class must at least implement the 'read' and
+    'write' functions to ensure that data can be read and written. 'open' and 'close' are also provided as a helper to
+    the subclass implementer to place resource initialization and release code, however; these implementations are
+    defaulted not overridden.
+    """
+
+    def open(self):
+        """Null default implementation"""
+
+    def close(self):
+        """Null default implementation"""
+
+    @abc.abstractmethod
+    def read(self, timeout=0.500):
+        """
+        Read from the interface. Must be overridden by the child adapter. Throw no fatal errors, reconnect instead. This
+        call is expected to block waiting on incoming data.
+
+        :param size: maximum size of data to read before breaking
+        :param timeout: timeout for the block, default: 0.500 (500ms) as blocking w/o timeout may be uninterruptible
+        :return: byte array of data, or b'' if no data was read
+        """
+
+    @abc.abstractmethod
+    def write(self, frame):
+        """
+        Write to the interface. Must be overridden by the child adapter. Throw no fatal errors, reconnect instead.
+
+        :param frame: framed data to uplink
+        :return: True if data sent through adapter, False otherwise
+        """
+
+    @classmethod
+    @gds_plugin_specification
+    def register_communication_plugin(cls) -> Type["BaseAdapter"]:
+        """Register a communications adapter
+
+        Plugin hook for registering a plugin that supplies an adapter to the communications interface (radio, uart, i2c,
+        etc). This interface is expected to read and write bytes from a wire and will be provided to the framing system.
+
+        Note: users should return the class, not an instance of the class. Needed arguments for instantiation are
+        determined from class methods, solicited via the command line, and provided at construction time to the chosen
+        instantiation.
+
+        Returns:
+            BaseAdapter subclass
+        """
+        raise NotImplementedError()
+
+
+class NoneAdapter(BaseAdapter):
+    """ None adapter used to turn off the comm script """
+
+    @classmethod
+    def get_name(cls):
+        """ Get name of the non-adapter """
+        return "none"
+
+    def read(self, timeout=0.500):
+        """ Raise exception if this is called"""
+        raise NotImplementedError()
+
+    def write(self, frame):
+        """ Raise exception if this is called"""
+        raise NotImplementedError()
+
+    @classmethod
+    @gds_plugin_implementation
+    def register_communication_plugin(cls):
+        """ Register this as a plugin """
+        return cls

{fprime-gds-3.4.3 → fprime_gds-3.4.4a2}/src/fprime_gds/common/communication/adapters/ip.py

@@ -18,6 +18,8 @@ import time
 import fprime_gds.common.communication.adapters.base
 import fprime_gds.common.logger
 
+from fprime_gds.plugin.definitions import gds_plugin_implementation
+
 LOGGER = logging.getLogger("ip_adapter")
 
 
@@ -114,7 +116,7 @@ class IpAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
 
     def write(self, frame):
         """
-        Send a given framed bit of data by sending it out the serial interface. It will attempt to reconnect if there is
+        Send a given framed bit of data by sending it out the serial interface. It will attempt to reconnect if there
         was a problem previously. This function will return true on success, or false on error.
 
         :param frame: framed data packet to send out
@@ -151,6 +153,11 @@ class IpAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
             self.write(IpAdapter.KEEPALIVE_DATA)
             time.sleep(interval)
 
+    @classmethod
+    def get_name(cls):
+        """ Get the name of this adapter  """
+        return "ip"
+
     @classmethod
     def get_arguments(cls):
         """
@@ -163,13 +170,13 @@ class IpAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
                 "dest": "address",
                 "type": str,
                 "default": "0.0.0.0",
-                "help": "Address of the IP adapter server. Default: %(default)s",
+                "help": "Address of the IP adapter server.",
             },
             ("--ip-port",): {
                 "dest": "port",
                 "type": int,
                 "default": 50000,
-                "help": "Port of the IP adapter server. Default: %(default)s",
+                "help": "Port of the IP adapter server.",
             },
             ("--ip-client",): {
                 # dest is "server" since it is handled in BaseAdapter.construct_adapter and passed with the same
@@ -182,14 +189,25 @@ class IpAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
         }
 
     @classmethod
-    def check_arguments(cls, args):
+    @gds_plugin_implementation
+    def register_communication_plugin(cls):
+        """ Register this as a communication plugin """
+        return cls
+
+    @classmethod
+    def check_arguments(cls, address, port, server=True):
         """
         Code that should check arguments of this adapter. If there is a problem with this code, then a "ValueError"
         should be raised describing the problem with these arguments.
 
         :param args: arguments as dictionary
         """
-        check_port(args["address"], args["port"])
+        try:
+            if server:
+                check_port(address, port)
+        except OSError as os_error:
+            raise ValueError(f"{os_error}")
+
 
 
 class IpHandler(abc.ABC):

{fprime-gds-3.4.3 → fprime_gds-3.4.4a2}/src/fprime_gds/common/communication/adapters/uart.py

@@ -15,6 +15,8 @@ from serial.tools import list_ports
 
 import fprime_gds.common.communication.adapters.base
 
+from fprime_gds.plugin.definitions import gds_plugin_implementation
+
 LOGGER = logging.getLogger("serial_adapter")
 
 
@@ -151,18 +153,29 @@ class SerialAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
                 "dest": "device",
                 "type": str,
                 "default": default,
-                "help": "UART device representing the FSW. Default: %(default)s",
+                "help": "UART device representing the FSW.",
             },
             ("--uart-baud",): {
                 "dest": "baud",
                 "type": int,
                 "default": 9600,
-                "help": "Baud rate of the serial device. Default: %(default)s",
+                "help": "Baud rate of the serial device.",
             },
         }
 
     @classmethod
-    def check_arguments(cls, args):
+    def get_name(cls):
+        """ Get name of the adapter """
+        return "uart"
+
+    @classmethod
+    @gds_plugin_implementation
+    def register_communication_plugin(cls):
+        """ Register this as a communication plugin """
+        return cls
+
+    @classmethod
+    def check_arguments(cls, device, baud):
         """
         Code that should check arguments of this adapter. If there is a problem with this code, then a "ValueError"
         should be raised describing the problem with these arguments.
@@ -170,16 +183,16 @@ class SerialAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
         :param args: arguments as dictionary
         """
         ports = map(lambda info: info.device, list_ports.comports(include_links=True))
-        if args["device"] not in ports:
-            msg = f"Serial port '{args['device']}' not valid. Available ports: {ports}"
+        if device not in ports:
+            msg = f"Serial port '{device}' not valid. Available ports: {ports}"
             raise ValueError(
                 msg
             )
         # Note: baud rate may not *always* work. These are a superset
         try:
-            baud = int(args["baud"])
+            baud = int(baud)
         except ValueError:
-            msg = f"Serial baud rate '{args['baud']}' not integer. Use one of: {SerialAdapter.BAUDS}"
+            msg = f"Serial baud rate '{baud}' not integer. Use one of: {SerialAdapter.BAUDS}"
             raise ValueError(
                 msg
             )

{fprime-gds-3.4.3 → fprime_gds-3.4.4a2}/src/fprime_gds/common/communication/checksum.py

@@ -11,7 +11,6 @@ def crc_calculation(data: bytes):
     return zlib.crc32(data) & 0xFFFFFFFF
 
 
-CHECKSUM_SELECTION = "crc32"
 CHECKSUM_MAPPING = {
     "fixed": lambda data: 0xCAFECAFE,
     "crc32": crc_calculation,
@@ -19,8 +18,7 @@ CHECKSUM_MAPPING = {
 }
 
 
-def calculate_checksum(data: bytes):
+def calculate_checksum(data: bytes, selected_checksum: str):
     """Calculates the checksum of bytes"""
-    selected_checksum = CHECKSUM_SELECTION
     hash_fn = CHECKSUM_MAPPING.get(selected_checksum, CHECKSUM_MAPPING.get("default"))
     return hash_fn(data)

{fprime-gds-3.4.3 → fprime_gds-3.4.4a2}/src/fprime_gds/common/communication/framing.py

@@ -15,8 +15,10 @@ import abc
 import copy
 import struct
 import sys
+from typing import Type
 
-from .checksum import calculate_checksum
+from .checksum import calculate_checksum, CHECKSUM_MAPPING
+from fprime_gds.plugin.definitions import gds_plugin_implementation, gds_plugin_specification
 
 
 class FramerDeframer(abc.ABC):
@@ -70,6 +72,24 @@ class FramerDeframer(abc.ABC):
                 return packets, data, discarded_aggregate
             packets.append(packet)
 
+    @classmethod
+    @gds_plugin_specification
+    def register_framing_plugin(cls) -> Type["FramerDeframer"]:
+        """Register a plugin to provide framing capabilities
+
+        Plugin hook for registering a plugin that supplies a FramerDeframer implementation. Implementors of this hook must
+        return a non-abstract subclass of FramerDeframer. This class will be provided as a framing implementation option
+        that users may select via command line arguments.
+
+        Note: users should return the class, not an instance of the class. Needed arguments for instantiation are
+        determined from class methods, solicited via the command line, and provided at construction time to the chosen
+        instantiation.
+
+        Returns:
+            FramerDeframer subclass
+        """
+        raise NotImplementedError()
+
 
 class FpFramerDeframer(FramerDeframer):
     """
@@ -97,10 +117,11 @@ class FpFramerDeframer(FramerDeframer):
     HEADER_FORMAT = None
     START_TOKEN = None
 
-    def __init__(self):
+    def __init__(self, checksum_type):
         """Sets constants on construction."""
         # Setup the constants as soon as possible.
         FpFramerDeframer.set_constants()
+        self.checksum = checksum_type
 
     @classmethod
     def set_constants(cls):
@@ -134,7 +155,7 @@ class FpFramerDeframer(FramerDeframer):
             FpFramerDeframer.HEADER_FORMAT, FpFramerDeframer.START_TOKEN, len(data)
         )
         framed += data
-        framed += struct.pack(">I", calculate_checksum(framed))
+        framed += struct.pack(">I", calculate_checksum(framed, self.checksum))
         return framed
 
     def deframe(self, data, no_copy=False):
@@ -176,7 +197,8 @@ class FpFramerDeframer(FramerDeframer):
                 )
                 # If the checksum is valid, return the packet. Otherwise continue to rotate
                 if check == calculate_checksum(
-                    data[: data_size + FpFramerDeframer.HEADER_SIZE]
+                    data[: data_size + FpFramerDeframer.HEADER_SIZE],
+                    self.checksum
                 ):
                     data = data[total_size:]
                     return deframed, data, discarded
@@ -192,6 +214,33 @@ class FpFramerDeframer(FramerDeframer):
             return None, data, discarded
         return None, data, discarded
 
+    @classmethod
+    def get_name(cls):
+        """ Get the name of this plugin """
+        return "fprime"
+
+    @classmethod
+    def get_arguments(cls):
+        """ Get arguments for the framer/deframer """
+        return {("--comm-checksum-type",): {
+            "dest": "checksum_type",
+            "action": "store",
+            "type": str,
+            "help": "Setup the checksum algorithm. [default: %(default)s]",
+            "choices": [
+                item
+                for item in CHECKSUM_MAPPING.keys()
+                if item != "default"
+            ],
+            "default": "crc32",
+        }}
+
+    @classmethod
+    @gds_plugin_implementation
+    def register_framing_plugin(cls):
+        """ Register a bad plugin """
+        return cls
+
 
 class TcpServerFramerDeframer(FramerDeframer):
     """

{fprime-gds-3.4.3 → 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])