Skip to content

Commit 35a8a72

Browse files
committed
update website docs
1 parent 9d25531 commit 35a8a72

File tree

9 files changed

+364
-88
lines changed

9 files changed

+364
-88
lines changed

docs/CONFIGURE.md

Lines changed: 118 additions & 41 deletions
Large diffs are not rendered by default.

docs/DEBUG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ make
2626
gdb trunk-recorder core
2727
```
2828

29-
6. *gdb* is a powerful debugging platform. However, all we need is a trace of the crash. After *gdb* has finished loading, type in `bt full` to get a trace. Copy all of the output from *gdb* into a new [GitHub Issue](https://github.com/robotastic/trunk-recorder/issues/new), along with as much information as possible on what maybe casuing the crash.
29+
6. *gdb* is a powerful debugging platform. However, all we need is a trace of the crash. After *gdb* has finished loading, type in `bt full` to get a trace. Copy all of the output from *gdb* into a new [GitHub Issue](https://github.com/robotastic/trunk-recorder/issues/new), along with as much information as possible on what maybe causing the crash.
3030

3131

3232
# How to Capture an IQ Sample

docs/Install/INSTALL-DOCKER.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,12 @@ sidebar_position: 2
66
# Docker
77
If you are not going to be modifying the source code, **a [Docker](https://www.docker.com/) based install is the easiest way to get started.** Images are published frequently to [Docker Hub](https://hub.docker.com/r/robotastic/trunk-recorder). The images have GNURadio 3.8 and all other required dependencies built into it, so it should be ready to go and be a much faster solution than compiling. Images have been built for amd64 (amd64 is used by all modern Intel and AMD CPUs) and most popular flavors of ARM.
88

9-
To get started, create a directory and place your **config.json** file there and a **talkgroup.csv** file if you are using one. Refer to [Configuring Trunk Recorder](CONFIGURE.md) for instructions on how to create these files.
9+
To get started, create a directory and place your **config.json** file there and a **talkgroup.csv** file if you are using one. Refer to [Configuring Trunk Recorder](../CONFIGURE.md) for instructions on how to create these files.
1010

1111
```bash
1212
docker run -it \
13-
--privileged -e TZ=$(cat /etc/timezone) --user "$(id -u):$(id -g)" \
13+
--device "/dev/bus/usb:/dev/bus/usb:rwm" -e TZ=$(cat /etc/timezone) --user "$(id -u):$(id -g)" \
1414
-v $(pwd):/app \
15-
-v /dev/bus/usb:/dev/bus/usb \
1615
-v /var/run/dbus:/var/run/dbus \
1716
-v /var/run/avahi-daemon/socket:/var/run/avahi-daemon/socket \
1817
robotastic/trunk-recorder:latest
@@ -21,15 +20,14 @@ docker run -it \
2120
To use it as part of a [Docker Compose](https://docs.docker.com/compose/) file:
2221

2322
```yaml
24-
version: '3'
2523
services:
2624
recorder:
2725
image: robotastic/trunk-recorder:latest
2826
container_name: trunk-recorder
2927
restart: always
30-
privileged: true
28+
devices:
29+
- "/dev/bus/usb:/dev/bus/usb:rwm"
3130
volumes:
32-
- /dev/bus/usb:/dev/bus/usb
3331
- /var/run/dbus:/var/run/dbus
3432
- /var/run/avahi-daemon/socket:/var/run/avahi-daemon/socket
3533
- ./:/app

docs/Install/INSTALL-LINUX.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_position: 1
77

88
This page covers installing Trunk Recorder on a Linux box. I test everything on Ubuntu, but other flavors of Linux are supported. Instructions are also included for Arch Linux.
99

10-
## Install Prerequistes
10+
## Install Prerequisites
1111
To get started, install all of the required packages. Instructions for different versions are below:
1212

1313

@@ -63,7 +63,7 @@ If you are using a HackRF:
6363
sudo apt install -y hackrf libhackrf-dev libhackrf0
6464
```
6565

66-
### Older Ubuntu Verions...
66+
### Older Ubuntu Versions...
6767

6868
These instructions should work on Ubuntu 16.x to 17.x, including Debian 9 and 10.
6969

@@ -213,7 +213,7 @@ Now restart to make sure these drivers are not loaded.
213213

214214
## Configuring Trunk Recorder
215215

216-
The next step is to [configure Trunk Recorder](CONFIGURE.md) for the system you are trying to capture.
216+
The next step is to [configure Trunk Recorder](../CONFIGURE.md) for the system you are trying to capture.
217217

218218
## Running trunk recorder.
219219

docs/Install/INSTALL-PI.md

Lines changed: 57 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 3
55

66
# Raspberry Pi / Debian
77

8-
Smaller radio systems can be covered using a Raspberry Pi. If you are interested in doing this, you should really get a Pi 4. It maybe possible to get things running on an older Pi, but you often get unexpect behavior and errors. A Pi 4 can handle 3-4 simulatanious recordings. Make sure you have a good power supply. Also pay attention to heat. If the Pi gets too hot, it will slow down. A good case or fan can help keep it going full tilt. You can also just run debian on a NUC or Miniform PC. These commands will work with a vaneilla debian install as well.
8+
Smaller radio systems can be covered using a Raspberry Pi. If you are interested in doing this, you should really get a Pi 4 or better yet, a Pi 5. It maybe possible to get things running on an older Pi, but you often get unexpect behavior and errors. A Pi 4 can handle 3-4 simultaneous recordings. Make sure you have a good power supply. Also pay attention to heat. If the Pi gets too hot, it will slow down. A good case or fan can help keep it going full tilt.
99

1010
## RaspberryOS (aka Raspbian)
1111

@@ -84,7 +84,13 @@ sudo apt upgrade
8484
sudo apt -y install libssl-dev openssl curl git fdkaac sox libcurl3-gnutls libcurl4 libcurl4-openssl-dev gnuradio gnuradio-dev gr-osmosdr libhackrf-dev libuhd-dev cmake make build-essential libboost-all-dev libusb-1.0-0-dev libsndfile1-dev
8585
```
8686

87-
Configure RTL-SDRs to load correctly:
87+
- Remove xtra-dkms.
88+
DKMS is not needed on the Raspberry Pi platform, and just causes issues. The above command actually returns an error on Raspberry Pi OS. So we remove that module from our build so we do not get errors from subsaquent `apt` calls.
89+
```bash
90+
sudo apt remove xtrx-dkms
91+
```
92+
93+
## Configure RTL-SDRs to load correctly:
8894

8995
```bash
9096
sudo wget https://raw.githubusercontent.com/osmocom/rtl-sdr/master/rtl-sdr.rules ~/rtl-sdr.rules
@@ -97,7 +103,55 @@ You will need to restart for the rules to take effect. Logging out and logging b
97103
sudo shutdown -r now
98104
```
99105

100-
Now go [Build](#build-trunk-recorder) Trunk Recorder!
106+
## Configuring the UHD for Ettus SDRs
107+
108+
If you haven't setup UHD yet there are a few extra steps you need to take:
109+
110+
Install the UHD drivers:
111+
112+
```bash
113+
sudo apt-get install libuhd-dev uhd-host
114+
```
115+
116+
Download the firmware images. The location of the downloader is different than the error message:
117+
118+
```bash
119+
dpkg -L uhd-host | grep "downloader"
120+
```
121+
The run the downloader at the location identified, it should be something like this:
122+
123+
```bash
124+
sudo python3 /usr/libexec/uhd/utils/uhd_images_downloader.py
125+
```
126+
127+
Setup the udev rules so any user can access the USB, as documented [here](https://files.ettus.com/manual/page_transport.html#transport_usb_udev):
128+
129+
```bash
130+
cd /usr/libexec/uhd/utils/
131+
sudo cp uhd-usrp.rules /etc/udev/rules.d/
132+
sudo udevadm control --reload-rules
133+
sudo udevadm trigger
134+
```
135+
136+
## Building Trunk Recorder
137+
138+
In order to keep your copy of the Trunk Recorder source code free of build artifacts created by the build process, it is suggested to create a separate "out-of-tree" build directory. We will use `trunk-build` as our build directory. We by default do this in our home directory (`~` - Is a shortcut back to home.).
139+
140+
**Note:** Depending on the amount of RAM in your Raspberry Pi, it may be best to run `make -j1` (2GB), `make -j3` (4GB), and `make -j4` (8GB) in order to ensure that you do not run out of RAM, at the cost of making the compile process take longer. If you ran out of RAM the compile process will fail completely, so it can be an acceptable tradeoff.
141+
142+
```bash
143+
cd ~
144+
mkdir trunk-build
145+
git clone https://github.com/robotastic/trunk-recorder.git
146+
cd trunk-build
147+
cmake ../trunk-recorder
148+
make -j1
149+
sudo make install
150+
```
151+
152+
## Configuring Trunk Recorder
153+
154+
The next step is to [configure Trunk Recorder](../CONFIGURE.md) for the system you are trying to capture.
101155

102156
***
103157
# Ubuntu 22.04 Server (64-bit support!)

0 commit comments

Comments
 (0)