fprime-gds 3.6.2a1__tar.gz → 4.0.0a2__tar.gz

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/.github/actions/spelling/expect.txt

@@ -23,6 +23,7 @@ autosectionlabel
 backface
 batchmode
 baudrate
+BBBBBHI
 bcolors
 BGR
 Biberstein
@@ -31,6 +32,7 @@ bitmaps
 breadcrumb
 Btns
 BUGLIST
+calcsize
 calibri
 callergraph
 callgraph
@@ -49,6 +51,7 @@ classdocs
 clearfix
 cls
 cmdhist
+cmt
 CODEFILE
 COLORSTYLE
 colorwheel
@@ -59,10 +62,12 @@ configs
 Consolas
 creatingdocsetswithdoxygen
 csum
+ctx
 curateable
 curated
 curating
 customise
+cuz
 daringfireball
 dataobjects
 dblclick
@@ -136,9 +141,13 @@ FONTSIZE
 fpp
 fprime
 fptable
+fpy
+fpybc
+fqn
 fsw
 gdiplus
 getbootstrap
+getoption
 github
 grayscales
 gse
@@ -161,6 +170,7 @@ htags
 hyperlinks
 idct
 idl
+idx
 ieeetr
 ified
 ifun
@@ -171,18 +181,22 @@ intlimits
 ip
 ipc
 ipp
+issuecomment
 itcl
 ixx
 janamian
+jawest
 Jdk
 jpl
 JSO
 jsonable
 jsonified
 jsonify
+junitxml
 keepalive
 keyify
 kinda
+leisher
 lestarch
 levelname
 Lezer
@@ -195,6 +209,7 @@ logdir
 logpath
 logselect
 luxon
+LVAR
 makeindex
 MAKEVAR
 marijnh
@@ -235,9 +250,11 @@ oring
 osexc
 OSX
 outputfile
+Packetize
 packetized
 Paetz
 PARAMDOC
+paramdb
 passthrough
 pb
 pdflatex
@@ -248,6 +265,7 @@ plantuml
 PNGs
 preds
 prm
+prmdb
 procs
 PROGRAMLISTING
 projectbrief
@@ -305,6 +323,7 @@ sss
 Ssymbols
 stackoverflow
 startuml
+subcmd
 subgrouping
 subhist
 subhistory
@@ -322,6 +341,7 @@ Theif
 thtcp
 thudp
 timebase
+timectx
 timescales
 timespan
 timestep
@@ -375,6 +395,8 @@ xapian
 xhttp
 xl
 xmit
+xmlpath
 xy
 zeromq
 zmq
+zimri

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/.github/workflows/fprime-gds-tests.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - uses: actions/checkout@v4

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/.github/workflows/gds-cli-tests.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
 

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: fprime-gds
-Version: 3.6.2a1
+Version: 4.0.0a2
 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: 
@@ -240,10 +240,12 @@ Requires-Dist: Jinja2>=2.11.3
 Requires-Dist: openpyxl>=3.0.10
 Requires-Dist: pyserial>=3.5
 Requires-Dist: pydantic>=2.6
+Requires-Dist: PyYAML>=6.0.2
+Dynamic: license-file
 
 # F´ GDS
 
