Advanced Sequence Compiler 0.1

.github/actions/spelling/expect.txt

@@ -35,6 +35,7 @@ autoapi
 AUTOBRIEF
 autocoded
 autocomplete
+autocompletion
 Autodetected
 autodoc
 autogen
@@ -77,6 +78,7 @@ CFDP
 CFPD
 cgi
 Chainable
+chans
 chartjs
 checkbox
 CHNG
@@ -103,13 +105,15 @@ config
 configparser
 configs
 Consolas
+consts
 cpp
 CPython
 creatingdocsetswithdoxygen
 css
 csum
 csv
 ctime
+ctor
 CTORS
 curateable
 curated
@@ -118,6 +122,8 @@ customise
 cwd
 cxx
 daringfireball
+dataclass
+dataclasses
 dataobjects
 datastore
 datastructures
@@ -218,6 +224,8 @@ evt
 exe
 executables
 expanduser
+Expr
+expr
 extlinks
 extns
 exts
@@ -249,6 +257,9 @@ FONTSIZE
 fpp
 fprime
 fptable
+fpy
+Fpy
+fqn
 frac
 framerate
 fromtimestamp
@@ -312,6 +323,7 @@ hyperlink
 hyperlinks
 idct
 idl
+idx
 ieeetr
 ifconfig
 ified
@@ -369,6 +381,7 @@ keepalive
 keyframes
 keyify
 kinda
+kwarg
 kwargs
 len
 lestarch
@@ -623,6 +636,7 @@ staticmethod
 stderr
 Stdio
 stdout
+stmt
 strftime
 stringified
 stringify

pyproject.toml

@@ -61,6 +61,7 @@ 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-seq = "fprime_gds.common.sequence.compiler:main"
 
 # For Pytest fixtures
 [project.entry-points."pytest11"]

src/fprime_gds/common/sequence/README.md

@@ -0,0 +1,86 @@
+# FPy Advanced Sequencing Language Version 0.1
+The FPy advanced sequencing language is a combination of a high-level scripting language and a low-level bytecode language for running complex command sequences on spacecraft flight software.
+## FPy Syntax
+### Modules, components, channels, commands and types
+You can imagine the FPy syntax as Python with the following mappings:
+1. FPrime modules become Python namespaces
+2. FPrime components become Python classes
+3. FPrime types (structs, arrays and enums) become Python classes
+4. FPrime component instances become Python object instances
+5. FPrime commands become member functions of Python object instances
+6. FPrime telemetry channels become member properties of Python object instances
+
+FPrime declaration:
+```
+module Ref {
+    passive component ExampleComponent {
+        telemetry testChannel: U8
+        sync command TEST_COMMAND(arg: string size 40)
+    }
+
+    instance exampleInstance: ExampleComponent base id 0x01
+}
+```
+FPy usage:
+```py
+# reference a telemetry channel
+Ref.exampleInstance.testChannel
+# call a command
+Ref.exampleInstance.TEST_COMMAND("arg value")
+```
+
+
+FPrime declaration:
+```
+struct ExampleStruct {
+    member: F32
+}
+
+enum TestEnum {
+    ONE
+    TWO
+    THREE
+}
+
+array TestArray = [3] U8
+```
+
+FPy usage:
+```py
+# construct a struct
+ExampleStruct(0.0)
+# reference an enum const
+TestEnum.THREE
+# construct an array
+TestArray(1, 2, 3)
+```
+
+### Sequence directives
+FPy also has sequence directives, which are like commands that control the running sequence itself.
+
+The most common sequence directives are absolute and relative sleep:
+```py
+sleep_abs(Time(time_base, time_context, seconds, useconds))
+sleep_rel(Time(time_base, time_context, seconds, useconds))
+```
+
+Due to the nature of the FPrime `CmdSequencer`, you can only have zero or one `sleep` directives before each command.
+
+## FPy Usage
+```
+fprime-seq <sequence.fpy> -d <TopologyDictionary.json> [-o <output.bin>]
+
+A compiler for the FPrime advanced sequencing language
+
+positional arguments:
+  input                 The path of the input sequence to compile
+
+options:
+  -h, --help            show this help message and exit
+  -d DICTIONARY, --dictionary DICTIONARY
+                        The JSON topology dictionary to compile against
+  -o OUTPUT, --output OUTPUT
+                        The output .bin file path. Defaults to the input file path
+```
+
+The result is a sequence binary file that works with the FPrime `CmdSequencer`.