fprime-gds 3.6.1__tar.gz → 4.0.0__tar.gz

{fprime_gds-3.6.1 → fprime_gds-4.0.0}/.github/actions/spelling/expect.txt

@@ -23,6 +23,7 @@ autosectionlabel
 backface
 batchmode
 baudrate
+BBBBBHI
 bcolors
 BGR
 Biberstein
@@ -31,25 +32,32 @@ bitmaps
 breadcrumb
 Btns
 BUGLIST
+calcsize
 calibri
 callergraph
 callgraph
 cata
 CCB
 CCFF
+ccsds
+Cdh
 Cdioux
 cdn
 cdxoefg
 CFDG
 CFDP
 CFPD
+chans
 chartjs
 CHNG
 classdocs
 clearfix
 cls
 cmdhist
+cmps
+cmt
 CODEFILE
+codegen
 COLORSTYLE
 colorwheel
 columnify
@@ -59,10 +67,12 @@ configs
 Consolas
 creatingdocsetswithdoxygen
 csum
+ctx
 curateable
 curated
 curating
 customise
+cuz
 daringfireball
 dataobjects
 dblclick
@@ -74,7 +84,7 @@ deframed
 deframer
 deframing
 DEPRECATEDLIST
-DESER
+deser
 Deserial
 deserializes
 dests
@@ -111,6 +121,7 @@ ECONNRESET
 ect
 EEXIST
 Efg
+elifs
 ENDC
 endcond
 errorhandler
@@ -125,20 +136,33 @@ fastentrypoints
 fbuild
 fd
 FEEDNAME
+FEQ
 FFCC
 FFFF
+FGE
+FGT
 fileurl
 Firefox
+FLE
 focusring
+FNE
 FONTNAME
 FONTPATH
 FONTSIZE
+FPEXT
 fpp
 fprime
 fptable
+FPTOSI
+FPTOUI
+FPTRUNC
+fpy
+fpybc
+fqn
 fsw
 gdiplus
 getbootstrap
+getoption
 github
 grayscales
 gse
@@ -160,29 +184,38 @@ hpaulson
 htags
 hyperlinks
 idct
+idk
 idl
+idx
 ieeetr
+IEQ
 ified
 ifun
 IH
+INE
 inprogress
 intersphinx
 intlimits
 ip
 ipc
 ipp
+issuecomment
 itcl
 ixx
 janamian
+jawest
 Jdk
 jpl
 JSO
 jsonable
 jsonified
 jsonify
+junitxml
 keepalive
 keyify
 kinda
+lalr
+leisher
 lestarch
 levelname
 Lezer
@@ -195,6 +228,7 @@ logdir
 logpath
 logselect
 luxon
+LVAR
 makeindex
 MAKEVAR
 marijnh
@@ -224,6 +258,7 @@ NOSONAR
 nosort
 nosubgrouping
 Noto
+nreg
 NSPACES
 nuntil
 odl
@@ -235,9 +270,11 @@ oring
 osexc
 OSX
 outputfile
+Packetize
 packetized
 Paetz
 PARAMDOC
+paramdb
 passthrough
 pb
 pdflatex
@@ -246,8 +283,10 @@ pkts
 plainnat
 plantuml
 PNGs
+postlex
 preds
 prm
+prmdb
 procs
 PROGRAMLISTING
 projectbrief
@@ -285,6 +324,7 @@ rollup
 rpaetz
 rst
 saba
+scid
 sdd
 searchdata
 Segoe
@@ -292,19 +332,27 @@ seqfile
 seqgen
 serializables
 serialutil
+SGE
+SGT
 showinitializer
 sideeffect
 SIGALRM
+SITOFP
 sizeb
 SMAP
 Smath
+smth
 SNDHWM
 sorttable
+spacepacket
 squashify
+sreg
 sss
 Ssymbols
 stackoverflow
 startuml
+subclasscheck
+subcmd
 subgrouping
 subhist
 subhistory