-**Note:** This README describes GDS internals. Refer to the [user's guide](https://nasa.github.io/fprime/UsersGuide/gds/gds-introduction.html) for instructions on how to use the GDS.
+**Note:** This README describes GDS internals. Refer to the [F´ Documentation](https://fprime.jpl.nasa.gov/latest/docs/user-manual/overview/gds-introduction/) for instructions on how to use the GDS.
 
 Issues should be reported here: [File an issue](https://github.com/nasa/fprime/issues/new/choose)
 
@@ -268,7 +270,8 @@ 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/devel/docs/UsersGuide/media/gds_layout.jpg)
+the F´ deployment.  
+![The layout of the GDS](https://raw.githubusercontent.com/nasa/fprime/refs/heads/devel/docs/img/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,
@@ -285,15 +288,11 @@ commands and registering consumers to the GDS decoders. The Standard Pipeline ca
 [here](src/fprime_gds/common/pipeline/standard.py).
 
 ### GDS Integration Test API
-The Integration Test API is a tool that provides the ability to write integration-level tests for an
-F´ deployment using the GDS. The tool provides history searches/asserts, command sending, a
-detailed test log, sub-histories and convenient access to GDS data objects. The test API comes with
-separate [documentation](https://github.com/nasa/fprime/blob/master/docs/UsersGuide/dev/testAPI/markdown/contents.md) and its own [user
-guide](https://github.com/nasa/fprime/blob/master/docs/UsersGuide/dev/testAPI/user_guide.md) and is built on top of the Standard Pipeline.
+The Integration Test API is a tool that provides the ability to write integration-level tests for an F´ deployment using the GDS. The tool provides history searches/asserts, command sending, a detailed test log, sub-histories and convenient access to GDS data objects. The test API comes with its own [user guide](https://fprime.jpl.nasa.gov/latest/docs/user-manual/gds/gds-test-api-guide/) and is built on top of the Standard Pipeline.
 
 ## GDS GUI Usage
 
-A guide for how to use the GDS is available in the [fprime documentation](https://nasa.github.io/fprime/UsersGuide/gds/gds-introduction.html)
+A guide for how to use the GDS is available in the [F Prime documentation](https://fprime.jpl.nasa.gov/latest/docs/user-manual/overview/gds-introduction)
 
 ## Classes
 The GDS back end is composed of several different data processing units. For 
@@ -316,8 +315,15 @@ that descriptor. Descriptor types include events, channels, packets, etc (a full
 enumeration can be found in (src/utils/data_desc_type.py). The binary data that 
 the descriptor receives should be of the form:
 
-| Length (4 bytes) | Type Descriptor (4 bytes) | Message Data |
-| ---------------- | ------------------------- | ------------ |
+```mermaid
+---
+title: "Binary format received by Distributors"
+---
+packet-beta
+  0-31: "Length [4 bytes]"
+  32-63: "Type Descriptor [4 bytes]"
+  64-95: "Message Data [variable length]"
+```
 
 The distributor should then pass only the message data along to the decoders. 
 
@@ -433,10 +439,3 @@ pip install doxypypy
 
 Next, make `docs/py_filter` available in your system path however you see fit.
 Now you can run `doxygen Doxyfile` in the root directory to generate documentation in `docs/doxy/index.html`
-
-## Notes
- - Currently, the models/common directory has command.py, event.py, and
-   channel.py. These files must be present in order for the python dictionaries
-   to be properly imported. However, they are empty and not used in the GDS. 
-   When we switch fully to XML dictionaries, these can go away. 
-

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/README.md

@@ -1,6 +1,6 @@
 # F´ GDS
 
-**Note:** This README describes GDS internals. Refer to the [user's guide](https://nasa.github.io/fprime/UsersGuide/gds/gds-introduction.html) for instructions on how to use the GDS.
+**Note:** This README describes GDS internals. Refer to the [F´ Documentation](https://fprime.jpl.nasa.gov/latest/docs/user-manual/overview/gds-introduction/) for instructions on how to use the GDS.
 
 Issues should be reported here: [File an issue](https://github.com/nasa/fprime/issues/new/choose)
 
@@ -25,7 +25,8 @@ 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/devel/docs/UsersGuide/media/gds_layout.jpg)
+the F´ deployment.  
+![The layout of the GDS](https://raw.githubusercontent.com/nasa/fprime/refs/heads/devel/docs/img/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,
@@ -42,15 +43,11 @@ commands and registering consumers to the GDS decoders. The Standard Pipeline ca
 [here](src/fprime_gds/common/pipeline/standard.py).
 
 ### GDS Integration Test API
-The Integration Test API is a tool that provides the ability to write integration-level tests for an
-F´ deployment using the GDS. The tool provides history searches/asserts, command sending, a
-detailed test log, sub-histories and convenient access to GDS data objects. The test API comes with
-separate [documentation](https://github.com/nasa/fprime/blob/master/docs/UsersGuide/dev/testAPI/markdown/contents.md) and its own [user
-guide](https://github.com/nasa/fprime/blob/master/docs/UsersGuide/dev/testAPI/user_guide.md) and is built on top of the Standard Pipeline.
+The Integration Test API is a tool that provides the ability to write integration-level tests for an F´ deployment using the GDS. The tool provides history searches/asserts, command sending, a detailed test log, sub-histories and convenient access to GDS data objects. The test API comes with its own [user guide](https://fprime.jpl.nasa.gov/latest/docs/user-manual/gds/gds-test-api-guide/) and is built on top of the Standard Pipeline.
 
 ## GDS GUI Usage
 
-A guide for how to use the GDS is available in the [fprime documentation](https://nasa.github.io/fprime/UsersGuide/gds/gds-introduction.html)
+A guide for how to use the GDS is available in the [F Prime documentation](https://fprime.jpl.nasa.gov/latest/docs/user-manual/overview/gds-introduction)
 
 ## Classes
 The GDS back end is composed of several different data processing units. For 
@@ -73,8 +70,15 @@ that descriptor. Descriptor types include events, channels, packets, etc (a full
 enumeration can be found in (src/utils/data_desc_type.py). The binary data that 
 the descriptor receives should be of the form:
 
-| Length (4 bytes) | Type Descriptor (4 bytes) | Message Data |
-| ---------------- | ------------------------- | ------------ |
+```mermaid
+---
+title: "Binary format received by Distributors"
+---
+packet-beta
+  0-31: "Length [4 bytes]"
+  32-63: "Type Descriptor [4 bytes]"
+  64-95: "Message Data [variable length]"
+```
 
 The distributor should then pass only the message data along to the decoders. 
 
@@ -190,10 +194,3 @@ pip install doxypypy
 
 Next, make `docs/py_filter` available in your system path however you see fit.
 Now you can run `doxygen Doxyfile` in the root directory to generate documentation in `docs/doxy/index.html`
-
-## Notes
- - Currently, the models/common directory has command.py, event.py, and
-   channel.py. These files must be present in order for the python dictionaries
-   to be properly imported. However, they are empty and not used in the GDS. 
-   When we switch fully to XML dictionaries, these can go away. 
-

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/pyproject.toml

@@ -42,7 +42,8 @@ dependencies = [
     "Jinja2>=2.11.3",
     "openpyxl>=3.0.10",
     "pyserial>=3.5",
-    "pydantic>=2.6"
+    "pydantic>=2.6",
+    "PyYAML>=6.0.2"
 ]
 
 [project.urls]
@@ -61,6 +62,8 @@ fprime-cli = "fprime_gds.executables.fprime_cli:main"
 fprime-seqgen = "fprime_gds.common.tools.seqgen:main"
 fprime-dp-write = "fprime_gds.executables.data_product_writer:main"
 fprime-gds = "fprime_gds.executables.run_deployment:main"
+fprime-prm-write = "fprime_gds.common.tools.params:main"
+fprime-fpy-bytecode = "fprime_gds.common.fpy.serialize_bytecode:main"
 
 # For Pytest fixtures
 [project.entry-points."pytest11"]

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/src/fprime_gds/common/communication/adapters/uart.py

@@ -59,7 +59,7 @@ class SerialAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
         4000000,
     ]
 
-    def __init__(self, device, baud):
+    def __init__(self, device, baud, skip_check):
         """
         Initialize the serial adapter using the default settings. This does not open the serial port, but sets up all
         the internal variables used when opening the device.
@@ -77,9 +77,14 @@ class SerialAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
         Opens the serial port based on previously supplied settings. If the port is already open, then close it first.
         Then open the port up again.
         """
-        self.close()
-        self.serial = serial.Serial(self.device, self.baud)
-        return self.serial is not None
+        try:
+            self.close()
+            self.serial = serial.Serial(self.device, self.baud)
+            return self.serial is not None
+        except serial.serialutil.SerialException as exc:
+            LOGGER.warning("Serial exception caught: %s. Reconnecting.", (str(exc)))
+            self.close()
+            return False
 
     def close(self):
         """
@@ -100,12 +105,11 @@ class SerialAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
         :return: True, when data was sent through the UART. False otherwise.
         """
         try:
-            if self.serial is None:
-                self.open()
-            written = self.serial.write(frame)
-            # Not believed to be possible to not send everything without getting a timeout exception
-            assert written == len(frame)
-            return True
+            if self.serial is not None or self.open():
+                written = self.serial.write(frame)
+                # Not believed to be possible to not send everything without getting a timeout exception
+                assert written == len(frame)
+                return True
         except serial.serialutil.SerialException as exc:
             LOGGER.warning("Serial exception caught: %s. Reconnecting.", (str(exc)))
             self.close()
@@ -121,17 +125,16 @@ class SerialAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
         """
         data = b""
         try:
-            if self.serial is None:
-                self.open()
-            # Read as much data as possible, while ensuring to block if no data is available at this time. Note: as much
-            # data is read as possible to avoid a long-return time to this call. Minimum data to read is one byte in
-            # order to block this function while data is incoming.
-            self.serial.timeout = timeout
-            data = self.serial.read(1)  # Force a block for at least 1 character
-            while self.serial.in_waiting:
-                data += self.serial.read(
-                    self.serial.in_waiting
-                )  # Drain the incoming data queue
+            if self.serial is not None or self.open():                
+                # Read as much data as possible, while ensuring to block if no data is available at this time. Note: as much
+                # data is read as possible to avoid a long-return time to this call. Minimum data to read is one byte in
+                # order to block this function while data is incoming.
+                self.serial.timeout = timeout
+                data = self.serial.read(1)  # Force a block for at least 1 character
+                while self.serial.in_waiting:
+                    data += self.serial.read(
+                        self.serial.in_waiting
+                    )  # Drain the incoming data queue
         except serial.serialutil.SerialException as exc:
             LOGGER.warning("Serial exception caught: %s. Reconnecting.", (str(exc)))
             self.close()
@@ -161,6 +164,12 @@ class SerialAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
                 "default": 9600,
                 "help": "Baud rate of the serial device.",
             },
+            ("--uart-skip-port-check",): {
+                "dest": "skip_check",
+                "default": False,
+                "action": "store_true",
+                "help": "Skip checking that the port exists"
+            }
         }
 
     @classmethod
@@ -175,20 +184,20 @@ class SerialAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
         return cls
 
     @classmethod
-    def check_arguments(cls, device, baud):
+    def check_arguments(cls, device, baud, skip_check):
         """
         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
         """
-        ports = map(lambda info: info.device, list_ports.comports(include_links=True))
-        if device not in ports:
+        ports = list(map(lambda info: info.device, list_ports.comports(include_links=True)))
+        if not skip_check and 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
+        # Note: baud rate may not *always* work. These are a superset.
         try:
             baud = int(baud)
         except ValueError:

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/src/fprime_gds/common/decoders/ch_decoder.py

@@ -44,7 +44,7 @@ class ChDecoder(Decoder):
             config = config_manager.ConfigManager().get_instance()
 
         self.__dict = ch_dict
-        self.id_obj = config.get_type("ch_id")
+        self.id_obj = config.get_type("FwChanIdType")
 
     def decode_api(self, data):
         """

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/src/fprime_gds/common/decoders/event_decoder.py

@@ -19,6 +19,7 @@ from fprime.common.models.serialize.type_exceptions import TypeException
 
 from fprime_gds.common.data_types import event_data
 from fprime_gds.common.decoders import decoder
+from fprime_gds.common.decoders.decoder import DecodingException
 from fprime_gds.common.utils import config_manager
 
 
@@ -43,7 +44,7 @@ class EventDecoder(decoder.Decoder):
             config = config_manager.ConfigManager().get_instance()
 
         self.__dict = event_dict
-        self.id_obj = config.get_type("event_id")
+        self.id_obj = config.get_type("FwEventIdType")
 
     def decode_api(self, data):
         """

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/src/fprime_gds/common/decoders/pkt_decoder.py

@@ -45,7 +45,7 @@ class PktDecoder(ChDecoder):
         super().__init__(ch_dict, config)
 
         self.__dict = pkt_name_dict
-        self.id_obj = config.get_type("pkt_id")
+        self.id_obj = config.get_type("FwTlmPacketizeIdType")
 
     def decode_api(self, data):
         """

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/src/fprime_gds/common/distributor/distributor.py

@@ -57,7 +57,7 @@ class Distributor(DataHandler):
             self.key_frame = int(config.get("framing", "key_val"), 16)
         self.key_obj = config.get_type("key_val")
         self.len_obj = config.get_type("msg_len")
-        self.desc_obj = config.get_type("msg_desc")
+        self.desc_obj = config.get_type("FwPacketDescriptorType")
 
     # NOTE we could use either the type of the object or an enum as the type argument.
     # It should indicate what the decoder decodes.
@@ -204,4 +204,4 @@ class Distributor(DataHandler):
                 try:
                     d.data_callback(msg)
                 except DecodingException as dexc:
-                    LOGGER.warning("Decoding error occurred: %s. Skipping.", dexc)
+                    LOGGER.warning("Decoding error occurred: %s. Skipping.", dexc)

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/src/fprime_gds/common/encoders/ch_encoder.py

@@ -57,8 +57,8 @@ class ChEncoder(Encoder):
         super().__init__(config)
 
         self.len_obj = self.config.get_type("msg_len")
-        self.desc_obj = self.config.get_type("msg_desc")
-        self.id_obj = self.config.get_type("ch_id")
+        self.desc_obj = self.config.get_type("FwPacketDescriptorType")
+        self.id_obj = self.config.get_type("FwChanIdType")
 
     def encode_api(self, data):
         """

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/src/fprime_gds/common/encoders/cmd_encoder.py

@@ -72,8 +72,8 @@ class CmdEncoder(encoder.Encoder):
         super().__init__(config)
 
         self.len_obj = self.config.get_type("msg_len")
-        self.desc_obj = self.config.get_type("msg_desc")
-        self.opcode_obj = self.config.get_type("op_code")
+        self.desc_obj = self.config.get_type("FwPacketDescriptorType")
+        self.opcode_obj = self.config.get_type("FwOpcodeType")
 
     def encode_api(self, data):
         """

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/src/fprime_gds/common/encoders/event_encoder.py

@@ -61,8 +61,8 @@ class EventEncoder(Encoder):
         super().__init__(config)
 
         self.len_obj = self.config.get_type("msg_len")
-        self.desc_obj = self.config.get_type("msg_desc")
-        self.id_obj = self.config.get_type("event_id")
+        self.desc_obj = self.config.get_type("FwPacketDescriptorType")
+        self.id_obj = self.config.get_type("FwEventIdType")
 
     def encode_api(self, data):
         """

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/src/fprime_gds/common/encoders/pkt_encoder.py

@@ -61,8 +61,8 @@ class PktEncoder(Encoder):
         super().__init__(config)
 
         self.len_obj = self.config.get_type("msg_len")
-        self.desc_obj = self.config.get_type("msg_desc")
-        self.id_obj = self.config.get_type("pkt_id")
+        self.desc_obj = self.config.get_type("FwPacketDescriptorType")
+        self.id_obj = self.config.get_type("FwTlmPacketizeIdType")
 
     def encode_api(self, data):
         """

{fprime_gds-3.6.2a1 → fprime_gds-4.0.0a2}/src/fprime_gds/common/encoders/seq_writer.py

@@ -28,8 +28,8 @@ class SeqBinaryWriter:
 
         self.__fd = None
         self.__timebase = timebase
-        self.desc_obj = config.get_type("msg_desc")
-        self.opcode_obj = config.get_type("op_code")
+        self.desc_obj = config.get_type("FwPacketDescriptorType")
+        self.opcode_obj = config.get_type("FwOpcodeType")
         self.len_obj = config.get_type("msg_len")
 
     def open(self, filename):