add 'description' field to captures array

Signed-off-by: Jacob Gilbert <[email protected]>
sigmf · Aug 1, 2021 · 7c15a04 · 7c15a04
1 parent 206f2a1
commit 7c15a04
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/sigmf-spec.md b/sigmf-spec.md
@@ -371,6 +371,7 @@ capture segment objects:
 |`global_index`|false|uint|If the sample source provides a global sample count, this is the global index that maps to `sample_start`.|
 |`frequency`|false|double|The center frequency of the signal in Hz.|
 |`datetime`|false|string|An ISO-8601 string indicating the timestamp of the sample index specified by `sample_start`. More details, below.|
+|`description`|false|string|A text description of the segment.|
 
 ###### The `global_index` Pair
 

diff --git a/sigmf/schema.json b/sigmf/schema.json
@@ -126,6 +126,12 @@
                 "required": false,
                 "pattern": "",
                 "help": "An ISO-8601 string indicating the timestamp of the sample index specified by sample_start. (e.g., 2017-02-01T15:05:03.000Z)"
+            },
+            "core:description": {
+                "type": "string",
+                "required": false,
+                "pattern": "",
+                "help": "A text description of the segment."
             }
         }
     },