cleanup extension files

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.

@ -17,8 +17,8 @@ The following names are specified in the `antenna` namespace and should be used
|`low_frequency`|false|float|Hz|Low frequency of operational range.|
|`high_frequency`|false|float|Hz|High frequency of operational range.|
|`gain`|false|float|dBi|Antenna gain in direction of maximum radiation or reception.|
|`horizontal_gain_pattern`|false|array of floats|dBi|Antenna gain pattern in horizontal plane from 0 to 359 degrees in 1 degree steps.|
|`vertical_gain_pattern`|false|array of floats|dBi|Antenna gain pattern in vertical plane from -90 to +90 degrees in 1 degree steps.|
|`horizontal_gain_pattern`|false|float array|dBi|Antenna gain pattern in horizontal plane from 0 to 359 degrees in 1 degree steps.|
|`vertical_gain_pattern`|false|float array|dBi|Antenna gain pattern in vertical plane from -90 to +90 degrees in 1 degree steps.|
|`horizontal_beam_width`|false|float|degrees|Horizontal 3-dB beamwidth.|
|`vertical_beam_width`|false|float|degrees|Vertical 3-dB beamwidth.|
|`cross_polar_discrimination`|false|float|N/A|Cross-polarization discrimination.|

@ -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.

@ -33,7 +33,7 @@ the new fields to be upstreamed into this canonical extension.
|name|required|type|description|
|----|--------|----|-----------|
|`type`|false|string|[type](signal.sigmf-ext.md#the-type-field)|
|`class`|false|string|[class](signal.sigmf-ext.md#the-class-field)|
|`mod_class`|false|string|[mod_class](signal.sigmf-ext.md#the-mod_class-field)|
|`standard`|false|string|Communication standard (e.g., 802.11ac)|
|`carrier_variant`|false|string|[carrier variant](signal.sigmf-ext.md#the-carrier_variant-field)|
|`symbol_variant`|false|string|[symbol variant](signal.sigmf-ext.md#the-symbol_variant-field)|
@ -55,9 +55,9 @@ The `type` field can have the following values:
|`analog`|analog modulation scheme|
|`digital`|digital modulation scheme|
#### 3.1.2 The `class` Field
#### 3.1.2 The `mod_class` Field
The `class` field can have the following values:
The `mod_class` field can have the following values:
|value|description|
|----|-------|
@ -189,7 +189,7 @@ Here is an example of a relatively simple modulation label, which describes a
"core:label": "FM TDD",
"signal:detail": {
"type": "analog",
"class": "fm",
"mod_class": "fm",
"duplexing": "tdd",
"bandwidth": 10000.0
}
@ -228,7 +228,7 @@ Here is a more complex example that describes an LTE 5 MHz SC-OFDMA downlink:
"core:label": "LTE 12",
"signal:detail": {
"type": "digital",
"class": "qam",
"mod_class": "qam",
"carrier_variant": "single_carrier",
"order": 16,
"multiple_access": "ofdma",
@ -248,7 +248,7 @@ A class variant example describing a pi/4-DQPSK signal:
"core:label": "pi/4-DQPSK",
"signal:detail": {
"type": "digital",
"class": "psk",
"mod_class": "psk",
"order": 4,
"symbol_variant": "differential",
"class_variant": "pi/4"

@ -1,39 +1,39 @@
## Wi-Fi Extension v1.0.0
The `wifi`namespace extension defines dynamic Wi-Fi burst parameters extending
`annotations`.
## 1 Global
`wifi` does not extend [Global](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#global-object).
## 2 Captures
`wifi` 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 `wifi` namespace and should be used in the `annotations` object:
|name|required|type|unit|description|
|----|--------------|-------|-------|-----------|
|`standard`|true|string|N/A|Wireless standard of captured signal e.g. 802.11a/g.|
|`frame_type_phy`|true|string|N/A|Physical layer specification e.g. non-high throughput or very-high throughput.|
|`channel`|true|int|N/A|Wi-Fi channel of captured signal|
|`start_time_s`|true|float|seconds|Start time of RF burst (relative time to start time of main capture file).|
|`stop_time_s`|true|float|seconds|Stop time of RF burst (relative time to start time of main capture file).|
|`frame_duration_s`|true|float|seconds|Duration of RF burst (`stop_time_s` `start_time_s`).|
|`MCS`|true|int|N/A|Wi-Fi signal Modulation and Coding Scheme (MCS).|
|`MAC_frame_type`|true|string|N/A|Wi-Fi MAC frame type.|
|`MAC_ta`|true|string|N/A|Wi-Fi transmitter MAC address.|
|`MAC_ra`|true|string|N/A|Wi-Fi receiver MAC address.|
|`manufacturer_ta`|true|string|N/A|Manufacturer of the Wi-Fi transmitter.|
|`MAC_frame`|true|string|N/A|Wi-Fi MAC frame data without CRC.|
|`CRC`|true|string|N/A|Wi-Fi MAC frame CRC.|
|`start_of_packet`|true|float|samples|Starting sample of captured Wi-Fi burst.|
|`stop_of_packet`|true|float|samples|Stopping sample of captured Wi-Fi burst.|
|`number_of_samples_in_packet`|true|float|samples|Number of downsampled IQ samples in Wi-Fi burst.|
## 4 Examples
No `wifi` examples.
## Wi-Fi Extension v1.0.0
The `wifi`namespace extension defines dynamic Wi-Fi burst parameters extending
`annotations`.
## 1 Global
`wifi` does not extend [Global](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#global-object).
## 2 Captures
`wifi` 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 `wifi` namespace and should be used in the `annotations` object:
|name|required|type|unit|description|
|----|--------------|-------|-------|-----------|
|`standard`|true|string|N/A|Wireless standard of captured signal e.g. 802.11a/g.|
|`frame_type_phy`|true|string|N/A|Physical layer specification e.g. non-high throughput or very-high throughput.|
|`channel`|true|int|N/A|Wi-Fi channel of captured signal|
|`start_time_s`|true|float|seconds|Start time of RF burst (relative time to start time of main capture file).|
|`stop_time_s`|true|float|seconds|Stop time of RF burst (relative time to start time of main capture file).|
|`frame_duration_s`|true|float|seconds|Duration of RF burst (`stop_time_s` - `start_time_s`).|
|`MCS`|true|int|N/A|Wi-Fi signal Modulation and Coding Scheme (MCS).|
|`MAC_frame_type`|true|string|N/A|Wi-Fi MAC frame type.|
|`MAC_ta`|true|string|N/A|Wi-Fi transmitter MAC address.|
|`MAC_ra`|true|string|N/A|Wi-Fi receiver MAC address.|
|`manufacturer_ta`|true|string|N/A|Manufacturer of the Wi-Fi transmitter.|
|`MAC_frame`|true|string|N/A|Wi-Fi MAC frame data without CRC.|
|`CRC`|true|string|N/A|Wi-Fi MAC frame CRC.|
|`start_of_packet`|true|float|samples|Starting sample of captured Wi-Fi burst.|
|`stop_of_packet`|true|float|samples|Stopping sample of captured Wi-Fi burst.|
|`number_of_samples_in_packet`|true|float|samples|Number of downsampled IQ samples in Wi-Fi burst.|
## 4 Examples
No `wifi` examples.

Loading…
Cancel
Save