github/hackrf
github/hackrf
1
0
Fork 0
mirror of https://github.com/greatscottgadgets/hackrf.git synced 2026-03-27 22:20:19 +00:00
Code Issues Projects Releases Packages Activity
low cost software radio platform
3,210 commits 16 branches 18 tags 91 MiB
  • KiCad 69.8%
  • C 25.7%
  • Python 2.3%
  • CMake 0.9%
  • Assembly 0.7%
  • Other 0.5%
Find a file
Exact
Michael Ossmann 99cdefb761 Clean up vestiges of Jellybean
2026-03-27 18:07:35 -04:00
.github Add support for HackRF Pro (code name: Praline) 2025-11-24 20:53:41 -05:00
ci-scripts Always use PLL A 2026-03-24 12:24:50 -04:00
docs Update firmware instructions for HackRF Pro 2026-01-04 20:39:56 -05:00
firmware Clean up vestiges of Jellybean 2026-03-27 18:07:35 -04:00
hardware HackRF One: update version to 10 2024-02-07 13:29:41 -05:00
host Remove fractional sample rate radio register 2026-03-10 09:40:50 -04:00
tools Add helper script to add missing braces using clang-tidy. 2022-08-03 23:46:46 +01:00
.clang-format Add clang-format configuration and reformat script. 2022-08-03 23:43:08 +01:00
.gitattributes Fix KiCad files being detected as Eagle files 2015-07-11 11:51:56 +01:00
.gitignore * Fix quoting issue causing bad library include path, add install step hackrf-tools. 2024-02-29 18:39:03 -06:00
.gitmodules added gsg-kicad-lib submodule 2016-07-14 10:27:28 -06:00
.readthedocs.yaml docs: update files for RTD 2023-12-07 15:43:32 -05:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#1009) 2021-12-06 13:38:23 -05:00
COPYING readme and license files 2012-03-16 09:59:45 -06:00
Dockerfile Add hackrf_test.py (#1587) 2025-10-31 13:51:09 -04:00
Jenkinsfile improve timeout handling 2026-03-02 19:00:19 -07:00
Readme.md Change README help link from FAQ to troubleshooting 2026-01-27 00:15:59 +00:00
TRADEMARK transferred trademark from Michael Ossmann to Great Scott Gadgets 2016-06-26 09:53:43 -06:00

Readme.md

HackRF

This repository contains hardware designs and software for HackRF, a low cost, open source Software Defined Radio platform.

HackRF One

(photo by fd0 from https://github.com/fd0/hackrf-one-pictures)

principal author: Michael Ossmann mike@ossmann.com

Information on HackRF and purchasing HackRF: https://greatscottgadgets.com/hackrf/

Documentation

Documentation for HackRF can be viewed on Read the Docs. The raw documentation files for HackRF are in the docs folder in this repository and can be built locally by installing Sphinx Docs and running make html. Documentation changes can be submitted through pull request and suggestions can be made as GitHub issues.

To create a PDF of the HackRF documentation from the HackRF repository while on Ubuntu:

  • run sudo apt install latexmk texlive-latex-extra
  • navigate to hackrf/docs on command line
  • run the command make latex
  • run the command make latexpdf

Getting Help

Before asking for help with HackRF, check to see if your question is listed on the troubleshooting page.

For assistance with HackRF general use or development, please look at the issues on the GitHub project. This is the preferred place to ask questions so that others may locate the answer to your question in the future.

We invite you to join our community discussions on Discord. Note that while technical support requests are welcome here, we do not have support staff on duty at all times. Be sure to also submit an issue on GitHub if you've found a bug or if you want to ensure that your request will be tracked and not overlooked.

If you wish to see past discussions and questions about HackRF, you may also view the mailing list archives.

GitHub issues on this repository that are labelled "technical support" by Great Scott Gadgets employees can expect a response time of two weeks. We currently do not have expected response times for other GitHub issues or pull requests for this repository.