Merge branch 'main' into software-camera-doc

discosat · Apr 9, 2024 · ff3c3e7 · ff3c3e7
2 parents 046c995 + d9c98cd
commit ff3c3e7
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 2 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -9,7 +9,10 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout code (including submodules)
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
       - uses: actions/setup-python@v3
       - name: Install dependencies
         run: |

diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "doc/disco-2/sub-docs/csp_proc"]
+	path = doc/disco-2/sub-docs/csp_proc
+	url = https://github.com/discosat/csp_proc.git
diff --git a/doc/disco-2/software/flight-planning-csp-proc.rst b/doc/disco-2/software/flight-planning-csp-proc.rst
@@ -0,0 +1,12 @@
+Flight planning (csp_proc)
+======================
+
+
+`csp_proc` is the library responsible for low-level flight planning / orchestration of the CSP nodes for scientific observations. It provides a set of general instructions that can be used to set libparam parameters with simple synchronization and conditional logic. The library is described in more detail on its own documentation page at https://discosat.github.io/csp_proc/ - which is also embedded as the following sub-pages.
+
+.. toctree::
+   :maxdepth: 2
+
+   ../sub-docs/csp_proc/index
+   ../sub-docs/csp_proc_function_reference.rst
+
diff --git a/doc/disco-2/software/image-processing-pipeline.md b/doc/disco-2/software/image-processing-pipeline.md
@@ -216,6 +216,10 @@ DIPP includes an integer parameter indicating the most recent cause of failure.
 | 504        | Internal Error: Integer Parameter Not Found            |
 | 505        | Internal Error: Float Parameter Not Found              |
 | 506        | Internal Error: String Parameter Not Found             |
+| 507        | Internal Error: Failed to pull remote parameter        |
+| 508        | Internal Error: Failed to push remote parameter        |
+| 509        | Internal Error: VMEM Not Found                         |
+| 510        | Internal Error: VMEM Upload Failed                     |
 | 600        | Module Exit Error: Crash                               |
 | 601        | Module Exit Error: Normal                              |
 | 700-799    | Module Exit Error: Custom error code defined by module |

diff --git a/doc/disco-2/software/index.rst b/doc/disco-2/software/index.rst
@@ -5,4 +5,5 @@ Software
 .. toctree::
   getting-started.md
   image-processing-pipeline.md
-  camera-controller.md
+  camera-controller.md
+  flight-planning-csp-proc.rst
diff --git a/doc/disco-2/sub-docs/csp_proc b/doc/disco-2/sub-docs/csp_proc
diff --git a/doc/disco-2/sub-docs/csp_proc_function_reference.rst b/doc/disco-2/sub-docs/csp_proc_function_reference.rst
@@ -0,0 +1,7 @@
+`csp_proc` Function Reference
+======================
+
+
+.. raw:: html
+
+   <meta http-equiv="refresh" content="0; url=https://discosat.github.io/csp_proc/docs/html/index.html" />