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
This commit is contained in:
yhetti
2022-04-29 13:06:35 -06:00
committed by GitHub
parent db39147e04
commit 8feda0946b
12 changed files with 77 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

BIN
docs/images/rf_shield_2.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

BIN
docs/images/rf_shield_3.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

BIN
docs/images/rf_shield_4.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

BIN
docs/images/rf_shield_5.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 292 KiB

BIN
docs/images/rf_shield_6.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

BIN
docs/images/rf_shield_7.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/images/rf_shield_8.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

BIN
docs/images/rf_shield_9.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

View File

@ -45,6 +45,7 @@ Welcome to HackRF's documentation!
clocking clocking
expansion_interface expansion_interface
multiple_device_hardware_synch multiple_device_hardware_synch
rf_shield_installation
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

View File

@ -13,6 +13,8 @@ This page describes the modifications required to get multiple HackRF hardware-l
The HackRFs will start transmitting USB packets at the same time, which results in an inter-device offset of ~50 samples at a sample rate of 20MSps. Without this synchronisation, the offset is in the range of thousands to tens of thousands of samples. This is due to the USB start command being called sequentially for each device, along with USB buffering, OS-level timing etc. The HackRFs will start transmitting USB packets at the same time, which results in an inter-device offset of ~50 samples at a sample rate of 20MSps. Without this synchronisation, the offset is in the range of thousands to tens of thousands of samples. This is due to the USB start command being called sequentially for each device, along with USB buffering, OS-level timing etc.
**BE WARNED** you will have to open your HackRFs, which is most likely going to destroy the plastic case it comes in. You will also be electrically connecting them together. If you do this incorrectly, there is a good chance one or all of the devices will be permanently destroyed. **BE WARNED** you will have to open your HackRFs, which is most likely going to destroy the plastic case it comes in. You will also be electrically connecting them together. If you do this incorrectly, there is a good chance one or all of the devices will be permanently destroyed.
@ -35,6 +37,7 @@ For this to work you will need:
* a breadboard * a breadboard
.. _opening_your_hackrf:
Opening your HackRF Opening your HackRF
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
@ -141,4 +144,4 @@ Obviously the method of wiring up multiple HackRFs described above is fragile an
Usually the *Osmocom source* can be used for multi-device streaming, as it can be configured to pull from more than one device. Unfortunately the current version does not have hardware synchronisation built in. Work is being done to make the *Osmocom source* compatible with these changes. Usually the *Osmocom source* can be used for multi-device streaming, as it can be configured to pull from more than one device. Unfortunately the current version does not have hardware synchronisation built in. Work is being done to make the *Osmocom source* compatible with these changes.
.. image:: ../images/grc-hw-sync-streaming.png .. image:: ../images/grc-hw-sync-streaming.png
:align: center :align: center

View File

@ -0,0 +1,72 @@
===============================================
RF Shield Installation Instructions
===============================================
Official Great Scott Gadgets HackRF Ones do not come from the factory with an RF shield installed around the radio section of the PCB. They do, however, have pads in place so that one may be installed if a user has a reason and an inclination to do so. The reason that they do not come preinstalled is that early testing revealed that the RF shield did little to improve the performance of the HackRF One. The recommended RF shield is the BMI-S-230-F-R (frame) with the BMI-S-230-C (shield). A two part RF shield is recommended because the shield section can be removed to allow access to the RF section of the HackRF One. This can be important if it becomes necessary to probe any part of the RF section, or to replace any parts of the RF section. However, even with a two part RF shield, it can be difficult to access the RF section of the HackRF One in certain situations. The following steps are a basic set of instructions for installing a RF shield on a HackRF One.
**CAUTION: Soldering a RF shield onto a HackRF One comes with a certain amount of risk. Beyond the inherent risks of soldering itself, this process may damage the HackRF One and no warranty is available to cover damage incurred from this process. If you do choose to install a RF shield on your HackRF One please proceed with caution.**
1. Remove the HackRF One from the injection molded plastic case.
**BE WARNED: Opening the plastic case of your HackRF One will most likely destroy the tabs that hold it together.**
Instructions for removing a HackRF One from it's case can be found :ref:`here <opening_your_hackrf>`.
2. Prepare the HackRF One PCB for soldering on the shield frame, by adding flux to the RF shield pads around the radio section on the PCB.
.. image:: ../images/rf_shield_1.jpeg
:align: center
3. Place the RF shield frame on the HackRF One, aligning it so that it makes contact with all of the pads around the RF section of the board.
.. image:: ../images/rf_shield_2.jpg
:align: center
4. Solder the shield to one pad to anchor it to the H1. Visually inspect the frame to assure that it is still aligned properly.
+---------------------------------------+---------------------------------------+
| .. image:: ../images/rf_shield_3.jpg | .. image:: ../images/rf_shield_4.jpg |
+---------------------------------------+---------------------------------------+
5. Connect the frame to another pad on the opposite side from the first connection. Again, check that the frame is still aligned properly.
+---------------------------------------+---------------------------------------+
| .. image:: ../images/rf_shield_5.jpg | .. image:: ../images/rf_shield_6.jpg |
+---------------------------------------+---------------------------------------+
6. Connect at least one more pad, and then remove the pick and place bridge from the frame. *Removing the pick and place bridge is optional, but it is recommended.*
.. image:: ../images/rf_shield_7.jpg
:align: center
7. Continue soldering the rest of the pads to the frame.
.. image:: ../images/rf_shield_8.jpg
:align: center
8. Clean the flux and soldering residue with the appropriate solvent for the type of flux used. Be sure to let the HackRF One dry completely before plugging it in to a power source.
9. Place the RF shield onto the frame and snap it into place.
.. image:: ../images/rf_shield_9.jpg
:align: center
10. If desired, put the HackRF One back into the plastic case, if it is still able to click together.