@@ -322,6 +370,7 @@ Theif
 thtcp
 thudp
 timebase
+timectx
 timescales
 timespan
 timestep
@@ -344,7 +393,9 @@ typedef
 uart
 ucf
 udp
+UGE
 UIs
+UITOFP
 uk
 ul
 UNINIT
@@ -356,6 +407,8 @@ usec
 useconds
 usepackage
 usr
+vcid
+VCP
 vh
 vhd
 vhdl
@@ -375,6 +428,8 @@ xapian
 xhttp
 xl
 xmit
+xmlpath
 xy
 zeromq
 zmq
+zimri

{fprime_gds-3.6.1 → fprime_gds-4.0.0}/.github/actions/spelling/patterns.txt

@@ -44,3 +44,6 @@ value="(?:[0-9a-f]{1,2} )*"
 
 # Ignore any text between inline back-ticks
 `(.*?)`
+
+# Python struct packing patterns
+["\']([<>])[xcbB?hHiIlLqQnNefdspP]+["\']

{fprime_gds-3.6.1 → fprime_gds-4.0.0}/.github/workflows/codeql-security-scan.yml

@@ -8,6 +8,10 @@ on:
   pull_request:
     # The branches below must be a subset of the branches above
     branches: [ devel ]
+# Cancel in-progress runs if a newer run is started on a given PR
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ !contains(github.ref, 'devel') && !contains(github.ref, 'release/')}}
 
 jobs:
   analyze:

{fprime_gds-3.6.1 → fprime_gds-4.0.0}/.github/workflows/fprime-gds-tests.yml

@@ -6,6 +6,10 @@ on:
   pull_request:
     # The branches below must be a subset of the branches above
     branches: [ devel ]
+# Cancel in-progress runs if a newer run is started on a given PR
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ !contains(github.ref, 'devel') && !contains(github.ref, 'release/')}}
 
 jobs:
   Unit-tests:
@@ -13,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - uses: actions/checkout@v4

{fprime_gds-3.6.1 → fprime_gds-4.0.0}/.github/workflows/gds-cli-tests.yml

@@ -6,6 +6,10 @@ on:
   pull_request:
     # The branches below must be a subset of the branches above
     branches: [ devel ]
+# Cancel in-progress runs if a newer run is started on a given PR
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ !contains(github.ref, 'devel') && !contains(github.ref, 'release/')}}
 
 env:
   DICTIONARY: ./.github/resources/RefTopologyAppDictionary.xml
@@ -16,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
 

{fprime_gds-3.6.1 → fprime_gds-4.0.0}/.github/workflows/spelling.yml

@@ -11,6 +11,10 @@ on:
     tags-ignore:
       - "**"
     types: ['opened', 'reopened', 'synchronize']
+# Cancel in-progress runs if a newer run is started on a given PR
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ !contains(github.ref, 'devel') && !contains(github.ref, 'release/')}}
 
 jobs:
   spelling:

{fprime_gds-3.6.1 → fprime_gds-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: fprime-gds
-Version: 3.6.1
+Version: 4.0.0
 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: 
@@ -216,15 +216,15 @@ Classifier: Operating System :: Unix
 Classifier: Operating System :: POSIX
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: License :: OSI Approved :: Apache Software License
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 License-File: NOTICE.txt
@@ -240,10 +240,15 @@ Requires-Dist: Jinja2>=2.11.3
 Requires-Dist: openpyxl>=3.0.10
 Requires-Dist: pyserial>=3.5
 Requires-Dist: pydantic>=2.6
+Requires-Dist: lark>=1.2.2
+Requires-Dist: PyYAML>=6.0.2
+Requires-Dist: spacepackets>=0.30.0
+Requires-Dist: crc>=7.0.0
+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 +273,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 +291,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 +318,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 +442,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.1 → fprime_gds-4.0.0}/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.1 → fprime_gds-4.0.0}/pyproject.toml

