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
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
Straithe
9d54ba484d
Add spec statement to hardware revision docs
2024-06-08 01:41:39 -04: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
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
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
Build / host (ubuntu-latest) (push) Failing after 11s
Build / firmware (HACKRF_ONE, ubuntu-latest) (push) Failing after 21s
Check code style / clang-format (push) Failing after 5s
Build / firmware (JAWBREAKER, ubuntu-latest) (push) Failing after 22s
Build / firmware (RAD1O, ubuntu-latest) (push) Failing after 19s
Check code style / clang-format-2 (push) Failing after 4s
Check code style / clang-format-1 (push) Failing after 5s
Check code style / clang-format-3 (push) Failing after 8s
Build / host (macos-latest) (push) Has been cancelled
Build / host (windows-latest) (push) Has been cancelled
Build / firmware (HACKRF_ONE, macos-latest) (push) Has been cancelled
Build / firmware (JAWBREAKER, macos-latest) (push) Has been cancelled
Build / firmware (RAD1O, macos-latest) (push) Has been cancelled
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
straithe
12b9d4cdc9
remove retired content and move jawbreakercontent
2022-09-27 02:53:35 -04:00
straithe
3678bfa03e
Add picture of Opera Cake to documentation
2022-09-26 00:24:42 -04:00
Michael Ossmann
0e84382f5a
document hardware triggering
...
This replaces outdated documentation of an older trigger mechanism.
2022-09-21 10:36:06 -04:00
Michael Ossmann
5c812681ab
docs: Remove outdated clocking page
2022-09-21 04:09:54 -04:00
Martin Ling
ba148ee047
Add a simpler way to check CLKIN status.
2022-08-05 09:37:38 +01:00
james-pcdf
1ed2d3bb14
Gain controls: bulleted list ( #1113 )
2022-07-21 12:58:27 -04:00
yhetti
8feda0946b
Documentation: Add RF shield installation instructions to docs ( #1074 )
...
* Documentation: Add RF shield installation instructions page.
Add a page with written instructions for installing a RF shield on a HackRF One. Includes pictures of various steps in the process
* Documentation: Add rf_shield_installation.rst that was left out of previous commit.
* Documentation: Move tag in multiple_device_hardware_synch.rst to correct location.
* Documentation: Add edits suggested by straithe to rf_shield instructions
2022-04-29 15:06:35 -04:00
Radoslav Gerganov
6738085f59
Add project mention for the Tesla charging port opener ( #1082 )
...
Static web page which uses WebUSB and HackRF to transimt a signal which
opens the Tesla charging port
2022-04-05 19:34:31 -04:00
Martin Ling
308ddeca8a
New block diagram ( #1039 )
2022-01-28 01:48:17 -05:00
Radoslav Gerganov
aec108be46
Add project mention for the APRS tracker ( #1033 )
...
APRS tracker which uses the HTML Geolocation API to retrieve the
device's position and WebUSB to communicate with the HackRF. The source
code is available at https://github.com/rgerganov/aprs-sdr
2022-01-10 15:10:35 -05:00
Michael Ossmann
471defd545
avoid incorrect syntax highlighting
...
also remove spaces before '::'s
2021-12-29 15:09:40 -07:00
straithe
4002fb2f8b
Update docs
2021-12-28 18:27:01 -05:00
Ievgen Glinchuk
0002e2d391
Fix double hyphen (--) rendered as en dash ( #1023 )
2021-12-28 17:36:21 -05:00
Michael Ossmann
b1b11e6269
update Opera Cake documentation ( #1017 )
2021-12-12 17:06:53 -05:00
straithe
7415764b84
Update docs
2021-11-18 20:16:30 -05:00
Michael Ossmann
80948a2252
Merge pull request #994 from straithe/master
...
Remove links to mailing list
2021-11-15 17:49:37 -07:00
straithe
19c99909b2
Remove links to mailing list
2021-11-15 19:29:01 -05:00
Michael Ossmann
d94295edcf
add list of hardware revisions ( #988 )
2021-11-08 18:29:16 -05:00
straithe
5a56fff91a
Update HackRF one docs pag
2021-11-02 21:07:20 -04:00
Michael Ossmann
f92d49ab23
Merge pull request #961 from straithe/updatedOperatingSystemsPage
...
Update installing hackrf software documentation
2021-11-02 16:39:14 -06:00
straithe
dcc23c40d0
Remove non-HackRF references
2021-10-25 17:41:12 -04:00
straithe
92e3f48cec
Add Ubuntu instructions
2021-09-22 01:29:40 -04:00
straithe
ce49451e80
Update installing hackrf software documentation
2021-09-22 01:23:09 -04:00