Skip to content

Commit d9faf5d

Browse files
committed
updated that largely untested on linux
1 parent 31a6925 commit d9faf5d

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

‎hackrfpy/README.md‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
**An Unofficial Python CLI + Scripting Wrapper for the HackRF One that works on Windows**
44

5+
[![Tests](https://github.com/LC-Linkous/hackRF_python/actions/workflows/tests.yml/badge.svg)](https://github.com/LC-Linkous/hackRF_python/actions/workflows/tests.yml)
56
[![PyPI version](https://badge.fury.io/py/hackrfpy.svg)](https://badge.fury.io/py/hackrfpy)
67
[![Python versions](https://img.shields.io/pypi/pyversions/hackrfpy.svg)](https://pypi.org/project/hackrfpy/)
78
[![PyPI - Wheel](https://img.shields.io/pypi/wheel/hackrfpy.svg)](https://pypi.org/project/hackrfpy/)
@@ -25,6 +26,14 @@ This repository uses official resources and documentation but is **NOT** endorse
2526
- **Error Handling** — a typed exception hierarchy and verbose output options
2627
- **CLI** — the `hrf` command-line shell over the full API
2728

29+
## Platform support
30+
31+
hackrfpy is developed and tested on **Windows**. Running the `hackrf-tools` binaries as subprocesses — rather than binding to `libhackrf` through a C extension — is a deliberate choice so that no compiler or build step is required, which is the main friction point for using a HackRF on Windows.
32+
33+
The library is *written* to be cross-platform: binary discovery goes through `shutil.which`, and process control uses `SIGINT` on POSIX and `CTRL_BREAK` on Windows. The `hackrf-tools` binaries are themselves native to Linux and macOS, and the wrapper's non-hardware mechanics (binary resolution, process lifecycle, sweep streaming, IQ decode) pass in CI on Linux. So the library is **expected** to work on Linux and macOS.
34+
35+
However, it has **not yet been verified against a real HackRF board** on Linux or macOS. Treat those platforms as **experimental** for now. If you try it there, please [open an issue](https://github.com/LC-Linkous/hackRF_python/issues) to report success or trouble — confirmation from real hardware is exactly what's needed to promote them to supported.
36+
2837
## Installation
2938

3039
```bash
@@ -39,13 +48,13 @@ pip install "hackrfpy[plotting]"
3948

4049
Python 3.11+ is required.
4150

42-
**You also need the `hackrf-tools` binaries**, which are *not* a pip dependency — they are installed at the OS level:
51+
**You also need the `hackrf-tools` binaries**, which are *not* a pip dependency — they are installed separately at the OS level. hackrfpy locates them on your `PATH` (or via a configured `tools_dir`).
4352

44-
- **Linux:** `sudo apt install hackrf` (or your distribution's equivalent)
45-
- **macOS:** `brew install hackrf`
46-
- **Windows:** the tools are published as CI build artifacts under the [Actions tab](https://github.com/greatscottgadgets/hackrf/actions) of the HackRF repo; see the main repository README for the step-by-step.
53+
- **Windows** — *tested.* The tools are published as CI build artifacts under the [Actions tab](https://github.com/greatscottgadgets/hackrf/actions) of the HackRF repo; see the main repository README for the step-by-step.
54+
- **Linux** — *experimental, see [Platform support](#platform-support).* `sudo apt install hackrf` (or your distribution's equivalent).
55+
- **macOS** — *experimental, see [Platform support](#platform-support).* `brew install hackrf`.
4756

48-
Verify the install with `hackrf_info`.
57+
Verify the tools are installed with `hackrf_info`.
4958

5059
## Quick Start
5160

@@ -138,6 +147,7 @@ For comprehensive documentation, the full method reference, the CLI reference, a
138147
This is an unofficial community project. Contributions welcome!
139148

140149
- Report bugs and request features on [GitHub](https://github.com/LC-Linkous/hackRF_python)
150+
- If you run the library on Linux or macOS, reports from real hardware are especially welcome (see [Platform support](#platform-support))
141151
- For device information and OFFICIAL resources, see [https://hackrf.readthedocs.io/](https://hackrf.readthedocs.io/)
142152
- Please do **NOT** request features or report bugs to Great Scott Gadgets or the HackRF project! This is an unofficial project and they do not maintain it.
143153

0 commit comments

Comments
 (0)