Mirrors/hackrf
2
0
Fork 0
mirror of https://github.com/greatscottgadgets/hackrf.git synced 2026-02-19 16:22:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
3,148 Commits 12 Branches 18 Tags
main
Commit Graph

88 Commits

Author SHA1 Message Date
Michael Ossmann
203fd9229b Update firmware instructions for HackRF Pro 2026-01-04 20:39:56 -05:00
Michael Ossmann
95911ee6aa Clarify HackRF Pro LED descriptions 2026-01-04 19:57:54 -05:00
Michael Ossmann
25420ef7c3 Add line breaks after block diagrams 2026-01-04 19:52:30 -05:00
Michael Ossmann
ea420002f5 Clarify end plate design location 2026-01-04 19:48:02 -05:00
Michael Ossmann
cb9d1c9472 Merge pull request #1595 from martinling/windows-build-docs 
Update documentation on building for Windows.
 2026-01-04 12:42:39 -05:00
Martin Ling
4228637fb6 Add HackRF Pro block diagram. 2025-12-20 17:52:27 +00:00
Martin Ling
ed221e65a9 Update hardware documentation to cover HackRF Pro. 2025-12-20 17:52:27 +00:00
Martin Ling
6609bc6d70 Update documentation on building for Windows. 2025-10-04 04:29:40 +01:00
dependabot[bot]
3c7cc02a5e build(deps): bump jinja2 from 3.1.5 to 3.1.6 in /docs 
Bumps [jinja2](https://github.com/pallets/jinja) from 3.1.5 to 3.1.6.
- [Release notes](https://github.com/pallets/jinja/releases)
- [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst)
- [Commits](https://github.com/pallets/jinja/compare/3.1.5...3.1.6)

---
updated-dependencies:
- dependency-name: jinja2
  dependency-version: 3.1.6
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
 2025-09-19 00:44:43 +00:00
philippuhl
a757698bea Add radioconda information 
I added the Information about radioconda. I would still suggest leaving the hint about the build artifacts in the documentation, as this is currently the only source of the binaries that don't require any third party.
 2025-06-14 21:22:51 +02:00
philippuhl
b84aab3bca Update section about windows binaries 2025-05-19 12:51:16 +02:00
Mike Walters
17b641d776 docs: add troubleshooting section for no boards found 2025-03-25 13:07:11 +00:00
Mike Walters
980bb9c548 docs: remove mention of a very old DC spike bug 
At this point it's more likely to confuse things than help
 2025-03-25 11:18:37 +00:00
Mike Walters
655be2e225 docs: add pictures to DC spike explanation 2025-03-25 11:17:27 +00:00
Mike Walters
1c691c4a56 docs: rename FAQ to Troubleshooting 2025-03-25 10:46:47 +00:00
Mike Walters
a7d9d853ff docs: move LED color info from FAQ 2025-03-25 10:14:35 +00:00
Mike Walters
fd20d32774 docs: reword gain settings 2025-03-25 10:11:04 +00:00
Mike Walters
2d5070832c docs: move gain info from FAQ 2025-03-25 10:05:51 +00:00
Mike Walters
20e5830c2e docs: add links to product page & resellers on HackRF one page, remove from faq 2025-03-24 14:25:55 +00:00
Mike Walters
bb03d1c42a docs: Remove full-duplex FAQ entries 2025-03-24 13:39:12 +00:00
Mike Walters
87e779306a docs: adjust input/output power titles & wording 2025-03-24 13:39:12 +00:00
Mike Walters
60c262fd18 docs: Move TX/RX power FAQ entries to HackRF One page 2025-03-24 13:39:12 +00:00
dependabot[bot]
72775fc387 build(deps): bump jinja2 from 3.1.4 to 3.1.5 in /docs 
Bumps [jinja2](https://github.com/pallets/jinja) from 3.1.4 to 3.1.5.
- [Release notes](https://github.com/pallets/jinja/releases)
- [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst)
- [Commits](https://github.com/pallets/jinja/compare/3.1.4...3.1.5)

---
updated-dependencies:
- dependency-name: jinja2
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
 2025-01-08 20:53:05 +00:00
Michael Ossmann
83a7e6ccad Merge pull request #1469 from martinling/sync-checklist 
Add synchronization checklist to documentation
 2024-12-05 11:19:12 -05:00
Martin Ling
e4f9a7d462 Add synchronization checklist to documentation. 2024-12-05 16:16:08 +00:00
Mike Walters
5b6b46da53 docs: add Opera Cake Block Diagram 2024-11-06 16:07:00 +00:00
Martin Ling
2d9a7dbd0b Merge pull request #1453 from greatscottgadgets/dependabot/pip/docs/jinja2-3.1.4 
build(deps): bump jinja2 from 3.1.3 to 3.1.4 in /docs
 2024-07-09 20:09:58 +01:00
Straithe
9d54ba484d Add spec statement to hardware revision docs 2024-06-08 01:41:39 -04:00
dependabot[bot]
f927307787 build(deps): bump jinja2 from 3.1.3 to 3.1.4 in /docs 
Bumps [jinja2](https://github.com/pallets/jinja) from 3.1.3 to 3.1.4.
- [Release notes](https://github.com/pallets/jinja/releases)
- [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst)
- [Commits](https://github.com/pallets/jinja/compare/3.1.3...3.1.4)

---
updated-dependencies:
- dependency-name: jinja2
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-05-06 21:02:34 +00:00
JinGen Lim
74efc69bf7 docs: update github.com/mossmann urls 
In the installing_hackrf_software docs, under "Installing From Source", the source url still points to `git clone https://github.com/mossmann/hackrf.git` instead of https://github.com/greatscottgadgets/hackrf.git

Unlike the other browser links, the git url is not automatically redirected, so cloning will fail:

```
jg@buildbot:~/hackrf$ git clone https://github.com/mossman/hackrf.git
Cloning into 'hackrf'...
remote: Repository not found.
fatal: repository 'https://github.com/mossman/hackrf.git/' not found
```

While creating this patch, I also found a few more of those older urls and updated them too.
One last unfixed url remains at https://hackrf.readthedocs.io/en/latest/LPC43XX_Debugging.html#lpc-link, however I could not find the intended destination so I have left it as-is.
 2024-04-06 22:38:26 +08:00
Friendly
57f9d7a6ce doc: markdown heading 
The previous markdown was not valid and yielded the following warning:

```sh
⬛make html
Running Sphinx v5.3.0
WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 34 source files that are out of date
updating environment: [new config] 34 added, 0 changed, 0 removed
reading sources... [100%] virtual_machines
hackrf/docs/source/list_of_hardware_revisions.rst:36: WARNING: Title underline too short.

HackRF One r10
~~~~~~~~~~~~~
hackrf/docs/source/list_of_hardware_revisions.rst:36: WARNING: Title underline too short.

HackRF One r10
~~~~~~~~~~~~~
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] virtual_machines
generating indices... genindex done
writing additional pages... search done
copying images... [100%] ../images/noisereducingcablescreenshot.jpeg
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 3 warnings.

The HTML pages are in build/html.
```

Congratulations on double digits.
 2024-03-03 19:24:18 -06:00
Michael Ossmann
3bdc554700 Add HackRF One r10 to list of hardware revisions 2024-02-22 10:58:12 -05:00
Martin Ling
c0e7391c48 Update readthedocs requirements to current versions. 2024-01-17 05:13:46 +00:00
Straithe
13dacd81e6 Add jawbreaker photo to jawbreaker page (#1321) 2023-06-12 17:42:12 -04:00
Straithe
14ae0743e6 Add project to community page (#1334) 2023-06-09 16:44:07 -04:00
Straithe
50c22aa05b docs: move connectors information to its own section (#1316) 2023-05-08 00:09:04 -04:00
László Baráth
17269d3a7c Document libhackrf functions using Doxygen (#1244) 
* Document & comment code

* document functions & add pages for groups

* Run clang-format

* Fix most review change requests

* Fix typos, add information on using multiple Opera Cake boards

* Update documentation

* Changes requested by @Straithe
- update project brief
- set paper type to letter
- move doxyfile

* Changes requested by @martinling
Excluding the USB API versioning

* Remove incomplete USB version info
The required versions were only noted at a few places. Will add complete info later, but for now, it's removed
 2023-04-22 22:03:49 -04:00
Straithe
464a6019b7 reorganize and update existing HackRF documentation (#1295) 
* reorganize and update existing HackRF documentation

* include changes suggested by martinling

* Update software support page

* fix typo

* Update acrylic case link

* docs: make adjustments based on feedback from epenelope
 2023-04-10 16:06:37 -04:00
Michael Ossmann
b1d1fd4ac1 docs: add block diagram subheadings 2023-01-31 21:29:08 -05:00
Michael Ossmann
ddfe8620a8 docs: updates for HackRF One r9 2023-01-07 13:25:49 -05:00
Michael Ossmann
1680e25c38 HackRF One: update DC output voltage documentation 2023-01-06 06:09:07 -05:00
László Baráth
ff843584dd Fix "14dB" RF amplification in FAQ (#1252) 
Also added a comment on why is this value often quoted wrong
 2023-01-05 13:24:06 -05:00
Michael Ossmann
10111d81af Merge pull request #1205 from straithe/splitOutOperaCakeDocumentation 
Docs: Move Opera Cake documentation to its own section
 2023-01-05 07:40:11 -05:00
Michael Ossmann
86c1d8ce6e restrict IF to 2170-2740 MHz 2022-12-09 09:12:37 -05:00
Straithe
15636efb4d Docs: Update HackRF troubleshooting docs (#1210) 
* Update HackRF troubleshooting docs
 2022-11-07 14:22:28 -05:00
straithe
e1e95b0dc9 docs: update documentaiton based on PR changes requested 2022-10-28 15:37:40 -04:00
straithe
23a092f444 Update Opera Cake docs 2022-10-20 18:30:01 -04:00
Michael Ossmann
0afc9857e4 Update some outdated technical docs (#1190) 
* update outdated libhackrf documentation

* update outdated hackrf_sweep documentation
 2022-09-28 18:16:39 -04:00
straithe
58e65517a5 Add picture of HackRF to documentation 2022-09-28 01:34:11 -04:00
Michael Ossmann
681ebc46ad Merge pull request #1182 from straithe/removeDocsRetiredContentSection 
remove retired content and move jawbreaker content
 2022-09-27 13:30:03 -04:00