Work in progress on version 0.2.0 user manual.

denny
2016-02-06 11:53:03 -05:00
parent 6572dc599b
commit d753455aaf
180 changed files with 1800 additions and 2 deletions

11
.project Normal file

@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>sdrtrunk.wiki</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
</buildSpec>
<natures>
</natures>
</projectDescription>

@@ -1,6 +1,8 @@
#SDRTrunk#
SDRTrunk is a java based application for decoding and trunk tracking multiple analog and digital radio channels across multiple USB dongle tuners and/or sound card inputs from scanner radios.
SDRTrunk is a java application for decoding and trunk tracking multiple analog
and digital radio channels across multiple USB dongle tuners and/or sound card
inputs from scanner radios.
* [Getting Started](GettingStarted)
* [User's Manual](UserManual)

51
HomeOriginal.md Normal file

@@ -0,0 +1,51 @@
#SDRTrunk#
SDRTrunk is a java application for decoding and trunk tracking multiple analog
and digital radio channels across multiple USB dongle tuners and/or sound card
inputs from scanner radios.
* [Getting Started](GettingStarted)
* [User's Manual](UserManual)
* [Download](https://drive.google.com/folderview?id=0B7BHsssXUq8eOHBTNndCczZTd0k&usp=sharing)
* [Support](https://groups.google.com/forum/#!forum/sdrtrunk)
This application uses some of the fantastic components available from JIDE Software.
**Operating Systems**
* [Linux](SetupLinux)
* [Windows](SetupWindows)
* Any operating system supported by Java and libusb, however other systems have not yet been tested
**Requirements**
* [Java](http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html) 7 or newer
**Supported Tuners**
* [Funcube Dongle Pro](FuncubeDonglePro)
* [Funcube Dongle Pro Plus](FuncubeDongleProPlus)
* [HackRF](HackRF)
* [RTL-2832 with E4000 Tuner](E4000)
* [RTL-2832 with R820T Tuner](R820T)
* [Sound card(s) connected to scanner audio output](SoundCard)
**Decoders**
* [APCO-25 Phase 1](P25Phase1) - C4FM and CQPSK/LSM
* [Fleetsync II](Fleetsync2)
* [LJ-1200](LJ1200)
* [LTR](LTR)
* [LTR-Net](LTRNet)
* [MDC-1200](MDC1200)
* [MPT-1327](MPT1327)
* [Passport](Passport)
* [Tait CCDI 1200](Tait1200) ANI/GPS
Note: nomitive use of protocol names are for identification. Registered trademarks are the property of their respective owners.
**Source Code**
Source code is available on this website
* [Downloading and Compiling sdrtrunk](Building)

@@ -1,6 +1,23 @@
# APCO-25 Decoder #
The APCO-25 decoder will decoder P-25 phase I signals that are using either
The P25 decoder processes all voice, trunking, and data messages and provides
traffic/voice/data call following when a tuner is available that can monitor
both the control channel and any traffic channels within the available bandwidth
of the tuner, or across multiple tuners.
## P-25 Phase I##
Supports FDMA Common Air Interface (CAI) C4FM modulation and Linear Simulcast
Modulation (LSM).
## P-25 Phase II##
Phase II TDMA decoding is not currently supported.
## P-25 Hybrid (Phase I/II)##
P25 hybrid systems use both Phase 1 control channels and Phase I and Phase II
traffic channels, providing transition support for users with a combination of
Phase I and Phase II radios.
sdrtrunk supports decoding some Phase II support mSupports decoding of FDMA control chaThe APCO-25 decoder will decode P-25 phase I signals that are using either
C4FM modulation or LSM Simulcast (CQPSK) modulation. It will process trunked,
conventional and packet data messages.

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 58 KiB

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 48 KiB

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 62 KiB

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

Before

Width:  |  Height:  |  Size: 186 KiB

After

Width:  |  Height:  |  Size: 186 KiB

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 57 KiB

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Before

Width:  |  Height:  |  Size: 240 KiB

After

Width:  |  Height:  |  Size: 240 KiB

Before

Width:  |  Height:  |  Size: 198 KiB

After

Width:  |  Height:  |  Size: 198 KiB

Before

Width:  |  Height:  |  Size: 148 KiB

After

Width:  |  Height:  |  Size: 148 KiB

Before

Width:  |  Height:  |  Size: 148 KiB

After

Width:  |  Height:  |  Size: 148 KiB

Before

Width:  |  Height:  |  Size: 287 KiB

After

Width:  |  Height:  |  Size: 287 KiB

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Before

Width:  |  Height:  |  Size: 436 KiB

After

Width:  |  Height:  |  Size: 436 KiB

8
v0.2.0/AM.md Normal file

@@ -0,0 +1,8 @@
# AM Decoder #
The AM decoder is a simple AM demodulator for monitoring air band and other
amplitude modulated signals.
## Squelch Control ##
The AM decoder doesn't provide any audio squelch control.

81
v0.2.0/APCO25.md Normal file

@@ -0,0 +1,81 @@
# APCO-25 Decoder #
The P25 decoder processes all voice, trunking, and data messages and provides
traffic/voice/data call following when a tuner is available that can monitor
both the control channel and any traffic channels within the available bandwidth
of the tuner, or across multiple tuners.
## P-25 Phase I##
Decodes FDMA Common Air Interface (CAI) C4FM modulation and Linear Simulcast
Modulation (LSM).
## P-25 Phase II##
Phase II TDMA decoding is not currently supported.
## P-25 Hybrid (Phase I/II)##
P25 hybrid systems use both Phase 1 control channels and Phase I and Phase II
traffic channels, providing transition support for users with a combination of
Phase I and Phase II radios.
TDMA configuration messages that are broadcast on Phase I control channels are
decoded. Currently these include the TDMA timing synchronization and TDMA
channel identifier messages.
## Audio Vocoders ##
### IMBE ###
APCO-25 Phase I audio calls use the multi-band excitation model vocoder to
compress the digitized audio. SDRTrunk supports the JMBE library for decoding
audio, but DOES NOT include the jmbe library in the normal application download.
You must download and compile the library and place the jmbe-x.x.x.jar file in
the same directory from where you launch the sdrtrunk application. On startup,
sdrtrunk will attempt to discover the library and can then decode imbe audio.
[JMBE library](https://github.com/DSheirer/jmbe)
[How To Setup JMBE](JMBE)
### VSELP ###
SDRTrunk recognizes VSELP audio CODEC messages and will display them in the
messages tab during decoding. However, it will not decode the audio.
## Traffic Channel Following ##
The P25 decoder provides full traffic channel following when monitoring a P25
control channel. You can optionally select to not follow data calls in the
decoder configuration when setting up the channel for decoding.
## Talkgroups and Addresses ##
All talkgroups and radio addresses are listed in hexadecimal (base-16) notation
and use the digits 0 - 9 and the letters A - F. Talkgroups are four characters
in length and radio addresses are six characters in length.
Packet data IP Version 4 addresses will normally show in the from column of the
events window and the Logical Link ID (radio address) will show in the from
column with the radio's IP Version 4 address listed in the details column. If
the data contains UDP over IP protocol, the UDP source and destination ports
will be appended to the IP address.
## Aliases ##
You can create an Alias List and attach it to your P25 decoder in the channel
configuration window.
When aliasing talkgroups and radio addresses, ensure you include the full 4 or 6
character talkgroup or address with leading zeros.
## Modulation ##
Choose either C4FM or LSM Simulcast (CQPSK) modulation in the channel configuration
decoder tab. When you select the P25 Decoder from the drop-down list, the
modulation selector list will appear.
## P25 Decoding Example ##
The following screenshot shows the application configured to decode one P25
control channel. It also shows 3 traffic channels being decoded where the
call event was decoded on the control channel and sdrtrunk automatically
created the 3 decoder channels to follow the calls.
![](images/P25Decoder.png)

13
v0.2.0/ActivitySummary.md Normal file

@@ -0,0 +1,13 @@
# Activity Summary #
The activity summary window displays a summary of information about network, frequency, call and user activity received. The format of the activity summary is different for each decoder.
If you are using [auxiliary decoders](AuxiliaryDecoder), then the activity summary for each of those auxiliary decoders is included at the end of the primary decoder activity summary.
## Accessing Activity Summary ##
The activity summary window can be accessed from any of the channel context menus
* **[Configuration](Configuration)** - right-click on a currently decoding channel in the configuration tree
* **[Decoding Channels](DecodingChannels)** - right-click on a channel
* **[Spectral Display](SpectralDisplay)** - right click on a currently decoding channel overlay

62
v0.2.0/Airspy.md Normal file

@@ -0,0 +1,62 @@
# Airspy #
## Tuner Configurations ##
SDRTrunk allows you to define multiple named tuner configurations per tuner
type. A **Default** configuration is automatically created the first time you
use each specific tuner type and will be recreated again if you accidentally
delete or rename the **Default** configuration.
Each time you plug your USB tuner into a new USB port, it will automatically
use the **Default** tuner configuration. If you select a different named
configuration, SDRTrunk will remember to use that named configuration each time
you use the USB tuner in that specific USB port. If you create a named
configuration for your tuner and subsequently move the tuner to a different
USB port, simply select that named configuration from the drop-down list and it
will store that port to named configuration setting.
All changes to a named configuration are automatically saved.
## Configuration ##
* **Frequency** - sets the tuned frequency
* **Config Tab** - controls for changing tuner configuration
* **Info Tab** - displays information about the tuner
### Configuration Tab ###
* **Configuration Selection List** - selects a named configuration to use. Automatically applies the corresponding settings to the tuner
* **Name** - tuner configuration name.
* **New** - creates a new named tuner configuration
* **Delete** - deletes the currently listed tuner configuration
### Info Tab ###
The info tab displays information about the tuner:
* **Serial** - serial number of the Airspy tuner.
## Using the Airspy ##
## Updating Firmware ##
The firmware label shown on the Info tab is the GIT revision label that was
tagged against the software release. SDRTrunk does not support
flashing the Airspy with new firmware. Use the Airspy tools to update the
tuner.
## Using Airspy With Linux ##
If you've never setup your airspy for linux, you'll need to add permissions to allow users to access the airspy:
1. Copy the file **\config\52-airspy.rules** from the sdrtrunk application folder to your **\etc\udev\rules.d** folder.
sudo cp 52-airspy.rules \etc\udev\rules.d
2. Set file permissions.
sudo chmod u=rw,g=r,o=r 52-airspy.rules
3. Refresh the udev rules
sudo udevadm control --reload-rules

98
v0.2.0/Alias.md Normal file

@@ -0,0 +1,98 @@
# Alias #
An alias is a user defined label that can be associated with one or more
identifiers produced by the decoders. Each alias can include:
* **Alias Identifier** - (see below) one or more identifiers that you want to be associated with the alias
* [Alias Action](AliasAction) - an action that you want to happen each time the alias is active
* [Non-Recordable](NonRecordable) - indicates that the alias should not be recorded when
AUDIO recording is specified for the decoding channel
* [Call Priority](CallPriority) - specifies audio playback priority for this alias or allows
you to designate an alias as 'DO NOT MONITOR'
![](images/Alias.png)
## Creating an Alias ##
Right-click on the Alias Group folder and select **New Alias**.
## Deleting an Alias ##
Right-click on the Alias and select **Delete**
## Configuring an Alias ##
* **Name** - display name for the alias
* **Map Color** - for decoders that produce (GPS) locations where the entity can be plotted on the map, designates the color of the label and history trail used for that entity
* **Map Icon** - picture to display with the alias
* **[Icon Manager](IconManager)** - tool for managing and importing new pictures to use with Aliases.
* **Save** - saves any changes to the alias
* **Reset** - resets the alias with the last saved values
## Alias Identifiers ##
Each message and event produced by the decoders contains user and system
identifiers that can be aliased. One or more of these decoded identifiers can
be assigned to an alias.
### Alias Identifier Wildcards ###
Each of the alias identifiers (except LTR-Net unique ID and Status) allow you to
specify a single character wildcard (asterisk) or a full java regular expression
to use when matching identifiers.
Examples:
```
0-**-123 LTR talkgroup 123 on any LCN
ABCD12** Any electronic serial numbers beginning with ABCD12
(?!FA-40|FA-41|FA-42).* Any lojack site ID except for FA-40, FA-41, or FA-42 (use '|' to separate each site identifier)
```
### Create an Alias Identifier ###
Right-click on the Alias folder and in the ADD ID menu, select the type of alias
identifer you want to associate with the Alias.
### Delete an Alias Identifier ###
Right-click on the Alias identifier and select **Delete**.
## Alias Identifier Types ##
* **ESN** - electronic serial number.
![](images/AliasESNID.png)
* **Fleetsync** - fleetsync identifier.
![](images/AliasFleetsyncID.png)
* **LoJack** - lojack tower or transponder and related functions.
* **MDC-1200** - MDC-1200 identifier.
![](images/AliasMDC1200ID.png)
* **MIN** - passport radio Mobile ID Number (MIN).
![](images/AliasMIDID.png)
* **MPT-1327** - MPT-1327 user or group identifier.
![](images/AliasMPT1327ID.png)
* **Site** - site number.
![](images/AliasSiteID.png)
* **Status** - status numeric value produced by decoders like P25 or FLEETSYNC
* **Talkgroup** - used with P25, LTR and Passport talkgroups. **TGID**
identifies the formatted talkgroup.
![](images/AliasTalkgroupID.png)
* **Unique ID** - LTR-Net mobile radio unique ID (UID).
![](images/AliasUniqueID.png)

48
v0.2.0/AliasAction.md Normal file

@@ -0,0 +1,48 @@
# Alias Action #
You can assign one or more alias actions to an alias that will be executed when the alias becomes active in a decoded message. Each message type can produce one or more aliases against any of the identifiers in the message that can be associated with an alias.
## Interval ##
Interval defines when and how often the action will occur.
**Once** - the action will only occur once when the alias is first active for the duration that sdrtrunk is running.
**Once, Reset After Delay** - the action will occur when the alias is first active, but will suppress any further actions for a specified number of seconds. Once the delay period has elapsed, this action will again alert in the future if the alias is active.
**Until Dismissed** - the action will occur when the alias is first noted active and will continue to occur every specified number of seconds. A dialog window with an OK button will pop up and the action will repeat until the user clicks the OK button. The action will reset 15 seconds after the OK button is pressed and will alert again in the future if the alias is active.
## Period ##
Specifies the time period in seconds for the two interval options that require a time period setting.
# Available Alias Actions #
![](images/AliasActions.png)
## Audio Clip ##
Plays the audio clip specified by the file name. The audio clip action provides a file selection button and a test button to allow you to play the selected audio file to ensure that the file is a supported audio type.
## Beep ##
Beeps the computer
## Script ##
The script action allows you to select a script, batch file, or program to execute when the action occurs. Select the program from the File button and use the Test button to test the script to ensure that the script operates correctly.
![](images/ScriptAction.png)
# Errors #
If any errors are encountered playing an audio clip or executing a script, a popup window will appear providing details on the error.
# How To Assign An Alias Action #
* Right-click on an alias
* Select the Add Action menu and choose from the list of available actions
* Ensure the newly added alias action is highlighted in the tree
* Configure the interval and period settings
* Optionally select a file and test the action against the file
* Click the Save button at the bottom of the configuration window

13
v0.2.0/AliasGroup.md Normal file

@@ -0,0 +1,13 @@
# Alias Group #
Contains a list of [Aliases](Alias) used by the decoder to assign an alias name to one or more identifiers produced by the decoder. Use alias groups to arrange each set of user aliases into groups on a system.
![](images/AliasGroup.png)
## Creating an Alias Group ##
Right-click on the Alias List folder and select **New Group**.
## Deleting an Alias Group ##
Right-click on the Alias Group and select **Delete**

13
v0.2.0/AliasList.md Normal file

@@ -0,0 +1,13 @@
# Alias List #
Contains a list of [Alias Groups](AliasGroup) and [Aliases](Alias) used by the decoder to assign an alias name to one or more identifiers produced by the decoder.
![](images/AliasList.png)
## Creating an Alias List ##
Right-click on the Alias Lists folder and select **New Alias List**.
## Deleting an Alias List ##
Right-click on the Alias List and select **Delete**

19
v0.2.0/ApplicationLog.md Normal file

@@ -0,0 +1,19 @@
# Application Log #
The application log contains logging information about the application. Note: see [EventLog](EventLog) for details about logging of decoded channel messages.
# Location #
**Windows 7**:
c:\Users\(your username)\sdrtrunk\log\
---
**Linux**:
In your user directory:
~\sdrtrunk\log

@@ -0,0 +1,15 @@
### Application Overview ###
* [Audio Panel](AudioPanel)
* [Channel Spectrum](ChannelSpectrum)
* [Configuration](Configuration)
* [Decoding Channels](DecodingChannels)
* [Editor](Editor)
* [Events](CallEvents)
* [Map](Map)
* [Messages](Messages)
* [Spectral Display](SpectralDisplay)
* [Waterfall Display](WaterfallDisplay)
![](images/Overview.png)

64
v0.2.0/AudioPanel.md Normal file

@@ -0,0 +1,64 @@
# Audio Panel #
The audio panel controls the audio that is played from the decoding channels to
either you computer speakers or headphones. Audio from each decoding channel
is automatically routed to the Audio Manager and the audio manager automatically
routes the highest priority audio to the speakers.
Each audio playback channel is automatically started and stopped depending on
audio availability. Playback channels use an internal buffer to store a
small number of audio frames before automatically starting playback. Therefore,
you may experience a slight delay between seeing a call start in the decoder
window and audio playback starting. Likewise, you may hear audio playing for a
short period after the decoding channel display indicates that the call has
ended.
Audio priority can be specified for each alias that you create. If you want
certain talkgroups or identifiers to have a higher priority for listening, you
can create the alias, assign the talkgroup(s) or identifier(s) and specify a
priority.
If a call is in playback over the speakers and a higher priority call comes in,
the higher priority call will be routed and the existing call audio will be
stopped.
You can override all call priorities defined in the system when you select an
individual decoding channel. Any audio produced from a selected channel is
routed with the highest priority for playback.
## Audio Playback Device ##
The default audio playback device with mono audio is selected by default. You
can change the audio playback device and choose the number of playback channels
by right-clicking on the audio panel and use the AUDIO OUTPUT menu to select a
different audio device.
## Mono Audio Playback ##
You can select mono audio playback to have any playback audio routed to both
speakers.
![](images/mono_audio_panel.png)
## Stereo Audio Playback ##
You can select stereo audio playback so that you have independent LEFT and RIGHT
audio playback over a stereo audio output. Each audio channel will be managed
by the Audio Manager and all audio produced by all decoding channels will be
routed to these two channels on a priority basis.
![](images/stereo_audio_panel.png)
## Mute Button ##
The green speaker icon on the audio panel is the master mute control. Click the
icon to mute the audio and the icon will turn red. Click again, and the audio
will unmute and the icon will turn green again.
![](images/audio_muted.png)
## Channel Menu ##
Right-click on either the MONO channel, or the LEFT or RIGHT channel to access
the context menu for the channel. You can independently mute or change the
audio volume of each channel via this context menu.
## Channel Mute ##
Each channel will show a RED M in the panel when the audio is muted either via
the master mute button, or by the channel mute context menu.

5
v0.2.0/B100.md Normal file

@@ -0,0 +1,5 @@
# Ettus Research B100 with WBX Daughter Card #
Coming soon.
https://www.ettus.com/product/details/UB100D-BDL

28
v0.2.0/Building.md Normal file

@@ -0,0 +1,28 @@
# Downloading and Compiling sdrtrunk #
This page describes several methods for checking out the source code from the SVN server and building the sdrtrunk application on your local computer.
## Eclipse IDE ##
If you use the [Eclipse IDE for Java](http://www.eclipse.org/downloads/), you can download and import the sdrtrunk project directly into Eclipse.
1. Install an eclipse svn plugin ( Help > Install New Software, choose the Luna site, Collaboration > Subversive SVN )
1. Project Explorer > Import > SVN > Project from SVN
1. Create a new repository location: https://sdrtrunk.googlecode.com/svn
> or http://sdrtrunk.googlecode.com/svn/trunk/
1. Open the ant view ( Window > Show View > Ant )
1. Drag the ant build script from the Package Explorer (sdrtrunk/build/build.xml) into the ant view panel
1. Click the play button to execute the default build target
1. Compiled software package is placed in the sdrtrunk/product/xxx.zip folder
## Manually ##
1. Install the Java JDK version 1.7 or higher and create a JAVA\_HOME environment variable pointing to the JDK installation folder
1. Install an SVN client on your computer: [Tortoise SVN](http://tortoisesvn.net/downloads.html) on windows or kdesvn on Linux
1. Checkout the source code from https://sdrtrunk.googlecode.com/svn
> or http://sdrtrunk.googlecode.com/svn/trunk/
1. Install the latest version of [Ant](http://ant.apache.org/) and follow the installation instructions in the [manual](http://ant.apache.org/manual/index.html)
1. Change to the sdrtrunk build directory ( sdrtrunk/build )
1. Execute the ant command.
Ant will look for a file named build.xml in the current folder and will run the the default build target. The compiled and zipped output program file will be located in the sdrtrunk/product/xxx.zip folder.

50
v0.2.0/CallEvents.md Normal file

@@ -0,0 +1,50 @@
# Call Events #
The **Events** window displays a history of the radio calls and network messages
that have been decoded for each channel. Select each channel individually in
the [decoding channels](DecodingChannels) window to display the call event
history for that channel.
![](images/CallEvents.png)
## Call Event Table Details ##
* **Time** - time that the event occurred
* **Event** - call event description
* **From** - identifier of the radio that initiated the call
* **From Alias** - alias label of the from entity
* **To** - identifier of the radio or talkgroup receiving the call
* **To Alias** - alias label of the to entity
* **Channel** - channel number for the event
* **Frequency** - frequency of the channel number
* **Details** - minimal additional details for the call event
## Call Event Types ##
* **Acknowledge** - acknowledgement from a radio
* **ANI** - automatic number identification for a radio
* **Announcement** - announcement transmitted on a control channel
* **Call** - call event
* **Call Alert** - a mobile radio is alerted about a pending call
* **Call Detect** - a call detected on another channel
* **Call-Do Not Monitor** - a call where either the TO or FROM identifier's
alias has a call priority with the 'Do Not Monitor' box checked
* **Command** - the network is commanding a mobile radio to do something
* **Data Call** - a data call event
* **Deregister** - a mobile radio is deregistering from the network
* **Emergency** - emergency notification from a radio
* **Encrypted Call** - a call using encryption
* **ESN** - radio registering on the network with an ESN, or responding to an ESN interrogation
* **Function** - a function transmitted by the network to the mobile radio
* **GPS** - gps location broadcast from a mobile radio
* **Group Call** - a group call event
* **Page** - the system is paging a radio
* **Query** - the network is querying the status of a mobile radio
* **Register** - radio registering on the network
* **Response** - the network is responding to a mobile radio
* **SDM** - short data message
* **Station ID** - network callsign (FCC ID)
* **Status** - status message
* **Telephone Interconnect** - a landline call to or from a mobile radio
* **Unit To Unit Call** - mobile radio to mobile radio call
* **Unique ID** - LTR-Net unique identifier for a radio registration

18
v0.2.0/CallPriority.md Normal file

@@ -0,0 +1,18 @@
# Call Priority #
Any alias can be assigned a call monitoring priority. Priority values range
from 1 to 100, with 1 being the highest priority and 100 being the lowest.
Audio playback will use any call priority that you have specified and will
automatically override lower priority calls with higher priority calls when they
occur.
You can designate an alias as 'DO NOT MONITOR' and any audio calls where that
alias is a participant will not be routed for audio playback.
Note: if you select a decoding channel, any audio from that channel will have
the highest priority and will override any settings that you have defined.
Selected audio has an effective priority of 0 so it will be higher priority than
your priority 1 alias calls.
![](images/call_priority.png)

67
v0.2.0/Channel.md Normal file

@@ -0,0 +1,67 @@
# Channel #
A channel defines all of the configuration details needed for to setup a radio channel for decoding. When a [Channel](Channel) is actively decoding, the system icon is colored Green. If there is no source available, the channel icon turns red.
![](images/Channel.png)
## Creating a New Channel ##
Right-click on a [Site](Site) folder and select 'New Channel'.
## Deleting a Channel ##
Right-click on the [Channel](Channel) and select 'Delete'
## Starting/Stopping Channel Decoding ##
Use the Enabled check box in the channel configuration to turn decoding on or off. Once you save the configuration, the channel will automatically start decoding, if enabled.
**Quick Start** - right-click on the channel in the configuration window, or right-click on the channel in the spectral display and selected 'Enable' or 'Disable' to turn the decoder on or off with one click.
## Channel Configuration ##
* **Enabled** - turns the channel on/off for decoding.
* **Name** - name for the channel
* **Aliases** - assigns an AliasList to the channel so that any identifiers produced by the decoder can have an [Alias](Alias) value.
* **Source Tab** - designates the source for raw sampled data to feed the decoder
* **Decoder Tab** - designates the primary decoder to use for this channel
* **Aux Tab** - identifies additional auxiliary decoders to use in addition to the primary decoder
* **Event Log Tab** - logging options for decoded events
* **Record Tab** - recording options
### Source Tab ###
The source tab allows you to specify the source for raw sampled data to feed the primary and auxiliary decoders.
* **No Source** - this is the default source when a new channel is created. You cannot decode a channel with this source.
* **Mixer/Sound Card** - allows you to use an external radio scanner with the audio output or discriminator tapped audio from the scanner patched to a sound card input on the computer. Select the Mixer (Sound Card) and Channel for the sound card where you have the scanner audio patched.
* **Tuner** - allows you to specify a radio frequency as the source for raw samples. You must have a [Tuner](Tuner) attached to your computer and it must appear in the list of [Tuners](Tuners) in the SDRTrunk [Configuration](Configuration) window. If no tuners are attached, or if none of the attached tuners can tune the requested frequency, the channel will indicated 'No Tuner' when you enable it.
### Decoder Tab ###
The decoder tab provides a list of available primary [decoders](Decoder) to select for the channel. Only one primary decoder can be selected per channel. If you want to run multiple primary decoders, create additional channels, each with a different primary decoder.
* [LTR-Standard](LTR) - FM demodulator and Logic Trunked Radio (LTR) trunked radio signaling decoder
* [LTR-Net](LTRNet) - FM demodulator and LTR-Net trunked radio signaling decoder
* [MPT-1327](MPT1327) - FM demodulator and MPT-1327 trunked radio signaling decoder. Provides automatic traffic channel following.
* [NBFM](NBFM) - narrow-band FM demodulator.
* [Passport](Passport) - FM demodulator and Passport trunked radio signaling decoder.
## Aux Tab ##
The aux tab allows you to select from multiple auxiliary decoders to use in addition to the selected primary decoder. Auxiliary decoders are used to decode pass-band audio signals like gps and digital radio identification bursts that are used on some trunked and conventional radio systems.
* [Fleetsync II](Fleetsync2Decoder) - decodes ANI, Acknowledge, Status, Paging and GPS bursts
* [MDC-1200](MDC1200Decoder) - decodes MDC-1200 ANI bursts.**
### Event Log Tab ###
The event log tab allows you to select from multiple textual logging options.
* **Binary Messages** - logs raw binary messages created by the decoder. Each message contains a timestamp, protocol, and a string of binary ones and zeros.
* **Decoded Messages** - logs decoded textual messages created by the decoder.
* **Call Events** - logs all of the call events that can be seen in the [Calls](CallEvents) window.
### Record Tab ###
The record tab provides options for recording of the demodulated/decoded audio and/or the raw I/Q samples from a tuner or complex mixer source.
* **Audio** - records all demodulated audio, uninterrupted and without squelch control in a wave file.
* **Baseband I/Q** - records all raw baseband sample data in a two-channel, 16-bits per sample wave file.

35
v0.2.0/ChannelMap.md Normal file

@@ -0,0 +1,35 @@
# Introduction #
Channel Maps are used by some decoders to specify the channel number to frequency mapping used by a system. Most decoders do not require a channel map. Channel Maps allow the trunking controller to tell a mobile radio to go to a channel number for a radio call, without having to specify the frequency. An accurate channel map is essential for decoders that support traffic channel following, so that SDRTrunk can tune to the correct traffic channel frequency to decode the traffic channel call.
![](images/ChannelMap.png)
## Create a Channel Map ##
Right-click on the Channel Maps folder and selected **New Channel Map**
## Delete a Channel Map ##
Right-click on the Channel Map and select **Delete**
## Channel Ranges ##
A channel map contains one or more channel ranges. A range defines a range of channel numbers, the base frequency, and the channel size. A simple math formula produces the channel frequency by multiplying the channel number by the channel size, and adding that value to the base frequency. A channel map can contain multiple channel ranges to support systems where the channel frequencies are not allocated in a contiguous manner.
### Add a Channel Range ###
Click 'New Range'.
### Delete a Channel Range ###
Highlight the range and click 'Delete'
## Configuring a Channel Map ##
* **Name** - Update the name for your channel map. Once you have finished updating the channel map, you can then select this name in the channel's decoder configuration tab.
* **Range** - update the default channel range in the table with beginning and ending channel numbers, base frequency, and channel size. Use the **New Range** button to add additional channel ranges to the channel map. Use the **Delete** button to delete any channel ranges that aren't needed.
* **Save** - saves the current configuration.
* **Reset** - resets the channel map to the last saved state

27
v0.2.0/ChannelSpectrum.md Normal file

@@ -0,0 +1,27 @@
# Channel Spectrum #
The channel spectrum window allows you to view the dynamic frequency content of
the demodulated audio produced from the currently selected decoding channel.
The demodulated audio is processed with a Discrete Fourier Transform (DFT)
similar to the Spectral Display. This display allows you to hover over each of
the peaks in the audio frequency and a frequency readout is displayed next the
cursor.
You can use the frequency readout to measure spectral content like CTCSS tones
that may be present in the demodulated audio output.
Spectral display processing only occurs when you have a channel selected and
when the spectral display tab is displayed. If you have the spectral display
tab displayed and no channels are selected, the display will be empty.
Note: certain decoders like the P25-LSM decoder do not produce demodulated audio
and will not display audio content in the channel spectrum window. The audio
output from digital voice CODECs is not displayed in this channel spectrum
window.
## Context Menus ##
You can change the color, FFT size, and frame rate of the channel spectrum
window by right-clicking anywhere in the display and choosing from the menu
options.
![](images/channel_spectrum.png)

10
v0.2.0/Configuration.md Normal file

@@ -0,0 +1,10 @@
# Configuration #
The configuration window uses a tree list to provide access to each of the
configurable features and settings in the SDRTrunk application.
* [Tuners](Tuner) - controls each of the tuners available to the application
* [Playlist](Playlist) - allows you to create and edit decoding channels,
channel maps, and alias lists
![](images/Configuration.png)

43
v0.2.0/Decoder.md Normal file

@@ -0,0 +1,43 @@
# Decoders #
Each decoding [channel](Channel) can have one primary decoder and one or more
auxiliary decoders. If you want to run multiple primary decoders on the same
frequency, create separate channels for each primary decoder.
## Primary Decoders ###
* [AM](AM) - AM demodulator
* [LTR-Standard](LTR) - FM demodulator and Logic Trunked Radio (LTR) trunked radio signaling decoder
* [LTR-Net](LTRNet) - FM demodulator and LTR-Net trunked radio signaling decoder
* [MPT-1327](MPT1327) - FM demodulator and MPT-1327 trunked radio signaling decoder and automatic trunked channel following.
* [NBFM](NBFM) - narrow-band FM demodulator.
* [Passport](Passport) - FM demodulator and Passport trunked radio signaling decoder.
* [P-25 Phase 1 C4FM](APCO25) - FM demodulator with P25 message decoder and automatic trunked channel following.
* [P-25 Phase 1 LSM](APCO25) - Quadrature demodulator with P25 message decoder and automatic trunked channel following.
## Auxiliary Decoders ##
Auxiliary decoders are designed to process demodulated audio or in-band
signalling that is normally layered on top of another digital protocol or FM
modulated analog repeater channel. These layered protocols provide services
like Automatic Number Identification (ANI), status messaging, GPS location,
emergency notification, etc. Auxiliary protocols may be transmitted when the
mobile radio user keys the microphone, or in the case of GPS, they can key the
radio and transmit the GPS location without any user actions.
How do auxiliary decoders work? Demodulated audio from a primary decoder that uses
an FM demodulator is simultaneously routed to each of the auxiliary decoders
and the decode results and added to the Events and Messages lists, as well as
displayed in the [decoding channel](DecodingChannels) windows.
Auxiliary decoders are normally used with analog decoders like NBFM, LTR,
LTR-Net, and Passport.
* [Fleetsync II](Fleetsync2Decoder) - decodes ANI, Acknowledge, Status, Paging and GPS bursts
* [LJ1200](LoJackDecoder) - decodes LoJack data bursts on 173.075 MHz in US.
* [MDC-1200](MDC1200Decoder) - decodes MDC-1200 ANI bursts.
* [Tait 1200](TaitDecoder) - decodes Tait CCDI protocol GPS location bursts.
**Note**: there are a wide variety of these auxiliary service protocols that can be
easily added to SDRTrunk. If you encounter a new audio-band protocol, collect
a number of good quality samples and send them to the author via the google
support group for possible inclusion in the sdrtrunk application.

Some files were not shown because too many files have changed in this diff Show More