Skip to content

Commit

Permalink
Changelog, Links, Versioning (#311)
Browse files Browse the repository at this point in the history
* Add CHANGELOG.md
* Fix Repository & External Links
* Update all example versions to v1.2.0 commensurate w/latest tag.
  • Loading branch information
Teque5 authored Apr 14, 2024
1 parent ce12b22 commit 362cd57
Show file tree
Hide file tree
Showing 13 changed files with 165 additions and 59 deletions.
109 changes: 109 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Changelog

All notable changes will be documented here for easy reference.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- CHANGELOG

## [1.2.0] - 2024-01-13

### Added

- Core specification
- Optional `uuid` in `annotations` object
- SVG version of logo

### Changed

- Clarify optional Extensions
- Spatial extension
- Add range-rate to bearing object
- Add aperture_rotation field

### Removed

- Python module moved to separate repository [sigmf-python](https://github.com/sigmf/sigmf-python).

## [1.1.0] - 2023-01-12

### Changed

- Core specification
- Deprecate tuples in favor of JSON objects
- Clarify rules related to SigMF archives
- Fix table of contents errors
- Application compliance language clarification

## [1.0.1] - 2022-12-03

### Added

- Specifically point to the [NTIA extensions](https://github.com/NTIA/sigmf-ns-ntia) as good references.
- Spatial extension

### Changed

- Core specification
- Add examples
- Clarification of field types
- Conforming / compliant language

### Removed

- Undocumented & incomplete RFML extension

## [1.0.0] - 2022-01-05

### Added

- Core Specification
- Definition of Dataset
- GeoJSON to store locations in `geolocation` field
- New `header_bytes` and `trailing_bytes` field
- New `metadata_only` field
- Define SigMF compliance
- Add Collection Format
- Official logo & example `.sigmf` files
- Extensions
- ADS-B
- Antenna
- Capture Details
- RFML
- Signal
- WiFi
- Code of conduct

### Changed

- Core specification rewrite
- Descriptions for all fields
- Inclusion of block diagrams
- Clarification of data types
- Formalize extension definitions & versioning
- Formal license inclusion

## [0.0.1] - 2018-01-05

### Added

Initial release.

- Core specification
- Citation information
- CC-BY-SA-4.0 License
- Modulation extension
- Volatile extension


[unreleased]: https://github.com/sigmf/SigMF/compare/v1.2.0...HEAD
[1.2.0]: https://github.com/sigmf/SigMF/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/sigmf/SigMF/compare/v1.0.1...v1.1.0
[1.1.0]: https://github.com/sigmf/SigMF/compare/v1.0.1...v1.1.0
[1.0.1]: https://github.com/sigmf/SigMF/compare/v0.0.1...v1.0.1
[0.0.1]: https://github.com/sigmf/SigMF/tree/v0.0.1
4 changes: 1 addition & 3 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Contributor Covenant Code of Conduct

This Code of Conduct is also available [here on the GNU Radio
wiki](https://wiki.gnuradio.org/index.php/Code_of_Conduct).
This Code of Conduct is a mirror of [the GNU Radio governance Code of Conduct](https://github.com/gnuradio/gr-governance/blob/main/CODE_OF_CONDUCT.md).

## Our Pledge

Expand Down Expand Up @@ -77,4 +76,3 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center"><img src="https://github.com/gnuradio/SigMF/blob/sigmf-v1.x/logo/sigmf_logo.svg" alt="Rendered SigMF Logo"/></p>
<p align="center"><img src="https://github.com/sigmf/SigMF/blob/v1.2.0/logo/sigmf_logo.svg" alt="Rendered SigMF Logo"/></p>

# Signal Metadata Format (SigMF)

Expand Down Expand Up @@ -35,7 +35,7 @@ Together these files represent one recording, such as `example.sigmf-data` and
"core:sample_rate": 1000000,
"core:hw": "PlutoSDR with 915 MHz whip antenna",
"core:author": "Art Vandelay",
"core:version": "1.0.0"
"core:version": "1.2.0"
},
"captures": [
{
Expand All @@ -51,19 +51,19 @@ Together these files represent one recording, such as `example.sigmf-data` and

There are at least four ways you can use SigMF today, thanks to the community-supported projects:

1. Within **Python**, using the [official SigMF Python package **sigmf**](https://github.com/sigmf/sigmf-python) available from pip: `pip install sigmf`
2. Within **C++** using the [header-only C++ library **libsigmf**](https://github.com/deepsig/libsigmf) maintained by DeepSig
3. Within **GNU Radio** using the [out-of-tree module **gr-sigmf**](https://github.com/skysafe/gr-sigmf) maintained by SkySafe
4. Manually, using our examples and the [spec itself](sigmf-spec.md), even if it's simply editing a text file
1. Within **Python**, using the [official SigMF Python package **sigmf**](https://github.com/sigmf/sigmf-python) available from pip: `pip install sigmf`.
2. Within **C++** using the [header-only C++ library **libsigmf**](https://github.com/sigmf/libsigmf).
3. Within **GNU Radio** using the built-in SigMF [source](https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/grc/blocks_sigmf_source_minimal.block.yml) & [sink](https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/grc/blocks_sigmf_sink_minimal.block.yml) blocks.
4. Manually, using our examples and the [spec itself](sigmf-spec.md), even if it's simply editing a text file.


## Contributing

The SigMF standards effort is organized entirely within this Github repository.
Questions, suggestions, bug reports, etc., are discussed in [the issue
tracker](https://github.com/gnuradio/SigMF/issues), feel free to create
tracker](https://github.com/sigmf/SigMF/issues), feel free to create
a new issue and provide your input, even if it's not a traditional issue.
Changes to the specification only occur through [Pull Requests](https://github.com/gnuradio/SigMF/pulls).
Changes to the specification only occur through [Pull Requests](https://github.com/sigmf/SigMF/pulls).
This ensures that the history and background of all discussions and changes are maintained for posterity.

There is also a SigMF chat room on [GNU Radio's Matrix chat server](https://wiki.gnuradio.org/index.php/Chat)
Expand All @@ -76,7 +76,7 @@ discussions, the more useful the standard is likely to be!

## Extensions

The "Core" SigMF standard is intentionally kept limited in scope, additional metadata fields can be added through [SigMF Extensions](https://github.com/gnuradio/SigMF/blob/sigmf-v1.x/sigmf-spec.md#extension-namespaces). For example, the [signal extension](https://github.com/gnuradio/SigMF/blob/sigmf-v1.x/extensions/signal.sigmf-ext.md) provides a standard way to specify modulation schemes and other attributes of wireless comms signals. Several general purpose canonical extensions live within this repository directly in the [extensions directory](https://github.com/gnuradio/SigMF/tree/sigmf-v1.x/extensions), while others are maintained by third parties. Below are some popular sources for SigMF extensions. To have your extension reviewed for inclusion on this list, please open a PR adding the repository to the list below:
The "Core" SigMF standard is intentionally kept limited in scope, additional metadata fields can be added through [SigMF Extensions](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#extension-namespaces). For example, the [signal extension](https://github.com/sigmf/SigMF/blob/main/extensions/signal.sigmf-ext.md) provides a standard way to specify modulation schemes and other attributes of wireless comms signals. Several general purpose canonical extensions live within this repository directly in the [extensions directory](https://github.com/sigmf/SigMF/tree/main/extensions), while others are maintained by third parties. Below are some popular sources for SigMF extensions. To have your extension reviewed for inclusion on this list, please open a PR adding the repository to the list below:

* [SigMF's Community Extension Repository](https://github.com/sigmf/community-extensions)
* [NTIA's series of extensions](https://github.com/NTIA/sigmf-ns-ntia)
Expand Down
4 changes: 2 additions & 2 deletions extensions/adsb.sigmf-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ 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).
`adsb` does not extend [Global](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#global-object).

## 2 Captures

`signal` does not extend [Captures](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#captures-array).
`signal` does not extend [Captures](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#captures-array).

## 3 Annotations

Expand Down
3 changes: 1 addition & 2 deletions extensions/antenna.sigmf-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The following names are specified in the `antenna` namespace and should be used

## 2 Captures

`antenna` does not extend [Captures](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#captures-array).
`antenna` does not extend [Captures](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#captures-array).

## 3 Annotations

Expand All @@ -55,4 +55,3 @@ The following fields are specificed in SigMF Collections.
## 5 Examples

No `antenna` examples.

2 changes: 1 addition & 1 deletion extensions/capture_details.sigmf-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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).
`capture_details` does not extend [Global](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#global-object).

## 2 Captures

Expand Down
4 changes: 2 additions & 2 deletions extensions/signal.sigmf-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ the attributes of wireless communications signals and their emitters.

## 1 Global

`signal` does not extend [Global](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#global-object).
`signal` does not extend [Global](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#global-object).

## 2 Captures

`signal` does not extend [Captures](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#captures-array).
`signal` does not extend [Captures](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#captures-array).


## 3 Annotations
Expand Down
2 changes: 1 addition & 1 deletion extensions/spatial.sigmf-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ element recording:
```JSON
{
"collection": {
"core:version": "1.0.0",
"core:version": "1.2.0",
"core:extensions" : [
{
"name": "spatial",
Expand Down
6 changes: 3 additions & 3 deletions extensions/traceability.sigmf-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Format (SigMF) specification. This extension provides traceability information f

## 1 Global

`traceability` extends the [Global](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#global-object) object.
`traceability` extends the [Global](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#global-object) object.

The following fields are added to the `global` object:

Expand Down Expand Up @@ -33,11 +33,11 @@ The following fields are added to the `global` object:

## 2 Captures

`traceability` does not extend the [Captures](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#captures-array) object.
`traceability` does not extend the [Captures](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#captures-array) object.

## 3 Annotations

`traceability` extends the [Annotations](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#annotations-object) object.
`traceability` extends the [Annotations](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#annotations-object) object.

The following fields are added to each annotation in the `annotations` array:

Expand Down
4 changes: 2 additions & 2 deletions extensions/wifi.sigmf-ext.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ The `wifi`namespace extension defines dynamic Wi-Fi burst parameters extending

## 1 Global

`wifi` does not extend [Global](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#global-object).
`wifi` does not extend [Global](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#global-object).

## 2 Captures

`wifi` does not extend [Captures](https://github.com/gnuradio/SigMF/blob/master/sigmf-spec.md#captures-array).
`wifi` does not extend [Captures](https://github.com/sigmf/SigMF/blob/main/sigmf-spec.md#captures-array).

## 3 Annotations

Expand Down
4 changes: 2 additions & 2 deletions logo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The intent of these files is to both serve as a nice visual and an exemplar meta

## Additional Versions

[The full logo archive](https://github.com/gnuradio/SigMF/wiki/logo/sigmf_logo_files.zip) contains a variety of versions of the logo for multiple use-cases.
[The full logo archive](https://github.com/sigmf/SigMFwiki/logo/sigmf_logo_files.zip) contains a variety of versions of the logo for multiple use-cases.

* `sigmf_logo_fullband` is the unfiltered logo at 192 KHz sample rate.
* `logo_*.wav` are audio files for playback without converstion from SigMF.
Expand All @@ -25,4 +25,4 @@ The SigMF logo was created with the following steps:
0) Initial render in [Blender](https://www.blender.org/) with as simple geometry as possible. The `stl` is a very simplified and tweaked version of the [Eurostile](https://en.wikipedia.org/wiki/Eurostile) font.
1) A timeline was created with [OsciStudio](https://oscilloscopemusic.com/oscistudio.php) with various modulated artifacts over a 6 second period.
2) The lower 48KHz version was then lowpass filtered and adjusted for -14 LUFS in [Audacity](https://www.audacityteam.org/) per the [EBU R 128](https://en.wikipedia.org/wiki/EBU_R_128) loudness spec.
3) Original metadata was added with the [SigMF Python module](https://github.com/gnuradio/SigMF).
3) Original metadata was added with the [SigMF Python module](https://github.com/sigmf/SigMF).
2 changes: 1 addition & 1 deletion logo/sigmf_logo.sigmf-meta
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"core:recorder": "OsciStudio & Audacity",
"core:sample_rate": 48000,
"core:sha512": "69893900f22de266485031b584c28fc3a0d4f361acd1d623698ed258e616e082d3d398af40d2ce805a804864cb0be631dba060f7410a27c0c2e497becdca53bf",
"core:version": "1.0.0"
"core:version": "1.2.0"
},
"captures": [
{
Expand Down
Loading

0 comments on commit 362cd57

Please sign in to comment.