More wiki edits for v0.2.0 user manual.

denny
2016-02-07 09:21:52 -05:00
parent d753455aaf
commit 643d47b992
18 changed files with 238 additions and 70 deletions

@@ -70,6 +70,32 @@ Choose either C4FM or LSM Simulcast (CQPSK) modulation in the channel configurat
decoder tab. When you select the P25 Decoder from the drop-down list, the
modulation selector list will appear.
## Monitoring a P25 Trunked System ##
Setup a channel to decode the trunked system's control channel only. The decoder
will automatically detect when additional traffic channels are allocated for
calls and will create temporary decoding channels in the application to process
each of these calls.
You do NOT need to create decoding channel configurations for each of the
traffic channel frequencies used by the system because the control channel will
tell the sdrtrunk application every thing that it needs to know in order to
setup a temporary decoding channel.
### Traffic Channel Pool ###
When configuring the P25 control channel decode configuration, use the Traffic
Channel Pool setting to set the maximum number of temporary traffic channels
that can be running at the same time. The sdrtrunk application will create
channel configurations up to this maximum number and reuse the channel
configurations for subsequent calls.
The default value of 4 traffic channels in the pool is suitable for a modern
powerful processor. You may have to reduce this pool size if you are using a
lower powered CPU. Monitor the computer's CPU and memory consumption and adjust
this value as needed. Note: you'll have to stop and restart the decoding after
you change the traffic channel pool size value and save it.
## P25 Decoding Example ##
The following screenshot shows the application configured to decode one P25

