HackRF host tools + firmware + libhackrf (mirror of greatscottgadgets/hackrf)

Find a file

straithe 44244f525d Add documentation request issue template		2022-09-27 03:12:36 -04:00
.github	Add documentation request issue template	2022-09-27 03:12:36 -04:00
ci-scripts	update test device path for test server	2022-09-22 20:41:21 -06:00
docs	document hardware triggering	2022-09-21 10:36:06 -04:00
firmware	Merge pull request #1172 from martinling/amp-startup	2022-09-21 15:19:04 -04:00
hardware	HackRF One: Change fabrication attr for U4, 17-19, 21 to SMT	2021-10-05 17:11:15 -06:00
host	If TX callback sets valid_length to 0, treat as end of data.	2022-09-23 12:46:49 +01: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	Update docs	2021-12-28 18:27:01 -05:00
.gitmodules	added gsg-kicad-lib submodule	2016-07-14 10:27:28 -06:00
appveyor.yml	Revert "Cleanup of host software CMake build system (#664 )"	2021-12-08 16:59:05 -07: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	Jenkins CI (#1102 )	2022-06-08 13:26:28 -04:00
Jenkinsfile	Jenkins CI (#1102 )	2022-06-08 13:26:28 -04:00
Readme.md	update pdf building documentation	2022-09-23 13:53:10 -04: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.

(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 documenation 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 One 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 in the FAQ.

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.