ADDS docs images

Author: bytecod3

Doxyfile

@@ -1146,7 +1146,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = $(PROJECT_SOURCE_DIR)/user-docs/images
 
 # The INPUT_FILTER tag can be used to specify a program that Doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program

README.md

@@ -151,7 +151,7 @@
 </details>
 
 
-# Project-Shadow-Flight
+<h1> <a href="#project-shadow-flight">Project-Shadow-Flight</a> </h1>
 "Oh yee space fairer!
 I will write your name on the moon with my fingertips"
 ~ ESA, EIRSAT-mission

application-notes/.ccsds-tm-decoding.kate-swp

@@ -3,14 +3,21 @@ This file describes the Modified CCSDS packet
 All the following data pointa/octets are contigous
 
 HEADER:
-Transfer frame version NUmber TFVN
-Spacecraft identifier SCID 
-Virtual channel identifier VCID
 
 
 PROTOCOL DATA UNIT:
    - TELEMETRY TRANSFER FRAME
-      1.
+      1. Header (6 bytes) - mandatory :
+                  Transfer frame version NUmber TFVN
+                  Spacecraft identifier SCID
+                  Virtual channel identifier VCID
+      2. Secondary header (64 bytes) - optional
+
+      3. Data field (N bytes) - mandatory
+
+      4. Operational control field ((4 bytes)
+
+      5. Frame error control field (2 bytes)
 
 
 

application-notes/ccsds-tm-decoding

@@ -25,69 +25,107 @@
 var NAVTREE =
 [
   [ "Project Shadow Flight - A 1U Cubesat", "index.html", [
-    [ "Project-Shadow-Flight", "index.html#autotoc_md0", [
-      [ "Introduction", "index.html#autotoc_md1", [
-        [ "Web documentation", "index.html#autotoc_md2", null ],
-        [ "Design Videos for visual consumers", "index.html#autotoc_md3", null ]
+    [ "System components", "index.html#autotoc_md5", [
+      [ "Introduction", "index.html#autotoc_md0", [
+        [ "Web documentation", "index.html#autotoc_md1", null ],
+        [ "Design Videos for visual consumers", "index.html#autotoc_md2", null ]
       ] ],
-      [ "Motivation", "index.html#autotoc_md4", null ],
-      [ "Mission statement", "index.html#autotoc_md5", null ]
-    ] ],
-    [ "System components", "index.html#autotoc_md6", [
-      [ "1. Onboard Computer", "index.html#autotoc_md7", [
-        [ "Introduction", "index.html#autotoc_md8", null ],
-        [ "Functional requirements", "index.html#autotoc_md9", null ],
-        [ "Components of the OBC", "index.html#autotoc_md10", null ]
+      [ "Motivation", "index.html#autotoc_md3", null ],
+      [ "Mission statement", "index.html#autotoc_md4", null ],
+      [ "1. Onboard Computer", "index.html#autotoc_md6", [
+        [ "Introduction", "index.html#autotoc_md7", null ],
+        [ "Functional requirements", "index.html#autotoc_md8", null ],
+        [ "Components of the OBC", "index.html#autotoc_md9", null ]
       ] ],
-      [ "2. Sensor Board", "index.html#autotoc_md11", [
-        [ "Introduction", "index.html#autotoc_md12", null ],
-        [ "Functional requirements", "index.html#autotoc_md13", null ],
-        [ "Communication protocol for sensors", "index.html#autotoc_md14", null ],
-        [ "The PC/104 ISA Bus", "index.html#autotoc_md15", null ]
+      [ "2. Sensor Board", "index.html#autotoc_md10", [
+        [ "Introduction", "index.html#autotoc_md11", null ],
+        [ "Functional requirements", "index.html#autotoc_md12", null ],
+        [ "Communication protocol for sensors", "index.html#autotoc_md13", null ],
+        [ "The PC/104 ISA Bus", "index.html#autotoc_md14", null ]
       ] ],
-      [ "<img src=\"./user-docs/images/pc104-dwg-500.gif\" alt=\"Shadow flight OBC\" width=\"400\" height=\"400\"/>", "index.html#autotoc_md17", [
-        [ "My Pin definition", "index.html#autotoc_md19", null ]
+      [ "<img src=\"./user-docs/images/pc104-dwg-500.gif\" alt=\"Shadow flight OBC\" width=\"400\" height=\"400\"/>", "index.html#autotoc_md16", [
+        [ "My Pin definition", "index.html#autotoc_md18", null ]
       ] ],
-      [ "3. Attitude Determination and Control", "index.html#autotoc_md20", null ],
-      [ "4. Electrical Power System (EPS)", "index.html#autotoc_md21", [
-        [ "Introduction", "index.html#autotoc_md22", null ],
-        [ "a) Power consumption of different bus components", "index.html#autotoc_md23", null ],
-        [ "b) Power generation", "index.html#autotoc_md24", null ],
-        [ "c) Energy storage", "index.html#autotoc_md25", null ],
-        [ "d) Mission analysis in regards to power", "index.html#autotoc_md26", null ],
-        [ "e) EPS Schematics summary", "index.html#autotoc_md27", [
-          [ "Conversion", "index.html#autotoc_md28", null ],
-          [ "Power Distribution Schemes", "index.html#autotoc_md29", null ],
-          [ "Power supply control", "index.html#autotoc_md30", null ]
+      [ "3. Attitude Determination and Control", "index.html#autotoc_md19", null ],
+      [ "4. Electrical Power System (EPS)", "index.html#autotoc_md20", [
+        [ "Introduction", "index.html#autotoc_md21", null ],
+        [ "a) Power consumption of different bus components", "index.html#autotoc_md22", null ],
+        [ "b) Power generation", "index.html#autotoc_md23", null ],
+        [ "c) Energy storage", "index.html#autotoc_md24", null ],
+        [ "d) Mission analysis in regards to power", "index.html#autotoc_md25", null ],
+        [ "e) EPS Schematics summary", "index.html#autotoc_md26", [
+          [ "Conversion", "index.html#autotoc_md27", null ],
+          [ "Power Distribution Schemes", "index.html#autotoc_md28", null ],
+          [ "Power supply control", "index.html#autotoc_md29", null ]
         ] ],
-        [ "f) Isolated tests", "index.html#autotoc_md31", null ],
-        [ "g) EPS integration and Testing", "index.html#autotoc_md32", [
-          [ "Battery and solar panel sizing data", "index.html#autotoc_md33", null ]
+        [ "f) Isolated tests", "index.html#autotoc_md30", null ],
+        [ "g) EPS integration and Testing", "index.html#autotoc_md31", [
+          [ "Battery and solar panel sizing data", "index.html#autotoc_md32", null ]
         ] ]
       ] ]
     ] ],
-    [ "5. Payload and Mission Design", "index.html#autotoc_md34", [
-      [ "Payload PCB", "index.html#autotoc_md37", [
-        [ "Payload system requirements", "index.html#autotoc_md35", null ],
-        [ "Payload communication interface", "index.html#autotoc_md36", [
-          [ "Tracks", "index.html#autotoc_md38", null ],
-          [ "3D view", "index.html#autotoc_md39", null ]
+    [ "5. Payload and Mission Design", "index.html#autotoc_md33", [
+      [ "Payload PCB", "index.html#autotoc_md36", [
+        [ "Payload system requirements", "index.html#autotoc_md34", null ],
+        [ "Payload communication interface", "index.html#autotoc_md35", [
+          [ "Tracks", "index.html#autotoc_md37", null ],
+          [ "3D view", "index.html#autotoc_md38", null ]
         ] ]
       ] ]
     ] ],
-    [ "Communication Protocol", "index.html#autotoc_md40", [
-      [ "CCSDS Telemetry(TM) Space Data Link Protocol", "index.html#autotoc_md41", [
-        [ "What is CCSDS Space Data Link Protocol", "index.html#autotoc_md42", null ],
-        [ "CCSDS protocol data unit (PDU)", "index.html#autotoc_md43", null ],
-        [ "Field descriptions", "index.html#autotoc_md44", null ],
-        [ "How it is implemented", "index.html#autotoc_md45", null ],
-        [ "Interface with the ground station", "index.html#autotoc_md46", null ],
-        [ "Data limits and known issues", "index.html#autotoc_md47", null ]
+    [ "Communication Protocol", "index.html#autotoc_md39", [
+      [ "CCSDS Telemetry(TM) Space Data Link Protocol", "index.html#autotoc_md40", [
+        [ "What is CCSDS Space Data Link Protocol", "index.html#autotoc_md41", null ],
+        [ "CCSDS protocol data unit (PDU)", "index.html#autotoc_md42", null ],
+        [ "Field descriptions", "index.html#autotoc_md43", null ],
+        [ "How it is implemented", "index.html#autotoc_md44", null ],
+        [ "Protocol data frame (PDU)", "index.html#autotoc_md45", [
+          [ "1. Primary header", "index.html#autotoc_md47", null ],
+          [ "Transfer Frame Version Number", "index.html#autotoc_md48", null ],
+          [ "Spacecraft Identifier (SCID)", "index.html#autotoc_md49", null ]
+        ] ],
+        [ "CCSDS Transfer Frame Header – Virtual Channel, Control Flag, and Counters", "index.html#autotoc_md50", [
+          [ "Virtual Channel Identifier (VCID)", "index.html#autotoc_md51", null ],
+          [ "Operational Control Field Flag (OCF Flag)", "index.html#autotoc_md52", null ],
+          [ "Master Channel Frame Count (MCFC)", "index.html#autotoc_md53", null ],
+          [ "Virtual Channel Frame Count (VCFC)", "index.html#autotoc_md54", null ],
+          [ "Transfer Frame Data Field Status (TFDFS)", "index.html#autotoc_md55", null ],
+          [ "Purpose", "index.html#autotoc_md56", null ]
+        ] ],
+        [ "CCSDS Transfer Frame Secondary Header", "index.html#autotoc_md57", [
+          [ "Overview", "index.html#autotoc_md58", null ],
+          [ "Structure", "index.html#autotoc_md59", null ],
+          [ "Channel Association", "index.html#autotoc_md60", null ],
+          [ "Usage Rules", "index.html#autotoc_md61", null ],
+          [ "Secondary header data field usage", "index.html#autotoc_md62", null ]
+        ] ],
+        [ "Transfer Frame Data Field", "index.html#autotoc_md63", [
+          [ "Overview", "index.html#autotoc_md64", null ],
+          [ "Field Length", "index.html#autotoc_md65", null ],
+          [ "Field Contents", "index.html#autotoc_md66", null ],
+          [ "Channel Data Rules", "index.html#autotoc_md67", null ],
+          [ "Packet Placement", "index.html#autotoc_md68", null ]
+        ] ]
+      ] ],
+      [ "</blockquote>", "index.html#autotoc_md69", [
+        [ "OID (Only Idle Data) Transfer Frames", "index.html#autotoc_md70", [
+          [ "OID Frame Rules", "index.html#autotoc_md71", null ],
+          [ "LFSR Initialization", "index.html#autotoc_md72", null ],
+          [ "VCID Association", "index.html#autotoc_md73", null ],
+          [ "Notes", "index.html#autotoc_md74", null ],
+          [ "Idle data", "index.html#autotoc_md75", null ]
+        ] ],
+        [ "Frame Error Control Field (FECF)", "index.html#autotoc_md76", [
+          [ "Overview", "index.html#autotoc_md77", null ],
+          [ "Encoding Procedure", "index.html#autotoc_md79", null ]
+        ] ],
+        [ "Interface with the ground station", "index.html#autotoc_md80", null ],
+        [ "Data limits and known issues", "index.html#autotoc_md81", null ]
       ] ],
-      [ "Related documents", "index.html#autotoc_md48", null ],
-      [ "Relevant videos and resource materials", "index.html#autotoc_md49", null ],
-      [ "Contribution and support", "index.html#autotoc_md50", null ],
-      [ "Contributors", "index.html#autotoc_md51", null ]
+      [ "Related documents", "index.html#autotoc_md82", null ],
+      [ "Relevant videos and resource materials", "index.html#autotoc_md83", null ],
+      [ "Contribution and support", "index.html#autotoc_md84", null ],
+      [ "Contributors", "index.html#autotoc_md85", null ]
     ] ]
   ] ]
 ];

documentation/firmware-docs/html/index.html

@@ -3,53 +3,85 @@ var NAVTREEINDEX0 =
 "index.html":[],
 "index.html#autotoc_md0":[0],
 "index.html#autotoc_md1":[0,0],
-"index.html#autotoc_md10":[1,0,2],
-"index.html#autotoc_md11":[1,1],
-"index.html#autotoc_md12":[1,1,0],
-"index.html#autotoc_md13":[1,1,1],
-"index.html#autotoc_md14":[1,1,2],
-"index.html#autotoc_md15":[1,1,3],
-"index.html#autotoc_md17":[1,2],
-"index.html#autotoc_md19":[1,2,0],
-"index.html#autotoc_md2":[0,0,0],
-"index.html#autotoc_md20":[1,3],
-"index.html#autotoc_md21":[1,4],
-"index.html#autotoc_md22":[1,4,0],
-"index.html#autotoc_md23":[1,4,1],
-"index.html#autotoc_md24":[1,4,2],
-"index.html#autotoc_md25":[1,4,3],
-"index.html#autotoc_md26":[1,4,4],
-"index.html#autotoc_md27":[1,4,5],
-"index.html#autotoc_md28":[1,4,5,0],
-"index.html#autotoc_md29":[1,4,5,1],
-"index.html#autotoc_md3":[0,0,1],
-"index.html#autotoc_md30":[1,4,5,2],
-"index.html#autotoc_md31":[1,4,6],
-"index.html#autotoc_md32":[1,4,7],
-"index.html#autotoc_md33":[1,4,7,0],
-"index.html#autotoc_md34":[2],
-"index.html#autotoc_md35":[0],
-"index.html#autotoc_md36":[1],
-"index.html#autotoc_md37":[2,0],
-"index.html#autotoc_md38":[1,0],
-"index.html#autotoc_md39":[1,1],
-"index.html#autotoc_md4":[0,1],
-"index.html#autotoc_md40":[3],
-"index.html#autotoc_md41":[3,0],
-"index.html#autotoc_md42":[3,0,0],
-"index.html#autotoc_md43":[3,0,1],
-"index.html#autotoc_md44":[3,0,2],
-"index.html#autotoc_md45":[3,0,3],
-"index.html#autotoc_md46":[3,0,4],
-"index.html#autotoc_md47":[3,0,5],
-"index.html#autotoc_md48":[3,1],
-"index.html#autotoc_md49":[3,2],
-"index.html#autotoc_md5":[0,2],
-"index.html#autotoc_md50":[3,3],
-"index.html#autotoc_md51":[3,4],
-"index.html#autotoc_md6":[1],
-"index.html#autotoc_md7":[1,0],
-"index.html#autotoc_md8":[1,0,0],
-"index.html#autotoc_md9":[1,0,1],
+"index.html#autotoc_md10":[0,4],
+"index.html#autotoc_md11":[0,4,0],
+"index.html#autotoc_md12":[0,4,1],
+"index.html#autotoc_md13":[0,4,2],
+"index.html#autotoc_md14":[0,4,3],
+"index.html#autotoc_md16":[0,5],
+"index.html#autotoc_md18":[0,5,0],
+"index.html#autotoc_md19":[0,6],
+"index.html#autotoc_md2":[0,1],
+"index.html#autotoc_md20":[0,7],
+"index.html#autotoc_md21":[0,7,0],
+"index.html#autotoc_md22":[0,7,1],
+"index.html#autotoc_md23":[0,7,2],
+"index.html#autotoc_md24":[0,7,3],
+"index.html#autotoc_md25":[0,7,4],
+"index.html#autotoc_md26":[0,7,5],
+"index.html#autotoc_md27":[0,7,5,0],
+"index.html#autotoc_md28":[0,7,5,1],
+"index.html#autotoc_md29":[0,7,5,2],
+"index.html#autotoc_md3":[1],
+"index.html#autotoc_md30":[0,7,6],
+"index.html#autotoc_md31":[0,7,7],
+"index.html#autotoc_md32":[0,7,7,0],
+"index.html#autotoc_md33":[1],
+"index.html#autotoc_md34":[0],
+"index.html#autotoc_md35":[1],
+"index.html#autotoc_md36":[1,0],
+"index.html#autotoc_md37":[1,0],
+"index.html#autotoc_md38":[1,1],
+"index.html#autotoc_md39":[2],
+"index.html#autotoc_md4":[2],
+"index.html#autotoc_md40":[2,0],
+"index.html#autotoc_md41":[2,0,0],
+"index.html#autotoc_md42":[2,0,1],
+"index.html#autotoc_md43":[2,0,2],
+"index.html#autotoc_md44":[2,0,3],
+"index.html#autotoc_md45":[2,0,4],
+"index.html#autotoc_md47":[2,0,4,0],
+"index.html#autotoc_md48":[2,0,4,1],
+"index.html#autotoc_md49":[2,0,4,2],
+"index.html#autotoc_md5":[0],
+"index.html#autotoc_md50":[2,0,5],
+"index.html#autotoc_md51":[2,0,5,0],
+"index.html#autotoc_md52":[2,0,5,1],
+"index.html#autotoc_md53":[2,0,5,2],
+"index.html#autotoc_md54":[2,0,5,3],
+"index.html#autotoc_md55":[2,0,5,4],
+"index.html#autotoc_md56":[2,0,5,5],
+"index.html#autotoc_md57":[2,0,6],
+"index.html#autotoc_md58":[2,0,6,0],
+"index.html#autotoc_md59":[2,0,6,1],
+"index.html#autotoc_md6":[0,3],
+"index.html#autotoc_md60":[2,0,6,2],
+"index.html#autotoc_md61":[2,0,6,3],
+"index.html#autotoc_md62":[2,0,6,4],
+"index.html#autotoc_md63":[2,0,7],
+"index.html#autotoc_md64":[2,0,7,0],
+"index.html#autotoc_md65":[2,0,7,1],
+"index.html#autotoc_md66":[2,0,7,2],
+"index.html#autotoc_md67":[2,0,7,3],
+"index.html#autotoc_md68":[2,0,7,4],
+"index.html#autotoc_md69":[2,1],
+"index.html#autotoc_md7":[0,3,0],
+"index.html#autotoc_md70":[2,1,0],
+"index.html#autotoc_md71":[2,1,0,0],
+"index.html#autotoc_md72":[2,1,0,1],
+"index.html#autotoc_md73":[2,1,0,2],
+"index.html#autotoc_md74":[2,1,0,3],
+"index.html#autotoc_md75":[2,1,0,4],
+"index.html#autotoc_md76":[2,1,1],
+"index.html#autotoc_md77":[2,1,1,0],
+"index.html#autotoc_md79":[2,1,1,1],
+"index.html#autotoc_md8":[0,3,1],
+"index.html#autotoc_md80":[2,1,2],
+"index.html#autotoc_md81":[2,1,3],
+"index.html#autotoc_md82":[2,2],
+"index.html#autotoc_md83":[2,3],
+"index.html#autotoc_md84":[2,4],
+"index.html#autotoc_md85":[2,5],
+"index.html#autotoc_md9":[0,3,2],
 "pages.html":[]
 };

documentation/firmware-docs/html/navtreedata.js

@@ -1,6 +1,6 @@
 doxygen/doxygen_new_line_after_brief=true
 doxygen/doxygen_use_brief_tag=true
 doxygen/doxygen_use_javadoc_tags=true
-doxygen/doxygen_use_pre_tag=true
+doxygen/doxygen_use_pre_tag=false
 doxygen/doxygen_use_structural_commands=true
 eclipse.preferences.version=1

documentation/firmware-docs/html/navtreeindex0.js

@@ -1,13 +1,40 @@
 /*
- * ccsds_tm.h
+ * @file ccsds_tm.h
+ * @ brief This file declares the functions for CCSDS telemetry protocol
+ * @author Edwin Mwiti
+ * @date Oct 6, 2025
+ *
  *
- *  Created on: Oct 6, 2025
- *      Author: eduh
  */
 
 #ifndef INC_CCSDS_TM_H_
 #define INC_CCSDS_TM_H_
 
+#include "stdio.h"
+#include "defines.h"
+
+#define CRC_POLYNOMIAL 0x1021    ///< Polynomial to use for CRC-16 calculation
+
+
+/**
+ * @fn uint16_t CCSDS_TM_calculate_crc16()
+ * @brief This function calculates the CRC16 for the given sequence of bytes
+ * @return crc16 value
+ */
+uint16_t CCSDS_TM_calculate_crc16(const uint8_t *data_buffer, uint16_t length);
+
+/**
+ * @fn void CCSDS_TM_compose_packet()
+ * @brief This function creates a CCSDS packet based off the passed data
+ *
+ */
+void CCSDS_TM_compose_packet();
 
+/**
+ * @fn void CCSDS_TM_parse_packet()
+ * @brief This function decomposes a CCSDS packet
+ *
+ */
+void CCSDS_TM_parse_packet();
 
 #endif /* INC_CCSDS_TM_H_ */