From 89ddea6d2adb1f60e73894e3e18ea0974b545fa3 Mon Sep 17 00:00:00 2001 From: Clayton Smith Date: Thu, 5 Oct 2023 19:30:10 -0400 Subject: [PATCH] Clarify the format of core:version Also, update the examples to use the correct format. --- extensions/spatial.sigmf-ext.md | 2 +- sigmf-spec.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/extensions/spatial.sigmf-ext.md b/extensions/spatial.sigmf-ext.md index e3a83a3..28118d8 100644 --- a/extensions/spatial.sigmf-ext.md +++ b/extensions/spatial.sigmf-ext.md @@ -434,7 +434,7 @@ element recording: ```JSON { "collection": { - "core:version": "v1.0.0", + "core:version": "1.0.0", "core:extensions" : [ { "name": "spatial", diff --git a/sigmf-spec.md b/sigmf-spec.md index 9bb198d..5eb6064 100644 --- a/sigmf-spec.md +++ b/sigmf-spec.md @@ -351,7 +351,7 @@ Object: | --------------- | -------- | --------| -----------------| | `datatype` | true | string | The SigMF Dataset format of the stored samples in the Dataset file.| | `sample_rate` | false | double | The sample rate of the signal in samples per second.| -| `version` | true | string | The version of the SigMF specification used to create the Metadata file.| +| `version` | true | string | The version of the SigMF specification used to create the Metadata file, in the format `X.Y.Z`.| | `num_channels` | false | uint | Total number of interleaved channels in the Dataset file; if omitted this is implied to be `1`. For multiple channels of IQ data, it is RECOMMENDED to use SigMF Collections instead of `num_channels` for widest application support.| | `sha512` | false | string | The SHA512 hash of the Dataset file associated with the SigMF file.| | `offset` | false | uint | The index number of the first sample in the Dataset. If not provided, this value defaults to zero. Typically used when a Recording is split over multiple files. All sample indices in SigMF are absolute, and so all other indices referenced in metadata for this recording SHOULD be greater than or equal to this value.| @@ -742,7 +742,7 @@ Example `top-level.sigmf-collection` file: ```JSON { "collection": { - "core:version": "v1.0.0", + "core:version": "1.0.0", "core:extensions" : [ { "name": "antenna",