You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit d9faf5d
Browse filesBrowse the repository at this point in the historyBrowse files
@@ -25,6 +26,14 @@ This repository uses official resources and documentation but is **NOT** endorse
25
26
-**Error Handling** — a typed exception hierarchy and verbose output options
26
27
-**CLI** — the `hrf` command-line shell over the full API
27
28
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.
**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`).
43
52
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`.
47
56
48
-
Verify the install with `hackrf_info`.
57
+
Verify the tools are installed with `hackrf_info`.
49
58
50
59
## Quick Start
51
60
@@ -138,6 +147,7 @@ For comprehensive documentation, the full method reference, the CLI reference, a
138
147
This is an unofficial community project. Contributions welcome!
139
148
140
149
- 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))
141
151
- For device information and OFFICIAL resources, see [https://hackrf.readthedocs.io/](https://hackrf.readthedocs.io/)
142
152
- 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.
0 commit comments