Skip to content

Commit

Permalink
Merge pull request #398 from righel/add-sigmf-templates
Browse files Browse the repository at this point in the history
new: add basic SigMF templates
  • Loading branch information
righel authored Aug 3, 2023
2 parents 4da0529 + 21b06c2 commit 800d677
Show file tree
Hide file tree
Showing 3 changed files with 189 additions and 0 deletions.
18 changes: 18 additions & 0 deletions objects/sigmf-archive/definition.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"attributes": {
"SigMF-archive": {
"description": "tar archive (.sigmf)",
"disable_correlation": true,
"misp-attribute": "attachment",
"ui-priority": 1
}
},
"description": "An object representing an archive containing one or multiple recordings in the Signal Metadata Format Specification (SigMF)",
"meta-category": "misc",
"name": "sigmf-archive",
"required": [
"SigMF-archive"
],
"uuid": "5985d34d-3657-4828-9788-470175bcc3b1",
"version": 1
}
147 changes: 147 additions & 0 deletions objects/sigmf-expanded-recording/definition.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
{
"attributes": {
"author": {
"description": "A text identifier for the author potentially including name, handle, email, and/or other ID like Amateur Call Sign.",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"collection": {
"description": "The base filename of a collection with which this Recording is associated.",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"data_doi": {
"description": "The registered DOI (ISO 26324) for a Recording's Dataset file.",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"dataset": {
"description": "The full filename of the Dataset file this Metadata file describes.",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"datatype": {
"description": "",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"description": {
"description": "A text description of the SigMF Recording.",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"fft-plot": {
"description": "FFT plot of the signal",
"disable_correlation": true,
"misp-attribute": "attachment",
"ui-priority": 0
},
"geolocation_alt": {
"description": "The location of the Recording system (altitude).",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"geolocation_lat": {
"description": "The location of the Recording system (latitude).",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"geolocation_long": {
"description": "The location of the Recording system (longitude).",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"hw": {
"description": "A text description of the hardware used to make the Recording.",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"iq-sample": {
"description": "Binary file of IQ samples",
"disable_correlation": true,
"misp-attribute": "attachment",
"ui-priority": 0
},
"license": {
"description": "A URL for the license document under which the Recording is offered.",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"meta_doi": {
"description": "The registered DOI (ISO 26324) for a Recording's Metadata file.",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"metadata_only": {
"description": "Indicates the Metadata file is intentionally distributed without the Dataset.",
"disable_correlation": true,
"misp-attribute": "boolean",
"ui-priority": 0
},
"num_channels": {
"description": "Total number of interleaved channels in the Dataset file. If omitted, this defaults to one.",
"disable_correlation": true,
"misp-attribute": "counter",
"ui-priority": 0
},
"offset": {
"description": "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.",
"disable_correlation": true,
"misp-attribute": "counter",
"ui-priority": 0
},
"recorder": {
"description": "The name of the software used to make this SigMF Recording.",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"sample_rate": {
"description": "The sample rate of the signal in samples per second.",
"disable_correlation": true,
"misp-attribute": "float",
"ui-priority": 0
},
"sha512": {
"description": "The SHA512 hash of the Dataset file associated with the SigMF file.",
"disable_correlation": true,
"misp-attribute": "sha512",
"ui-priority": 0
},
"trailing_bytes": {
"description": "The number of bytes to ignore at the end of a Non-Conforming Dataset file.",
"disable_correlation": true,
"misp-attribute": "counter",
"ui-priority": 0
},
"version": {
"description": "The version of the SigMF specification used to create the Metadata file.",
"disable_correlation": true,
"misp-attribute": "text",
"ui-priority": 0
},
"waterfall-plot": {
"description": "Waterfall plot of the signal",
"disable_correlation": true,
"misp-attribute": "attachment",
"ui-priority": 0
}
},
"description": "An object representing a single IQ/RF sample in the Signal Metadata Format Specification (SigMF)",
"meta-category": "misc",
"name": "sigmf-expanded-recording",
"uuid": "f1c2c4e1-d3bf-46b1-b34d-f5e9544a4795",
"version": 1
}
24 changes: 24 additions & 0 deletions objects/sigmf-recording/definition.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"attributes": {
"SigMF-data": {
"description": "Binary file of IQ or RF samples (.sigmf-data)",
"disable_correlation": true,
"misp-attribute": "attachment",
"ui-priority": 1
},
"SigMF-meta": {
"description": "Metadata file in SigMF format (.sigmf-meta)",
"disable_correlation": true,
"misp-attribute": "attachment",
"ui-priority": 0
}
},
"description": "An object representing a single IQ/RF sample in the Signal Metadata Format Specification (SigMF)",
"meta-category": "misc",
"name": "sigmf-recording",
"required": [
"SigMF-meta"
],
"uuid": "0ca64648-38ca-4e48-99ce-2e655cdac02c",
"version": 1
}

0 comments on commit 800d677

Please sign in to comment.