@@ -1,13 +1,17 @@
# 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.
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.
If you are using [auxiliary decoders](AuxiliaryDecoder), 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
* [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

@@ -31,13 +31,27 @@ All changes to a named configuration are automatically saved.
* **New** - creates a new named tuner configuration
* **Delete** - deletes the currently listed tuner configuration
* **Sample Rate** - select from 10.00 or 2.50 MHz sample rates. Note: the
additional decimation option is not currently supported in sdrtrunk.
* **Gain Mode** - select from LINEARITY, SENSITIVITY, or CUSTOM. Linearity
and sensitivity modes provide a single gain adjustment value that automatically
configures the IF, Mixer and LNA gains for each master gain setting. The
Custom mode disables the single gain adjustment slider and provides access to
each of the IF, Mixer and LNA gain sliders so that you can manually adjust
each gain value to meet your specific needs.
### Info Tab ###
The info tab displays information about the tuner:
* **Serial** - serial number of the Airspy tuner.
* **Firmware** - version number of the firmware loaded in the airspy
* **Part** - airspy part number
* **Board ID** - airspy board identifier
## Using the Airspy ##
![](images/airspy.png)
## Updating Firmware ##
The firmware label shown on the Info tab is the GIT revision label that was
@@ -49,14 +63,14 @@ tuner.
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.
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.
Set file permissions.
sudo chmod u=rw,g=r,o=r 52-airspy.rules
3. Refresh the udev rules
Refresh the udev rules
sudo udevadm control --reload-rules

@@ -1,28 +1,27 @@
# 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.
The sdrtrunk source code is hosted on github.com and the repository can be
downloaded as a compressed archive or cloned using GIT.
[sdrtrunk repository on github](https://github.com/DSheirer/sdrtrunk)
## 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
If you use the [Eclipse IDE for Java](http://www.eclipse.org/downloads/), you
can clone the github source code repository and import the sdrtrunk project
directly into Eclipse using either the EGit or JGit plugins.
## 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. Install the Java JDK version 1.7 or higher and create a JAVA\_HOME
environment variable pointing to the JDK installation folder
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. Click the 'Download Zip' button to download the source code from
https://github.com/DSheirer/sdrtrunk and unzip the code
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.
Ant will look for a file named build.xml in the current folder and will run the
default build target. The compiled and zipped output program file will be
located in the sdrtrunk/product/xxx.zip folder.

@@ -1,8 +1,9 @@
# 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.
Each decoding [channel](Channel) requires one primary decoder and can optionally
have zero or more auxiliary decoders running at the same time. If you want to
run multiple primary decoders on the same frequency, create separate channels
for each primary decoder.
## Primary Decoders ###
@@ -17,27 +18,27 @@ frequency, create separate channels for each primary decoder.
## 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
signaling 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
How do auxiliary decoders work? Demodulated audio from a primary decoder's FM
demodulator is simultaneously routed to each of the auxiliary decoders
and the decode results are 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.
* [Fleetsync II](Fleetsync2) - decodes ANI, Acknowledge, Status, Paging and GPS bursts
* [LJ1200](LoJack) - decodes LoJack data bursts on 173.075 MHz in US.
* [MDC-1200](MDC1200) - decodes MDC-1200 ANI bursts.
* [Tait 1200](Tait1200) - 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.
a number of good quality sample recordings and contact the author via the
google support group for possible inclusion in the sdrtrunk application.

@@ -22,7 +22,7 @@ the channel information and the current state of the channel.
![](images/channel_state.png)
* **Decoder** - name of the primary decoder and related display fields that are unique to each decoder
* **Decoder** - primary and auxiliary decoders and related display fields that are specific to each decoder
* **Frequency** - frequency for the channel or audio input source name
* **Logging & Recording** - indicates logging (LOG) and recording (AUDIO/BASEBAND) options are enabled for this channel
* **Name** - name of the channel

@@ -2,10 +2,6 @@
Fleetsync is a digital radio identifier, status, GPS, and data protocol that is normally used in addition to other trunked radio protocols and/or on conventional radio channels. The decoder decodes Automatic Number Identification (ANI), Acknowledgements, Status and GPS messages. If you discover additional message types, please share them with the author for inclusion in the decoder.
## Using Fleetsync Decoder ##
Select the Fleetsync decoder in the **Aux** tab of the channel configuration window. If you are decoding a conventional channel, then use the [NBFM](NBFM) decoder as the primary decoder. The Fleetsync auxiliary decoder can be used in addition to any of the primary analog trunked radio decoders.
## GPS ##
GPS data bursts normally occur on a conventional radio channel, separate from normal voice communications. Each mobile radio has a unique timestamp that tells it when to broadcast, so that users don't broadcast on top of each other. In addition to the defined time to transmit, radios are told how often to broadcast. Broadcast updates of 1, 3, 5 and 6 minute intervals have been observed.
@@ -26,4 +22,14 @@ Add the following aliases to each alias list you are using for Fleetsync:
* 099-0999 Broadcast Call
* `*``*``*`-0999 Fleet Call
* 099-`*``*``*``*` Supervisor Call
* 099-`*``*``*``*` Supervisor Call
## Decoder Setup - Conventional or Repeater Network ##
Setup a decoding channel with a NBFM decoder and select MDC1200 in the aux
decoder configuration tab.
## Decoder Setup - Analog Trunked Network ##
Setup a decoding channel with one of the analog trunked radio decoders (LTR,
LTRNet, Passport, etc) and select MDC1200 in the aux decoder configuration tab.

@@ -1,37 +1,83 @@
## Getting started with SDRTRunk ##
## Getting started with SDRTrunk ##
SDRtrunk is an integrated application for demodulating radio signals and
decoding trunked radio network and some related radio signal formats. The
application does NOT require a discriminator tapped scanner and it does NOT
require the use of audio piping applications like Virtual Audio Cable. All
connections between the tuner or sound card and the decoders is provided by the
sdrtrunk application.
SDRTrunk uses channel configurations to setup a demodulation and decoder
processing sequence. In order to successfully decode radio signals, each
channel configuration requires:
* **Source** - specifies where to get the radio samples from (tuner or sound card)
* **Decoder** - which demodulator or decoder to use in processing the source samples
Each channel configuration allows you to optionally configure:
* **Aux Decoder** - additional in-band audio protocols
* **Logging** - log decoded messages or events
* **Recording** - record audio calls or digitized baseband samples
The SDRTrunk application is programmed in Java and can run on any computer where
the there is Java available for the operating system and the computer hardware
(processor/memory) is sufficient for the processing workload.
### Setup ###
* [Linux](SetupLinux)
* [Windows](SetupWindows)
![](images/Overview.png)
### Application Overview ###
[Application Overview](ApplicationOverview)
The [application overview](ApplicationOverview) article describes the various
components in the sdrtrunk application
### Quick Start - SDR Dongle ###
### Configuration ###
1. Select a tuner to display in the spectral display
The configuration window/tab at the center of the application is the central
control for configuring tuners and creating/managing channel configurations,
aliases and channel maps.
2. Tune to a frequency near the channel that you want to decode. Do not tune
the channel into the center of the display. Adjust the frequency so that the
channel is either to the left or to the right of the center of the display.
Channels are organized by [System](System) and [Site](Site). The system and
site labels can be anything that you want to name them and allow you to setup
your configurations to mirror actual radio network configurations.
3. Right-click on the frequency in the spectral display, choose **Add Decoder**
select the type of decoder that you want to use.
### Setup a Channel for Decoding ###
4. If a tuner is available, the channel will immediately start decoding with
default settings. Select the channel in the **Decoding Channels** window to see
call events and decoded messages.
In the Configuration tab at the center of the application window:
### Quick Start - Sound Card / Scanner Audio ###
1. Click on the 'Tuners' tree branch and verify that the application recognized one or more [tuners](Tuner).
1. Right-click on 'Systems' tree branch and create a system - type a system name and click 'Save' in the editor.
1. Right-click on the system tree branch that you created and add a Site - type a site name and click 'Save' in the editor.
1. Right-click on the site tree branch that you created and add a Channel.
1. Type in the channel name.
1. In the Source tab, select Tuner from the Source drop-down menu and type in the frequency that you want to monitor
1. In the Decoder tab, select a decoder. The default options can be changed, but should be sufficient for a quick start.
1. Click 'enabled' so that channel decoding starts when you hit save.
1. Click the save button.
1. Create a new [channel](Channel)
If everything is configured correctly and the application can use the tuner to
tune to the frequency that you entered, you should see a [channel](DecodingChannel)
display appear in the lower-left corner of the application that will show the
status of the decoding process.
2. In the channel editor select the correct **Mixer** and **Channel** in the source tab, corresponding to where you have patched your scanner audio into the computer.
Click on this [channel](DecodingChannel) to select it. Then, click on the
[Messages](Messages) tab or the [Events](CallEvents) tab to see the decoding
results.
3. Select **Enabled**
### Alternate Quick Start - SDR Dongle ###
4. Hit **Save**.
5. Select the channel in the [decoding channels](DecodingChannels) window to hear the pass-through audio.
1. In the Configuration tab, select a tuner to display in the spectral display
by right-clicking on the tuner tree branch and select 'Show in Main Spectrum'.
1. Left-click the tuner and in the [editor](Editor) window, tune to a frequency
near the channel that you want to decode. Do not tune the channel into the
center of the display. Adjust the frequency so that the channel is either to
the left or to the right of the center of the display.
1. Right-click on the frequency in the [spectral display](SpectralDisplay) and
choose **Add Decoder** and select the type of decoder that you want to use.
1. If a tuner is available, the channel will immediately start decoding with
default settings and a [channel](DecodingChannels) will appear in the lower-left
window of the application. Left-click the channel display to select the channel
and then click on the Messages or Events tab to see the decoding results.

23
v0.2.0/LoJack.md Normal file

@@ -0,0 +1,23 @@
# LJ1200 Decoder #
LoJack is a vehicle and equipment tracking and recovery service that is available
in a number of cities in the US. The network broadcasts a series of data
messages on 173.075 MHz to transponders installed in each tracked vehicle or
piece of equipment. This decoder processes these network broadcast messages.
## LoJack Alias ID ##
The LoJack alias identifier allows you to specify a function code and tower ID
or transponder ID to associate with an alias.
## ESN Alias ID ##
The ESN ID alias can be used to match a vehicle transponder address.
## Decoder Setup ##
Setup a decoding channel with a NBFM decoder and specify a tuner frequency of
173.075 in the source configuration tab. Select LJ1200 in the aux decoder
configuration tab.

@@ -1,3 +1,22 @@
# MDC-1200 Decoder #
The MDC-1200 decoder is a work in progress. The decoder doesn't provide any error detection or error correction, so some of the decoded messages may not be accurate.
The MDC-1200 decoder processes Automatic Number Identification (ANI) data
bursts that are used in some analog radio networks to identify individual radios
each time they broadcast on the repeater or trunked radio channel.
Note: this decoder doesn't currently provide error detection and correction and
therefore it may produce invalid decoded messages. If you have access to a
radio with MDC1200 capability and can provide quality audio recordings of the
various data bursts, please contact the author via the Google support group.
## Decoder Setup - Conventional or Repeater Network ##
Setup a decoding channel with a NBFM decoder and select MDC1200 in the aux
decoder configuration tab.
## Decoder Setup - Analog Trunked Network ##
Setup a decoding channel with one of the analog trunked radio decoders (LTR,
LTRNet, Passport, etc) and select MDC1200 in the aux decoder configuration tab.

@@ -1,10 +1,17 @@
# Map #
The map displays any decoded messages that contain location data, like GPS positions.
The map displays any decoded messages that contain location data like GPS positions.
The map component uses aliases to determine the display label, icon and color to use when plotting decoded messages. Update messages from the same entity are chained together.
The map component uses [aliases](Alias) to determine the display label, icon
and color to use when plotting decoded messages. Update messages from the same
entity are chained together.
The map uses map tiles from the open street map server. If you do not have an internet connection, no map data will be displayed, however decoded messages will be plotted.
The map uses map tiles from the open street map server. If you do not have an
internet connection, no map data will be displayed, however decoded messages
will be plotted.
## Default Location and Zoom ##
Drag the map to recenter the view and use the mouse wheel to zoom in or out. Right-click on the map to store the location and zoom level as the map default.
Drag the map to re-center the view and use the mouse wheel to zoom in or out.
Right-click on the map to store the location and zoom level as the map default.
![](images/map.png)

@@ -1,3 +1,5 @@
# Messages #
The messages component displays messages as they are decoded by the channel decoder. All messages from the primary decoder and any messages from auxiliary decoders are displayed.
The messages component displays messages as they are decoded by the channel decoder. All messages from the primary decoder and any messages from auxiliary decoders are displayed.
![](images/messages.png)

19
v0.2.0/Tait1200.md Normal file

@@ -0,0 +1,19 @@
# Tait 1200 Decoder #
The Tait 1200 decoder processes audio band GPS location bursts.
Note: the decoder only decodes GPS data bursts. If you have access to a Tait
radio with GPS and can provide additional quality audio recordings of data
bursts from the radio, please contact the author in the Google support group.
## Decoder Setup - Conventional or Repeater Network ##
Setup a decoding channel with a NBFM decoder and select Tait 1200 in the aux
decoder configuration tab.
## Decoder Setup - Analog Trunked Network ##
Setup a decoding channel with one of the analog trunked radio decoders (LTR,
LTRNet, Passport, etc) and select Tait 1200 in the aux decoder configuration tab.

@@ -1,5 +1,7 @@
# SDRTrunk Version 0.2.x User's Manual #
#[Getting Started](GettingStarted)#
#[Application Overview](ApplicationOverview)#
#Aliases#

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

BIN
v0.2.0/images/map.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 287 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB