Formatting updates to setup instructions in the SDR guides
This commit is contained in:
parent
a3432d88a1
commit
537207ca91
|
@ -4,4 +4,4 @@ Getting Started
|
||||||
.. todo::
|
.. todo::
|
||||||
|
|
||||||
Getting started instructions are coming soon! In the meantime, feel free
|
Getting started instructions are coming soon! In the meantime, feel free
|
||||||
to explore the project documentation, where many components include usage examples.
|
to explore the project documentation. Many components include usage examples.
|
||||||
|
|
|
@ -41,15 +41,15 @@ Limitations
|
||||||
transfer rates.
|
transfer rates.
|
||||||
|
|
||||||
Set up instructions (Linux, Radioconda)
|
Set up instructions (Linux, Radioconda)
|
||||||
---------------------------
|
---------------------------------------
|
||||||
|
|
||||||
Step 1: Activate your Radioconda environment.
|
1. Activate your Radioconda environment.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
conda activate <your-env-name>
|
conda activate <your-env-name>
|
||||||
|
|
||||||
Step 2: Install the base dependencies and drivers ('Easy method')
|
2. Install the base dependencies and drivers (*Easy method*):
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
@ -59,7 +59,7 @@ Step 2: Install the base dependencies and drivers ('Easy method')
|
||||||
sudo apt-get install libbladerf-dev
|
sudo apt-get install libbladerf-dev
|
||||||
sudo apt-get install bladerf-fpga-hostedxa4 # Necessary for installation of bladeRF 2.0 Micro A4.
|
sudo apt-get install bladerf-fpga-hostedxa4 # Necessary for installation of bladeRF 2.0 Micro A4.
|
||||||
|
|
||||||
Step 3: Install a udev rule by creating a link into your radioconda installation.
|
3. Install a ``udev`` rule by creating a link into your Radioconda installation:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
@ -72,6 +72,6 @@ Step 3: Install a udev rule by creating a link into your radioconda installation
|
||||||
Further Information
|
Further Information
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
- `Official Website <https://www.nuand.com/>`_
|
- `Official BladeRF Website <https://www.nuand.com/>`_
|
||||||
- `BladeRF GitHub Repository <https://github.com/Nuand/bladeRF>`_
|
- `BladeRF GitHub Repository <https://github.com/Nuand/bladeRF>`_
|
||||||
- `Radioconda Github Repository <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#bladerf>`
|
- `BladeRF Setup with Radioconda <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#bladerf>`_
|
||||||
|
|
|
@ -40,22 +40,22 @@ Limitations
|
||||||
- USB 2.0 connectivity might limit data transfer rates compared to USB 3.0 or Ethernet-based SDRs.
|
- USB 2.0 connectivity might limit data transfer rates compared to USB 3.0 or Ethernet-based SDRs.
|
||||||
|
|
||||||
Set up instructions (Linux, Radioconda)
|
Set up instructions (Linux, Radioconda)
|
||||||
---------------------------
|
---------------------------------------
|
||||||
|
|
||||||
Step 1: Activate your Radioconda environment.
|
1. Activate your Radioconda environment:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
conda activate <your-env-name>
|
conda activate <your-env-name>
|
||||||
|
|
||||||
Step 2: Install the System Package (Ubuntu / Debian)
|
2. Install the System Package (Ubuntu / Debian):
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
sudo apt-get install hackrf
|
sudo apt-get install hackrf
|
||||||
|
|
||||||
Step 3: Install a udev rule by creating a link into your radioconda installation.
|
3. Install a ``udev`` rule by creating a link into your Radioconda installation:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
@ -69,17 +69,15 @@ Make sure your user account belongs to the plugdev group in order to access your
|
||||||
|
|
||||||
sudo usermod -a -G plugdev <user>
|
sudo usermod -a -G plugdev <user>
|
||||||
|
|
||||||
You may have to restart for this change to take effect.
|
.. note::
|
||||||
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
`HackRF Software Installation Guide <https://hackrf.readthedocs.io/en/latest/installing_hackrf_software.html>`_
|
|
||||||
|
|
||||||
|
You may have to restart your system for changes to take effect.
|
||||||
|
|
||||||
Further information
|
Further information
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
- `Official Website <https://greatscottgadgets.com/hackrf/>`_
|
- `Official HackRF Website <https://greatscottgadgets.com/hackrf/>`_
|
||||||
- `Project Documentation <https://hackrf.readthedocs.io/en/latest/>`_
|
- `HackRF Project Documentation <https://hackrf.readthedocs.io/en/latest/>`_
|
||||||
|
- `HackRF Software Installation Guide <https://hackrf.readthedocs.io/en/latest/installing_hackrf_software.html>`_
|
||||||
- `HackRF GitHub Repository <https://github.com/greatscottgadgets/hackrf>`_
|
- `HackRF GitHub Repository <https://github.com/greatscottgadgets/hackrf>`_
|
||||||
- `Radioconda Github Repository <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#hackrf>`
|
- `HackRF Setup with Radioconda <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#hackrf>`_
|
||||||
|
|
|
@ -10,8 +10,7 @@ their key capabilities and limitations, and any additional information needed fo
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
BladeRF <blade>
|
|
||||||
HackRF <hackrf>
|
|
||||||
PlutoSDR <pluto>
|
|
||||||
USRP <usrp>
|
USRP <usrp>
|
||||||
RTL-SDR <rtl>
|
BladeRF <blade>
|
||||||
|
PlutoSDR <pluto>
|
||||||
|
HackRF <hackrf>
|
||||||
|
|
|
@ -44,15 +44,15 @@ Limitations
|
||||||
- USB 2.0 connectivity might limit data transfer rates compared to USB 3.0 or Ethernet-based SDRs.
|
- USB 2.0 connectivity might limit data transfer rates compared to USB 3.0 or Ethernet-based SDRs.
|
||||||
|
|
||||||
Set up instructions (Linux, Radioconda)
|
Set up instructions (Linux, Radioconda)
|
||||||
---------------------------
|
---------------------------------------
|
||||||
|
|
||||||
Step 1: Activate your Radioconda environment.
|
1. Activate your Radioconda environment:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
conda activate <your-env-name>
|
conda activate <your-env-name>
|
||||||
|
|
||||||
Step 2: Install system dependancies.
|
2. Install system dependencies:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
@ -70,8 +70,7 @@ Step 2: Install system dependancies.
|
||||||
libavahi-common-dev \
|
libavahi-common-dev \
|
||||||
libaio-dev
|
libaio-dev
|
||||||
|
|
||||||
|
3. Install a ``udev`` rule by creating a link into your Radioconda installation:
|
||||||
Step 3: Install a udev rule by creating a link into your radioconda installation.
|
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
@ -79,15 +78,15 @@ Step 3: Install a udev rule by creating a link into your radioconda installation
|
||||||
sudo udevadm control --reload
|
sudo udevadm control --reload
|
||||||
sudo udevadm trigger
|
sudo udevadm trigger
|
||||||
|
|
||||||
Once you can talk to the hardware, you may want to perform the post-install steps detailed on the PlutoSDR documentation below.
|
Once you can talk to the hardware, you may want to perform the post-install steps detailed on the `PlutoSDR Documentation <https://wiki.analog.com/university/tools/pluto>`_.
|
||||||
|
|
||||||
Step 4 (Optional): Building libiio or libad9361-iio from source.
|
4. (Optional) Building ``libiio`` or ``libad9361-iio`` from source:
|
||||||
|
|
||||||
Only needed if you want the very latest version of the libraries not provided in Radioconda:
|
This step is only required if you want the latest version of these libraries not provided in Radioconda.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# Clone and build libiio
|
# Build libiio from source
|
||||||
cd ~
|
cd ~
|
||||||
git clone --branch v0.23 https://github.com/analogdevicesinc/libiio.git
|
git clone --branch v0.23 https://github.com/analogdevicesinc/libiio.git
|
||||||
cd libiio
|
cd libiio
|
||||||
|
@ -98,7 +97,9 @@ Only needed if you want the very latest version of the libraries not provided in
|
||||||
sudo make install
|
sudo make install
|
||||||
sudo ldconfig
|
sudo ldconfig
|
||||||
|
|
||||||
# Clone and build libad9361-iio
|
.. code-block:: bash
|
||||||
|
|
||||||
|
# Build libad9361-iio from source
|
||||||
cd ~
|
cd ~
|
||||||
git clone https://github.com/analogdevicesinc/libad9361-iio.git
|
git clone https://github.com/analogdevicesinc/libad9361-iio.git
|
||||||
cd libad9361-iio
|
cd libad9361-iio
|
||||||
|
@ -112,4 +113,4 @@ Further information
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
- `PlutoSDR Documentation <https://wiki.analog.com/university/tools/pluto>`_
|
- `PlutoSDR Documentation <https://wiki.analog.com/university/tools/pluto>`_
|
||||||
- `Radioconda Github Repository <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#iio-pluto-sdr>`
|
- `PlutoSDR Setup with Radioconda <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#iio-pluto-sdr>`_
|
|
@ -42,42 +42,41 @@ Limitations
|
||||||
- Price range can be a consideration, especially for high-end models.
|
- Price range can be a consideration, especially for high-end models.
|
||||||
|
|
||||||
Set up instructions (Linux, Radioconda)
|
Set up instructions (Linux, Radioconda)
|
||||||
---------------------------
|
---------------------------------------
|
||||||
|
|
||||||
Step 1: Activate your Radioconda environment.
|
1. Activate your Radioconda environment:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
conda activate <your-env-name>
|
conda activate <your-env-name>
|
||||||
|
|
||||||
Step 2: Install UHD and Python Bindings.
|
2. Install UHD and Python bindings:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
conda install conda-forge::uhd
|
conda install conda-forge::uhd
|
||||||
|
|
||||||
Step 3: Download UHD images.
|
3. Download UHD images:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
uhd_images_downloader
|
uhd_images_downloader
|
||||||
|
|
||||||
Step 4: Verify Installation.
|
4. Verify access to your device:
|
||||||
|
|
||||||
To verify access to your device:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
uhd_find_devices
|
uhd_find_devices
|
||||||
|
|
||||||
For USB devices only (e.g. B series), install a udev rule by creating a link into your radioconda installation.
|
For USB devices only (e.g. B series), install a ``udev`` rule by creating a link into your Radioconda installation.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
sudo ln -s $CONDA_PREFIX/lib/uhd/utils/uhd-usrp.rules /etc/udev/rules.d/radioconda-uhd-usrp.rules
|
sudo ln -s $CONDA_PREFIX/lib/uhd/utils/uhd-usrp.rules /etc/udev/rules.d/radioconda-uhd-usrp.rules
|
||||||
sudo udevadm control --reload
|
sudo udevadm control --reload
|
||||||
sudo udevadm trigger
|
sudo udevadm trigger
|
||||||
|
|
||||||
Step 5: (optional): Update Firmware/FPGA images
|
5. (Optional) Update firmware/FPGA images:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
@ -88,6 +87,6 @@ This will ensure your device is running the latest firmware and FPGA versions.
|
||||||
Further information
|
Further information
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
- `Official Website <https://www.ettus.com/>`_
|
- `Official USRP Website <https://www.ettus.com/>`_
|
||||||
- `USRP Documentation <https://kb.ettus.com/USRP_Hardware_Driver_and_Interfaces>`_
|
- `USRP Documentation <https://kb.ettus.com/USRP_Hardware_Driver_and_Interfaces>`_
|
||||||
- `Radioconda Github Repository <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#uhd-ettus-usrp>`_
|
- `USRP Setup with Radioconda <https://github.com/radioconda/radioconda-installer?tab=readme-ov-file#uhd-ettus-usrp>`_
|
||||||
|
|
Loading…
Reference in New Issue
Block a user