Skip to content

Commit

Permalink
Merge pull request #19 from anarkiwi/doc2
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
anarkiwi authored Aug 17, 2024
2 parents 49c9ab1 + 46015f3 commit d267fd9
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ and to install [docker with GPU support](https://docs.nvidia.com/datacenter/clou

NOTE: If you do not need inference, omit ```-f torchserve-cuda.yml``` in the commands below, and set ```TORCHSERVE``` to a blank string.

## Standalone scenario
## Single host operation

```
+------------+
Expand All @@ -34,6 +34,14 @@ In this scenario, the complete GamutRF system is run on one machine, typically a

Once the system is up and running, sample recording and frequency ranges can be controlled from the Waterfall UI.

### Stare mode

Scanning can be disabled such that GamutRF looks at only one frequency continuously. To configure this mode, set ```FREQ_START``` (or use the Waterfall UI) to the lowest frequency to be observed, and ```FREQ_END``` to 0. GamutRF will monitor from ```FREQ_START``` to ```FREQ_START``` plus GamutRF's sample rate (by default 20.48Msps).

### Recording samples

Recording samples is also managed from the Waterfall UI. Enter the number of samples to record (for example, ```20048000``` will record one second's worth of samples at the default sample rate. A recording accompanied by a [SigMF](https://github.com/sigmf/SigMF) file under ```VOL_PREFIX```.

## Troubleshooting

### SoapySDR errors allocating buffers
Expand All @@ -42,16 +50,16 @@ Run ```echo 0 > /sys/module/usbcore/parameters/usbfs_memory_mb``` as root before

### Containers won't start using Ettus SDRs

#### ```[ERROR] [USB] USB open failed: insufficient permissions```
##### ```[ERROR] [USB] USB open failed: insufficient permissions```

Ettus SDRs download firmware and switch USB identities when first powered up. Restart the affected container to work around this (if run with docker compose, restart will happen automatically).

#### ```[ERROR] [UHD] An unexpected exception was caught in a task loop.The task loop will now exit, things may not work.boost: mutex lock failed in pthread_mutex_lock: Invalid argument```
##### ```[ERROR] [UHD] An unexpected exception was caught in a task loop.The task loop will now exit, things may not work.boost: mutex lock failed in pthread_mutex_lock: Invalid argument```

UHD driver arguments ```num_recv_frames``` or ```recv_frame_size``` may be too high. The defaults are defined as ETTUS_ARGS in [utils.py](https://github.com/IQTLabs/gamutRF/blob/main/gamutrf/utils.py)
. Try reducing one or both via ```--sdrargs```. For example, ```--sdrargs num_recv_frames=64,recv_frame_size=8200,type=b200```.

#### ```[ERROR] [UHD] EnvironmentError: IOError: usb rx6 transfer status: LIBUSB_TRANSFER_OVERFLOW```
##### ```[ERROR] [UHD] EnvironmentError: IOError: usb rx6 transfer status: LIBUSB_TRANSFER_OVERFLOW```

Stop containers, and reset the Ettus as follows:

Expand Down

0 comments on commit d267fd9

Please sign in to comment.