Skip to content

Commit 77b8bcf

Browse files
committed
updated links
1 parent edbee98 commit 77b8bcf

File tree

10 files changed

+53
-44
lines changed

10 files changed

+53
-44
lines changed

docs/CONFIGURE.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Center Frequency Calculators:
4141
Configuration File:
4242
- https://www.radioetcetera.site/trunk-recorder-config-editor/ - tool for using a GUI to create config.json files
4343
- https://github.com/AlertPageSDR/tr_configurator - If you have a Radio Reference Premium account, you can use this tool to automatically generate a config.json based on the RR data for a given system (or systems)
44-
- https://github.com/robotastic/trunk-recorder-configs - example configurations for different systems
44+
- https://github.com/TrunkRecorder/trunk-recorder-configs - example configurations for different systems
4545

4646
### Gain
4747

@@ -229,11 +229,10 @@ There is a list of available Plugins [here](./Plugins.md).
229229
| compressWav | | true | bool | Convert the recorded .wav file to an .m4a file. **This is required for both OpenMHz and Broadcastify!** The `sox` and `fdkaac` packages need to be installed for this command to work. |
230230
| unitScript | | | string | The filename of a script that runs when a radio (unit) registers (is turned on), affiliates (joins a talk group), deregisters (is turned off), gets an acknowledgment response, transmits, gets a data channel grant, a unit-unit answer request or a Location Registration Response. Passed as parameters: `shortName radioID on\|join\|off\|ackresp\|call\|data\|ans_req\|location`. On joins and transmissions, `talkgroup` is passed as a fourth parameter; on answer requests, the `source` is. On joins and transmissions, `patchedTalkgroups` (comma separated list of talkgroup IDs) is passed as a fifth parameter if the talkgroup is part of a patch on the system. See *examples/unit-script.sh* for a logging example. Note that for paths relative to trunk-recorder, this should start with `./`( or `../`). |
231231
| audioArchive | | true | **true** / **false** | Should the recorded audio files be kept after successfully uploading them? |
232-
| conversationMode | | true | **true** / **false** | Should individual transmissions that are within *timeout* of each other, be grouped together into a single call. |
233232
| transmissionArchive | | false | **true** / **false** | Should each of the individual transmission be kept? These transmission are combined together with other recent ones to form a single call. |
234233
| callLog | | true | **true** / **false** | Should a json file with the call details be kept after successful uploads? |
235234
| analogLevels | | 8 | number (1-32) | The amount of amplification that will be applied to the analog audio. |
236-
| maxDev | | 4000 | number | The maximum deviation for analog channels. If you analog recordings sound good or if you have a completely digital system, then there is no need to touch this. |
235+
| maxDev | | 5000 | number | The maximum deviation for analog channels. If you analog recordings sound good or if you have a completely digital system, then there is no need to touch this. |
237236
| digitalLevels | | 1 | number (1-16) | The amount of amplification that will be applied to the digital audio. |
238237
| unitTagsFile | | | string | The filename of a CSV file that provides information about the unit tags. The format for the file is described below. |
239238
| recordUnknown | | true | **true** / **false** | Record talkgroups if they are not listed in the Talkgroups File. |
@@ -279,14 +278,14 @@ By default, Trunk Recorder will record the call from the first site to receive t
279278
{
280279
"type": "P25",
281280
...
282-
"multiSite": "true",
281+
"multiSite": true,
283282
"multiSiteSystemName": "somesharedname",
284283
"multiSiteSystemNumber": 1
285284
},
286285
{
287286
"type": "P25",
288287
...
289-
"multiSite": "true",
288+
"multiSite": true,
290289
"multiSiteSystemName": "somesharedname",
291290
"multiSiteSystemNumber": 2
292291
}
@@ -487,7 +486,6 @@ The columns are:
487486
| Tag | | The Service Tag for the Talkgroup |
488487
| Priority | | The priority field specifies the number of recorders the system must have available to record a new call for the talkgroup. For example, a priority of 1, the highest means as long as at least a single recorder is available, the system will record the new call. If the priority is 2, the system would at least 2 free recorders to record the new call, and so on. If there is no priority set for a talkgroup entry, a prioity of 1 is assumed. <br/> Talkgroups assigned a priority of -1 will never be recorded, regardless of the number of available recorders. |
489488
| Preferred NAC | | In Multi-Site mode, the preferred NAC (`nnnn`, e.g. `1234`), RFSS/SiteID (`RRRRssss`, e.g. `00010023`), or multiSiteSystemNumber to record a specific talkgroup.|
490-
| Conversation Mode | | Allows for Conversation Mode to be set at the Talkgroup level. This is helpful if you have a busy dispatch channel and want to break it up. This value can be set on only few rows, the rest will default to the System level value. The allowed values are `true` and `false`. |
491489
| Comment | | Use this field to capture comments about a talkgroup. It will be ignored by Trunk Recorder. |
492490

