mirror of https://github.com/gnuradio/SigMF
this includes removing ^M EOL characters, using common language to describe arrays, and fixing a problematic object name in the signal extension (`class` is not a legal name)pull/204/head
Jacob Gilbert
1 year ago
parent
b062eb34a8
commit
b8cd8db44a
@ -1,28 +1,28 @@
|
||||
# ADS-B Extension v1.0.0
|
||||
|
||||
The Automatic Dependent Surveillance-Broadcast (`adsb`) namespace extension
|
||||
defines dynamic properties of ADS-B signals extending `annotations`.
|
||||
|
||||
## 1 Global
|
||||
|
||||
`adsb` does not extend [Global](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#global-object).
|
||||
|
||||
## 2 Captures
|
||||
|
||||
`signal` does not extend [Captures](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#captures-array).
|
||||
|
||||
## 3 Annotations
|
||||
|
||||
The following names are specified in the `adsb` namespace and should be used in
|
||||
the `annotations` object:
|
||||
|
||||
|name|required|type|unit|description|
|
||||
|----|--------------|-------|-------|-----------|
|
||||
|`downlink_format`|true|int|N/A|Indicates if an ADS-B signal is a Mode S Short (11) or a Mode S Extended (17) signal.|
|
||||
|`message_type`|true|int|N/A|Indicates the type of data in a Mode S Extended signal. The message type code range is from 0 to 31. The type of messages are aircraft identification (1-4), surface position (5-8), airborne position with barometric (9-18), airborne velocities (19), airborne position with GNSS (20-22), testing (23), reserved (24-27, 30), Emergency/Airborne Collision Avoidance System (ACAS) status (28), trajectory change (29), and aircraft operational status (31). A signal with a Mode S Short downlink format does not contains a message and is represented by 0.
|
||||
|`ICA_address`|true|float|N/A|The International Civil Aviation Organization (ICAO) address of the ADS-B signal.|
|
||||
|`binary`|true|string|N/A|The binary signal, either 56 bits (Mode S Short) or 112 bits (Mode S Extended).|
|
||||
|
||||
## 4 Examples
|
||||
|
||||
No `adsb` examples.
|
||||
# ADS-B Extension v1.0.0
|
||||
|
||||
The Automatic Dependent Surveillance-Broadcast (`adsb`) namespace extension
|
||||
defines dynamic properties of ADS-B signals extending `annotations`.
|
||||
|
||||
## 1 Global
|
||||
|
||||
`adsb` does not extend [Global](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#global-object).
|
||||
|
||||
## 2 Captures
|
||||
|
||||
`signal` does not extend [Captures](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#captures-array).
|
||||
|
||||
## 3 Annotations
|
||||
|
||||
The following names are specified in the `adsb` namespace and should be used in
|
||||
the `annotations` object:
|
||||
|
||||
|name|required|type|unit|description|
|
||||
|----|--------------|-------|-------|-----------|
|
||||
|`downlink_format`|true|int|N/A|Indicates if an ADS-B signal is a Mode S Short (11) or a Mode S Extended (17) signal.|
|
||||
|`message_type`|true|int|N/A|Indicates the type of data in a Mode S Extended signal. The message type code range is from 0 to 31. The type of messages are aircraft identification (1-4), surface position (5-8), airborne position with barometric (9-18), airborne velocities (19), airborne position with GNSS (20-22), testing (23), reserved (24-27, 30), Emergency/Airborne Collision Avoidance System (ACAS) status (28), trajectory change (29), and aircraft operational status (31). A signal with a Mode S Short downlink format does not contains a message and is represented by 0.
|
||||
|`ICA_address`|true|float|N/A|The International Civil Aviation Organization (ICAO) address of the ADS-B signal.|
|
||||
|`binary`|true|string|N/A|The binary signal, either 56 bits (Mode S Short) or 112 bits (Mode S Extended).|
|
||||
|
||||
## 4 Examples
|
||||
|
||||
No `adsb` examples.
|
||||
|
||||
@ -1,36 +1,36 @@
|
||||
# Capture Details Extension v1.0.0
|
||||
|
||||
The `capture_details` namespace extension defines static IQ capture parameters
|
||||
extending `captures` and dynamic IQ capture parameters extending `annotations`.
|
||||
|
||||
## 1 Global
|
||||
|
||||
`capture_details` does not extend [Global](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#global-object).
|
||||
|
||||
## 2 Captures
|
||||
|
||||
The following names are specified in the `capture_details` namespace and should
|
||||
be used in the `captures` object:
|
||||
|
||||
|name|required|type|unit|description|
|
||||
|----|--------------|-------|-------|-----------|
|
||||
|`acq_scale_factor`|true|float|N/A|Scale factor of IQ collection from the spectrum analyzer used to convert back to real power.|
|
||||
|`attentuation`|true|float|dB|Input attenuation on the spectrum analyzer.|
|
||||
|`acquisition_bandwidth`|true|float|Hz|Frequency range of the IQ recording.|
|
||||
|`start_capture`|true|string|N/A|Time of the first sample of IQ recording. The time is UTC with the format of `yyyy-mm-ddTHH:MM:SSZ`.|
|
||||
|`stop_capture`|true|string|N/A|Time of the last sample of IQ recording. The time is UTC with the format of `yyyy-mm-ddTHH:MM:SSZ`.|
|
||||
|`source_file`|true|string|N/A|RF IQ recording filename that was used to create the file `N.sigmf-data`. The file `N.sigmf-data` may be the same or an edited versions of the `source_file`.|
|
||||
|`gain`|false|float|dB|Input gain.|
|
||||
|
||||
## 3 Annotations
|
||||
|
||||
The following names are specified in the `capture_details` namespace and should be used in the `annotations` object:
|
||||
|
||||
|name|required|type|unit|description|
|
||||
|----|--------------|-------|-------|-----------|
|
||||
|`SNRdB`|true|float|dB|Root mean square (RMS) calculation of signal to noise ratio (SNR). The calculation is over windows of known signal and no known signal.|
|
||||
|`signal_reference_number`|true|string|N/A|Sequential reference labels for the elements that form the sequence of signals identified in a SigMF dataset file. The format of the string is the filename followed by an index that increases with each decoded signal. An example is a recording dataset file named `N.sigmf-data` would have signal numbers starting with `N-1`, `N-2`, `N-3`...|
|
||||
|
||||
## 4 Examples
|
||||
|
||||
No `capture_details` examples.
|
||||
# Capture Details Extension v1.0.0
|
||||
|
||||
The `capture_details` namespace extension defines static IQ capture parameters
|
||||
extending `captures` and dynamic IQ capture parameters extending `annotations`.
|
||||
|
||||
## 1 Global
|
||||
|
||||
`capture_details` does not extend [Global](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#global-object).
|
||||
|
||||
## 2 Captures
|
||||
|
||||
The following names are specified in the `capture_details` namespace and should
|
||||
be used in the `captures` object:
|
||||
|
||||
|name|required|type|unit|description|
|
||||
|----|--------------|-------|-------|-----------|
|
||||
|`acq_scale_factor`|true|float|N/A|Scale factor of IQ collection from the spectrum analyzer used to convert back to real power.|
|
||||
|`attentuation`|true|float|dB|Input attenuation on the spectrum analyzer.|
|
||||
|`acquisition_bandwidth`|true|float|Hz|Frequency range of the IQ recording.|
|
||||
|`start_capture`|true|string|N/A|Time of the first sample of IQ recording. The time is UTC with the format of `yyyy-mm-ddTHH:MM:SSZ`.|
|
||||
|`stop_capture`|true|string|N/A|Time of the last sample of IQ recording. The time is UTC with the format of `yyyy-mm-ddTHH:MM:SSZ`.|
|
||||
|`source_file`|true|string|N/A|RF IQ recording filename that was used to create the file `N.sigmf-data`. The file `N.sigmf-data` may be the same or an edited versions of the `source_file`.|
|
||||
|`gain`|false|float|dB|Input gain.|
|
||||
|
||||
## 3 Annotations
|
||||
|
||||
The following names are specified in the `capture_details` namespace and should be used in the `annotations` object:
|
||||
|
||||
|name|required|type|unit|description|
|
||||
|----|--------------|-------|-------|-----------|
|
||||
|`SNRdB`|true|float|dB|Root mean square (RMS) calculation of signal to noise ratio (SNR). The calculation is over windows of known signal and no known signal.|
|
||||
|`signal_reference_number`|true|string|N/A|Sequential reference labels for the elements that form the sequence of signals identified in a SigMF dataset file. The format of the string is the filename followed by an index that increases with each decoded signal. An example is a recording dataset file named `N.sigmf-data` would have signal numbers starting with `N-1`, `N-2`, `N-3`...|
|
||||
|
||||
## 4 Examples
|
||||
|
||||
No `capture_details` examples.
|
||||
|
||||
@ -1,30 +1,30 @@
|
||||
# RFML Extension v1.0.0
|
||||
|
||||
The radio frequency machine learning (`rfml`) namespace extension defines the
|
||||
protocol, manufacturer, and device labeling scheme for RF bursts.
|
||||
|
||||
## 1 Global
|
||||
|
||||
The following names are specified in the `rfml` namespace and should be used in
|
||||
the `global` object:
|
||||
|
||||
|name|required|type|unit|description|
|
||||
|----|--------------|-------|-------|-----------|
|
||||
|`label_hierarchy`|true|array|N/A|Defines hierarchy of the fields in the label array.|
|
||||
|
||||
## 2 Captures
|
||||
|
||||
`rfml` does not extend [Captures](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#captures-array).
|
||||
|
||||
## 3 Annotations
|
||||
|
||||
The following names are specified in the `rfml` namespace and should be used in
|
||||
the `annotations` object:
|
||||
|
||||
|name|required|type|unit|description|
|
||||
|----|--------------|-------|-------|-----------|
|
||||
|`label`|true|array|N/A|An array of hierarchical labels that describe this annotation. The label `device_type` is the type of RF transmitter or signal source. The label `manufacturer_ID` is the manufacturer of the transmitter. The label `device_ID` is the source of the RF signal.|
|
||||
|
||||
## 4 Examples
|
||||
|
||||
No `rfml` examples.
|
||||
# RFML Extension v1.0.0
|
||||
|
||||
The radio frequency machine learning (`rfml`) namespace extension defines the
|
||||
protocol, manufacturer, and device labeling scheme for RF bursts.
|
||||
|
||||
## 1 Global
|
||||
|
||||
The following names are specified in the `rfml` namespace and should be used in
|
||||
the `global` object:
|
||||
|
||||
|name|required|type|unit|description|
|
||||
|----|--------------|-------|-------|-----------|
|
||||
|`label_hierarchy`|true|string array|N/A|Defines hierarchy of the fields in the label array.|
|
||||
|
||||
## 2 Captures
|
||||
|
||||
`rfml` does not extend [Captures](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#captures-array).
|
||||
|
||||
## 3 Annotations
|
||||
|
||||
The following names are specified in the `rfml` namespace and should be used in
|
||||
the `annotations` object:
|
||||
|
||||
|name|required|type|unit|description|
|
||||
|----|--------------|-------|-------|-----------|
|
||||
|`label`|true|string array|N/A|An array of hierarchical labels that describe this annotation. The label `device_type` is the type of RF transmitter or signal source. The label `manufacturer_ID` is the manufacturer of the transmitter. The label `device_ID` is the source of the RF signal.|
|
||||
|
||||
## 4 Examples
|
||||
|
||||
No `rfml` examples.
|
||||
|
||||
Loading…
Reference in new issue