@@ -7,7 +7,7 @@ name = "fprime-gds"
 dynamic = ["version"]
 description = "F Prime Flight Software Ground Data System layer"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 license = {file = "LICENSE.txt"}
 keywords = ["fprime", "embedded", "nasa", "flight", "software"]
 authors = [
@@ -21,11 +21,11 @@ classifiers = [
     "Operating System :: POSIX",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
     "License :: OSI Approved :: Apache Software License",
@@ -42,7 +42,11 @@ dependencies = [
     "Jinja2>=2.11.3",
     "openpyxl>=3.0.10",
     "pyserial>=3.5",
-    "pydantic>=2.6"
+    "pydantic>=2.6",
+    "lark>=1.2.2",
+    "PyYAML>=6.0.2",
+    "spacepackets>=0.30.0",
+    "crc>=7.0.0"
 ]
 
 [project.urls]
@@ -61,6 +65,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-fpyc = "fprime_gds.common.fpy.main:main"
 
 # For Pytest fixtures
 [project.entry-points."pytest11"]

{fprime_gds-3.6.1 → fprime_gds-4.0.0}/src/fprime_gds/common/communication/adapters/ip.py

@@ -50,13 +50,11 @@ class IpAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
     both. This data is concatenated and returned up the stack for processing.
     """
 
-    # Interval to send a KEEPALIVE packet. None will turn off KEEPALIVE.
-    KEEPALIVE_INTERVAL = 0.500
     # Data to send out as part of the KEEPALIVE packet. Should not be null nor empty.
     KEEPALIVE_DATA = b"sitting well"
     MAXIMUM_DATA_SIZE = 4096
 
-    def __init__(self, address, port, server=True):
+    def __init__(self, address, port, server=True, keepalive_interval=0.5):
         """
         Initialize this adapter by creating a handler for UDP and TCP. A thread for the KEEPALIVE application packets
         will be created, if the interval is not none. Handlers are servers unless server=False.
@@ -64,7 +62,8 @@ class IpAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
         self.address = address
         self.port = port
         self.stop = False
-        self.keepalive = None
+        self.keepalive_thread = None
+        self.keepalive_interval = keepalive_interval
         self.tcp = TcpHandler(address, port, server=server)
         self.udp = UdpHandler(address, port, server=server)
         self.thtcp = None
@@ -91,11 +90,11 @@ class IpAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
             self.thudp.daemon = True
             self.thudp.start()
             # Start up a keep-alive ping if desired. This will hit the TCP uplink, and die if the connection is down
-            if IpAdapter.KEEPALIVE_INTERVAL is not None:
-                self.keepalive = threading.Thread(
-                    target=self.th_alive, name="KeepCommAliveThread", args=[float(self.KEEPALIVE_INTERVAL)]
+            if self.keepalive_interval > 0.0:
+                self.keepalive_thread = threading.Thread(
+                    target=self.th_alive, name="KeepCommAliveThread", args=[self.keepalive_interval]
                 )
-                self.keepalive.start()
+                self.keepalive_thread.start()
         except (ValueError, TypeError) as exc:
             LOGGER.error(
                 f"Failed to start keep-alive thread. {type(exc).__name__}: {str(exc)}"
@@ -186,6 +185,12 @@ class IpAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
                 "default": True,
                 "help": "Run the IP adapter as the client (connects to FSW running TcpServer)",
             },
+            ("--keepalive-interval",): {
+                "dest": "keepalive_interval",
+                "type": float,
+                "default": 0.5000,
+                "help": "Keep alive packet interval. 0.0 = off, default = 0.5",
+            },
         }
 
     @classmethod
@@ -195,7 +200,7 @@ class IpAdapter(fprime_gds.common.communication.adapters.base.BaseAdapter):
         return cls
 
     @classmethod
-    def check_arguments(cls, address, port, server=True):
+    def check_arguments(cls, address, port, server=True, keepalive_interval=0.5):
         """
         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.