493491
Here are the column headers and some sample data:

docs/DEBUG.md

Lines changed: 3 additions & 3 deletions
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 causing 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/TrunkRecorder/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
@@ -67,7 +67,7 @@ Use the settings from the source you are interested in from your config.json fil
6767

6868
you would use: `rtl_sdr -f 855700000 -s 2048000 -g 39 -d 41 debug.iq`
6969

70-
The file that rtl_sdr generates is in a compact format... which is great but it can't easily be opened by other program. There is a good write-up on it from here (from 2014!). Luckily, some wrote a small program to convert it into a more standard format (complex IQ). I have included it in the /utils folder: [rtlsdr-to-iq.c](https://github.com/robotastic/trunk-recorder/blob/master/utils/rtlsdr-to-iq.c). Compile the program and then copy it to the directory with your recordings and run it against them. Note - the conversion will cause the filesize to increase 4x, so make sure you have enough space.
70+
The file that rtl_sdr generates is in a compact format... which is great but it can't easily be opened by other program. There is a good write-up on it from here (from 2014!). Luckily, some wrote a small program to convert it into a more standard format (complex IQ). I have included it in the /utils folder: [rtlsdr-to-iq.c](https://github.com/TrunkRecorder/trunk-recorder/blob/master/utils/rtlsdr-to-iq.c). Compile the program and then copy it to the directory with your recordings and run it against them. Note - the conversion will cause the filesize to increase 4x, so make sure you have enough space.
7171

7272

7373
## Playback in GQRX
@@ -81,4 +81,4 @@ You are then going to need a device string with the correct options. Update this
8181

8282
## Playing an IQ File as a Source in Trunk Recorder
8383

