add unit, bit def, value desc to generated beacon docs

docs/scripts/gen_beacon_rst.py

@@ -133,13 +133,15 @@ def gen_beacon_rst(config: OreSatConfig, file_path: str, url: str):
     lines.append(f'{"-" * len(def_title)}\n')
     lines.append("\n")
     lines.append(".. csv-table::\n")
-    lines.append('   :header: "Offset", "Card", "Data Name", "Data Type", "Size", "Description"\n')
+    lines.append(
+        '   :header: "Offset", "Card", "Name", "Unit", "Data Type", "Size", "Description"\n'
+    )
     lines.append("\n")
     offset = 0
     size = len(sd)
     desc = "\nax.25 packet header (see above)\n"
     desc = desc.replace("\n", "\n   ")
-    lines.append(f'   "{offset}", "c3", "ax25_header", "octet_str", "{size}", "{desc}"\n')
+    lines.append(f'   "{offset}", "c3", "ax25_header", "", "octet_str", "{size}", "{desc}"\n')
     offset += size
 
     for obj in config.beacon_def:
@@ -165,13 +167,28 @@ def gen_beacon_rst(config: OreSatConfig, file_path: str, url: str):
 
         data_type = OD_DATA_TYPES[obj.data_type]
         desc = "\n" + obj.description + "\n"
+        if obj.name in ["start_chars", "revision"]:
+            desc += f": {obj.value}\n"
+        if obj.name == "satellite_id":
+            sat_id = OreSatId(obj.value)
+            desc += f": {sat_id.value}\n"
+        if obj.value_descriptions:
+            desc += "\n\nValue Descriptions:\n"
+            for value, descr in obj.value_descriptions.items():
+                desc += f"\n- {value}: {descr}\n"
+        if obj.bit_definitions:
+            desc += "\n\nBit Definitions:\n"
+            for name_, bits in obj.bit_definitions.items():
+                desc += f"\n- {name_}: {bits}\n"
         desc = desc.replace("\n", "\n   ")
 
-        lines.append(f'   "{offset}", "{card}", "{name}", "{data_type}", "{size}", "{desc}"\n')
+        lines.append(
+            f'   "{offset}", "{card}", "{name}", "{obj.unit}", "{data_type}", "{size}", "{desc}"\n'
+        )
         offset += size
 
     size = 4
-    lines.append(f'   "{offset}", "c3", "crc32", "uint32", "{size}", "packet checksum"\n')
+    lines.append(f'   "{offset}", "c3", "crc32", "", "uint32", "{size}", "packet checksum"\n')
     offset += size
 
     lines.append("\n")

oresat_configs/base/c3.yaml

@@ -8,11 +8,9 @@ objects:
   - index: 0x4000
     name: status
     data_type: uint8
-    description: the c3 state
     value_descriptions:
-      65: OFFLINE - This state is never actually reachable by the device. Reset vector is PRE_DEPLOY
-      66: PRE_DEPLOY - Holding state after deployment of satellite but before deployment of antennas. Ensures a minimum amount of time passes before attempting to deploy antennas and going active
-      67: DEPLOY - Antenna deployment state. Attempts to deploy antennas several times before moving to Standby
+      66: PRE_DEPLOY - Holding state after deployment of satellite but before deployment of antennas.
+      67: DEPLOY - Antenna deployment state.
       68: STANDBY Satellite is functional but in standby state. Battery level is too low or tx is disabled
       69: BEACON- Active beaconing state. Broadcasts telemetry packets via radio periodically
       70: EDL - Currently receiving and/or transmitting engineering data link packets with a groundstation

oresat_configs/base/cfc.yaml

@@ -6,7 +6,6 @@ objects:
       - subindex: 0x1
         name: status
         data_type: uint8
-        description: the camera status
         value_descriptions:
           0x1: OFF - Camera is off
           0x2: STANDBY - Camera is on not doing anything

oresat_configs/base/gps.yaml

@@ -2,7 +2,6 @@ objects:
   - index: 0x4000
     name: status
     data_type: uint8
-    description: the gps status
     value_descriptions:
       0: off
       1: searching for gps satellites