|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to hackrfpy are documented here. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | +Work on the current development branch. Entries move to a versioned section on |
| 11 | +release. |
| 12 | + |
| 13 | +### Added |
| 14 | +- Continuous integration: GitHub Actions workflow running the test suite across |
| 15 | + Windows, Linux, and macOS on Python 3.11-3.13, plus a ruff + mypy lint job. |
| 16 | +- CLI test suite covering argument parsing, the mode state file, preset |
| 17 | + resolution, `info`/`detect`/`doctor`, `rx`/`tx`/`sweep` dispatch, and the |
| 18 | + module-level exit-code mapping. Overall coverage raised from 73% to 86% |
| 19 | + (`cli.py` from 12% to ~98%). |
| 20 | +- Community health files: `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, |
| 21 | + `SECURITY.md`, issue templates, and a pull request template. |
| 22 | + |
| 23 | +### Changed |
| 24 | +- Packaging classifiers: removed the contradictory `Operating System :: |
| 25 | + OS Independent` (the library shells out to the Windows `hackrf-tools` |
| 26 | + binaries and Linux/macOS operation is unverified), leaving `Operating System |
| 27 | + :: Microsoft :: Windows`. Development status raised from `3 - Alpha` to |
| 28 | + `5 - Production/Stable` to match the 1.0.0 release. |
| 29 | + |
| 30 | +### Fixed |
| 31 | +- `CITATION.cff` version and release date corrected to `1.0.0` / `2026-06-16`, |
| 32 | + aligning the citation metadata with `pyproject.toml` and the tagged release. |
| 33 | + |
| 34 | +<!-- |
| 35 | +Roadmap for this branch (append entries above as each lands): |
| 36 | + - Fix: cap the _Process stdout/stderr drain buffers (unbounded growth on |
| 37 | + long-lived RX/TX handles). |
| 38 | + - Fix: validate the transmit source file exists before arming TX mode. |
| 39 | + - Fix: declare the `hackrf` namespace in SigMF `core:extensions`. |
| 40 | + - Changed: route library diagnostics through the `logging` module instead of |
| 41 | + print(); `warn`/`print_message` become thin wrappers. NOTE breaking-ish: |
| 42 | + library users who set verbose=True must configure a logging handler to see |
| 43 | + info-level messages (the CLI configures this automatically). |
| 44 | + - Added: type annotations across the public API; mypy promoted to a CI gate |
| 45 | + (makes the shipped py.typed marker accurate). |
| 46 | + - Docs: note that a single HackRF instance is not safe to share across |
| 47 | + threads (deferred pending broader testing). |
| 48 | +--> |
| 49 | + |
| 50 | +## [1.0.0] - 2026-06-16 |
| 51 | + |
| 52 | +Initial public release. |
| 53 | + |
| 54 | +### Added |
| 55 | +- Python wrapper and non-GUI command-line tool (`hrf`) for the HackRF One, |
| 56 | + driving the `hackrf-tools` binaries directly (no libhackrf bindings). |
| 57 | +- Receive: bounded and streaming capture, with decode to `complex64` and |
| 58 | + self-describing SigMF (`.sigmf-meta`) sidecars. |
| 59 | +- Spectrum sweep with streaming CSV parsing. |
| 60 | +- Transmit: file playback and constant-wave source, guarded by an explicit |
| 61 | + operating-mode gate (transmit refuses unless the instance is switched to TX |
| 62 | + mode, which emits a one-time safety banner) and a TX gain ceiling. |
| 63 | +- Device management passthroughs (clock, Opera Cake, SPI flash, debug) and |
| 64 | + preflight `info` / `detect` / `doctor` helpers. |
| 65 | +- Cross-platform process lifecycle handling with best-effort clean interrupt |
| 66 | + (SIGINT on POSIX, CTRL_BREAK on Windows) and an atexit backstop for live |
| 67 | + RX/TX handles. |
| 68 | +- Validation layer with hard-range checks, gain snapping to real device steps, |
| 69 | + and a parameter readback (`last_params`) reflecting the values actually used. |
| 70 | + |
| 71 | +[Unreleased]: https://github.com/LC-Linkous/hackRF_python/compare/V1.0.0...HEAD |
| 72 | +[1.0.0]: https://github.com/LC-Linkous/hackRF_python/releases/tag/V1.0.0 |
0 commit comments