84-
Check out the [config-iq-file.json](https://github.com/robotastic/trunk-recorder/blob/master/examples/config-iq-file.json) config as an example of how to playback an IQ file as a Source. You will probably need to have the `repeat` parameter turned on, unless you have a really long file.
84+
Check out the [config-iq-file.json](https://github.com/TrunkRecorder/trunk-recorder/blob/master/examples/config-iq-file.json) config as an example of how to playback an IQ file as a Source. You will probably need to have the `repeat` parameter turned on, unless you have a really long file.

docs/FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,5 @@ Once **gdb** loads up, use the *backtrace* command to review the execution histo
4646

4747
`backtrace`
4848

49-
Now you can create a [GitHub Issue](https://github.com/robotastic/trunk-recorder/issues), including the info from **gdb**, along with your config.json and as much info as possible on how to recreate the crash.
49+
Now you can create a [GitHub Issue](https://github.com/TrunkRecorder/trunk-recorder/issues), including the info from **gdb**, along with your config.json and as much info as possible on how to recreate the crash.
5050

docs/Install/INSTALL-DOCKER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,5 @@ Currently, Docker image builds are triggered by the following events:
5353
5454
* After every push to the `master` branch the `edge` tag is built and pushed to Docker Hub.
5555
* Every day at 10 AM UTC the `nightly` tag is built and pushed to Docker Hub.
56-
* When a new [release](https://github.com/robotastic/trunk-recorder/releases) happens the `<version>` and `latest` tags are built and pushed to Docker Hub.
56+
* When a new [release](https://github.com/TrunkRecorder/trunk-recorder/releases) happens the `<version>` and `latest` tags are built and pushed to Docker Hub.
5757

docs/Install/INSTALL-LINUX.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Assuming you are in the desired directory to place both trunk-recorder and trunk
148148

149149
```bash
150150
mkdir trunk-build
151-
git clone https://github.com/robotastic/trunk-recorder.git
151+
git clone https://github.com/TrunkRecorder/trunk-recorder.git
152152
cd trunk-build
153153
cmake ../trunk-recorder
154154
make
@@ -217,7 +217,7 @@ The next step is to [configure Trunk Recorder](../CONFIGURE.md) for the system y
217217

218218
## Running trunk recorder.
219219

220-
If all goes well you should now have the executable named `trunk-recorder`, and created the `config.json` configuration file as described in the [Wiki](https://github.com/robotastic/trunk-recorder/wiki/Configuring-a-System) and [README](https://github.com/robotastic/trunk-recorder/blob/master/README.md#configure).
220+
If all goes well you should now have the executable named `trunk-recorder`, and created the `config.json` configuration file as described in the [Wiki](https://github.com/TrunkRecorder/trunk-recorder/wiki/Configuring-a-System) and [README](https://github.com/TrunkRecorder/trunk-recorder/blob/master/README.md#configure).
221221

222222
From your build directory (e.g. `trunk-build`) you can now run
223223
`./trunk-recorder`

docs/Install/INSTALL-MAC.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,39 @@ sidebar_position: 4
66
There are two main "package managers" used on MacOS: [Homebrew](#using-homebrew) and [MacPorts](#using-macports). Trunk-recorder can be installed with dependencies from one or the other
77

88
## Using Homebrew
9-
Tested on macOS Ventura 13.2 with the following packages:
9+
Tested on macOS Sequoia 15.5 with the following packages:
1010

11-
- homebrew 3.6.21
12-
- cmake 3.25.2
13-
- gnuradio 3.10.5.1
14-
- uhd 4.4.0.0
15-
- pkgconfig 0.29.2
11+
- homebrew 4.5.3
12+
- cmake 4.0.2
13+
- gnuradio 3.10.12.0_1
14+
- uhd 4.8.0.0_1
15+
- pkgconfig 2.4.3
1616
- cppunit 1.15.1
17-
- openssl 3.0.7
18-
- fdk-aac-encoder 1.0.3
19-
- sox 14.4.2
20-
- pybind11 2.10.3
17+
- openssl 3.5.0
18+
- fdk-aac-encoder 2.0.3
19+
- sox 14.4.2_6
20+
- pybind11 2.13.6_1
21+
- six 1.17.0
2122

2223
#### Install Homebrew
2324
See [the Brew homepage](https://brew.sh) for more information.
2425
```bash
2526
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
2627
```
2728

29+
#### Installing using the Trunk Recorder Tap
30+
31+
Trunk Recorder can be installed easily by adding the repository to homebrew. More information can be found on [this github repo](https://github.com/TrunkRecorder/homebrew-install). Install can be done easily with the following commands.
32+
```
33+
brew tap trunkrecorder/install
34+
brew install trunk-recorder
35+
```
36+
37+
If you prefer to install packages individually or without adding the repository, it can be done using the instructions below.
38+
2839
#### Install GNURadio and other dependencies
2940
```bash
30-
brew install gnuradio uhd cmake pkgconfig cppunit openssl fdk-aac-encoder sox pybind11
41+
brew install gnuradio uhd cmake pkgconfig cppunit openssl fdk-aac-encoder sox pybind11 six
3142
```
3243
#### Install the OsmoSDR Package for GNURadio
3344
See the gr-osmosdr [homepage](https://osmocom.org/projects/gr-osmosdr/wiki/GrOsmoSDR) for more information.
@@ -47,7 +58,7 @@ This path in Homebrew will differ by system (Apple Silicon:`/opt/homebrew/opt/op
4758
#### Building Trunk Recorder
4859
```bash
4960
mkdir trunk-recorder && cd trunk-recorder
50-
git clone https://github.com/robotastic/trunk-recorder.git source
61+
git clone https://github.com/TrunkRecorder/trunk-recorder.git source
5162
mkdir build && cd build
5263
cmake ../source -DOPENSSL_ROOT_DIR=$(brew --prefix openssl@3)
5364
make -j
@@ -71,7 +82,7 @@ sudo port selfupdate
7182

7283
#### Install GNU Radio
7384

74-
The preferred method for [installing GNU Radio](http://gnuradio.org/redmine/projects/gnuradio/wiki/InstallingGR) on macOS is:
85+
The preferred method for [installing GNU Radio](https://wiki.gnuradio.org/index.php?title=MacInstall) on macOS is:
7586

7687
```bash
7788
sudo port install gnuradio uhd gr-osmosdr
@@ -111,7 +122,7 @@ sudo make install
111122
#### Building Trunk Recorder
112123
```bash
113124
mkdir trunk-recorder && cd trunk-recorder
114-
git clone https://github.com/robotastic/trunk-recorder.git source
125+
git clone https://github.com/TrunkRecorder/trunk-recorder.git source
115126
mkdir build && cd build
116127
cmake ../source -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl
117128
make -j
@@ -120,11 +131,11 @@ sudo make install
120131

121132
## Configuring Trunk Recorder
122133

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

125136
## Running trunk recorder.
126137

127-
If all goes well you should now have the executable named `trunk-recorder`, and created the `config.json` configuration file as described in the [Wiki](https://github.com/robotastic/trunk-recorder/wiki/Configuring-a-System) and [README](https://github.com/robotastic/trunk-recorder/blob/master/README.md#configure).
138+
If all goes well you should now have the executable named `trunk-recorder`, and created the `config.json` configuration file as described in the [Wiki](https://github.com/TrunkRecorder/trunk-recorder/wiki/Configuring-a-System) and [Configuring Trunk Recorder](https://github.com/TrunkRecorder/trunk-recorder/blob/master/docs/CONFIGURE.md).
128139

129140
From your build directory (e.g. `trunk-build`) you can now run
130141
`./trunk-recorder`

docs/Install/INSTALL-PI.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Smaller radio systems can be covered using a Raspberry Pi. If you are interested
1010
## RaspberryOS (aka Raspbian)
1111

1212
### Setup Raspbian
13-
This is a [good guide](https://desertbot.io/blog/headless-raspberry-pi-4-ssh-wifi-setup) on how to setup a Raspberry Pi in headless mode. This means that you do not have to attach a monitor, keyboard or mouse to it to get it working. The steps below are pulled from this guide.
13+
This is a [good guide](https://www.tomshardware.com/reviews/raspberry-pi-headless-setup-how-to,6028.html) on how to setup a Raspberry Pi in headless mode. This means that you do not have to attach a monitor, keyboard or mouse to it to get it working. The steps below are pulled from this guide.
1414

1515
#### Download and burn the image
1616

@@ -21,7 +21,7 @@ The first step is to put the Raspberry Pi OS onto a MicroSD card. You will need
2121

2222
#### Setup for headless boot
2323

24-
After the OS has been written to MicroSD card, we need to change a few files so that the Pi can get on Wifi and also allow for SSH connections. See the [guide](https://desertbot.io/blog/headless-raspberry-pi-4-ssh-wifi-setup) for how to do it using Windows.
24+
After the OS has been written to MicroSD card, we need to change a few files so that the Pi can get on Wifi and also allow for SSH connections. See the [guide](https://www.tomshardware.com/reviews/raspberry-pi-headless-setup-how-to,6028.html) for how to do it using Windows.
2525

2626
- **On a Mac** `touch /Volumes/boot/ssh`
2727
- Next, add the WiFi info
@@ -66,13 +66,13 @@ deb https://www.deb-multimedia.org bookworm main non-free
6666
```
6767
- Download the keys for the apt source and install them:
6868
```bash
69-
wget https://www.deb-multimedia.org/pool/main/d/deb-multimedia-keyring/deb-multimedia-keyring_2016.8.1_all.deb
70-
sudo dpkg -i deb-multimedia-keyring_2016.8.1_all.deb
69+
wget https://www.deb-multimedia.org/pool/main/d/deb-multimedia-keyring/deb-multimedia-keyring_2024.9.1_all.deb
70+
sudo dpkg -i deb-multimedia-keyring_2024.9.1_all.deb
7171
```
7272
- You can verify the package integrity with:
7373
```bash
74-
sha256sum deb-multimedia-keyring_2016.8.1_all.deb
75-
9faa6f6cba80aeb69c9bac139b74a3d61596d4486e2458c2c65efe9e21ff3c7d deb-multimedia-keyring_2016.8.1_all.deb
74+
sha256sum deb-multimedia-keyring_2024.9.1_all.deb
75+
8dc6cbb266c701cfe58bd1d2eb9fe2245a1d6341c7110cfbfe3a5a975dcf97ca deb-multimedia-keyring_2024.9.1_all.deb
7676
```
7777
- Update the OS:
7878
```
@@ -142,7 +142,7 @@ In order to keep your copy of the Trunk Recorder source code free of build artif
142142
```bash
143143
cd ~
144144
mkdir trunk-build
145-
git clone https://github.com/robotastic/trunk-recorder.git
145+
git clone https://github.com/TrunkRecorder/trunk-recorder.git
146146
cd trunk-build
147147
cmake ../trunk-recorder
148148
make -j1
@@ -191,7 +191,7 @@ Assuming you are in the desired directory to place both trunk-recorder and trunk
191191
```bash
192192
cd ~
193193
mkdir trunk-build
194-
git clone https://github.com/robotastic/trunk-recorder.git
194+
git clone https://github.com/TrunkRecorder/trunk-recorder.git
195195
cd trunk-build
196196
cmake ../trunk-recorder
197197
make -j `nproc`
@@ -210,7 +210,7 @@ The next step is to [configure Trunk Recorder](CONFIGURE.md) for the system you
210210

211211
## Running trunk recorder.
212212

213-
If all goes well you should now have the executable named `trunk-recorder`, and created the `config.json` configuration file as described in the [Wiki](https://github.com/robotastic/trunk-recorder/wiki/Configuring-a-System) and [README](https://github.com/robotastic/trunk-recorder/blob/master/README.md#configure).
213+
If all goes well you should now have the executable named `trunk-recorder`, and created the `config.json` configuration file as described in the [Wiki](https://github.com/TrunkRecorder/trunk-recorder/wiki/Configuring-a-System) and [README](https://github.com/TrunkRecorder/trunk-recorder/blob/master/README.md#configure).
214214

215215
From your build directory (e.g. `trunk-build`) you can now run
216216
`./trunk-recorder`

0 commit comments

Comments
 (0)